Add redis command calls metrics

RobiNN1 · RobiNN1 · commit 5c7753c0bae3 · 2026-01-04T22:14:00.000+01:00
diff --git a/README.md b/README.md
@@ -27,7 +27,7 @@
 - View, add, edit, and delete keys. Supports all Redis data types.
 - **Cluster support**.
 - Supports ACL.
-- Detailed server statistics including memory usage, uptime, connected clients, and general info.
+- Detailed server statistics including command calls, memory usage, uptime, connected clients, and general info.
 - View the Redis slowlog to debug performance issues.
 - Supports both SCAN and KEYS commands for retrieving keys.
 
diff --git a/assets/js/scripts.js b/assets/js/scripts.js
@@ -474,6 +474,7 @@ const chart = (instance, options, timestamps) => {
         grid: {left: 10, right: 10, top: 80, bottom: 60}
     });
 };
+
 const time_switcher = (callback) => {
     const time_buttons = document.querySelectorAll('[data-tab]');
 
diff --git a/src/Dashboards/Redis/Compatibility/Cluster/PredisCluster.php b/src/Dashboards/Redis/Compatibility/Cluster/PredisCluster.php
@@ -97,25 +97,26 @@ public function getInfo(?string $option = null, ?array $combine = null): array {
             foreach ($this->getInfoSections() as $section_name) {
                 try {
                     $response = $node->info($section_name);
-
                     $node_section_info = (is_array($response) && $response !== []) ? reset($response) : null;
-                    if (!$node_section_info) {
-                        continue;
-                    }
 
-                    if (!is_array($node_section_info)) {
+                    if (!$node_section_info || !is_array($node_section_info)) {
                         continue;
                     }
 
-                    $section_name_lower = strtolower($section_name);
+                    $section_lower = strtolower($section_name);
 
                     foreach ($node_section_info as $key => $value) {
+                        if ($section_lower === 'commandstats' || $section_lower === 'keyspace') {
+                            $aggregated[$section_lower][$key][] = $value;
+                            continue;
+                        }
+
                         if (is_array($value)) {
                             foreach ($value as $sub_key => $sub_val) {
-                                $aggregated[$section_name_lower][$key][$sub_key][] = $sub_val;
+                                $aggregated[$section_lower][$key][$sub_key][] = $sub_val;
                             }
                         } else {
-                            $aggregated[$section_name_lower][$key][] = $value;
+                            $aggregated[$section_lower][$key][] = $value;
                         }
                     }
                 } catch (Exception) {
@@ -124,21 +125,7 @@ public function getInfo(?string $option = null, ?array $combine = null): array {
             }
         }
 
-        $combined_info = [];
-
-        foreach ($aggregated as $section_name => $section_data) {
-            foreach ($section_data as $key => $values) {
-                if (is_array(reset($values))) {
-                    foreach ($values as $sub_key => $sub_values) {
-                        $combined_info[$section_name][$key][$sub_key] = $this->combineValues($sub_key, $sub_values, $combine);
-                    }
-                } else {
-                    $combined_info[$section_name][$key] = $this->combineValues($key, $values, $combine);
-                }
-            }
-        }
-
-        $info = $combined_info;
+        $info = $this->aggregatedData($aggregated, $combine);
 
         return $option !== null ? ($info[strtolower($option)] ?? []) : $info;
     }
diff --git a/src/Dashboards/Redis/Compatibility/Cluster/RedisCluster.php b/src/Dashboards/Redis/Compatibility/Cluster/RedisCluster.php
@@ -88,7 +88,7 @@ public function getInfo(?string $option = null, ?array $combine = null): array {
             return $option !== null ? ($info[strtolower($option)] ?? []) : $info;
         }
 
-        $aggregated_data = [];
+        $aggregated = [];
 
         foreach ($this->nodes as $node) {
             foreach ($this->getInfoSections() as $section_name) {
@@ -99,13 +99,20 @@ public function getInfo(?string $option = null, ?array $combine = null): array {
                         continue;
                     }
 
+                    $section_lower = strtolower($section_name);
+
                     foreach ($node_section_info as $key => $value) {
+                        if ($section_lower === 'commandstats' || $section_lower === 'keyspace') {
+                            $aggregated[$section_lower][$key][] = $value;
+                            continue;
+                        }
+
                         if (is_array($value)) {
                             foreach ($value as $sub_key => $sub_val) {
-                                $aggregated_data[strtolower($section_name)][$key][$sub_key][] = $sub_val;
+                                $aggregated[$section_lower][$key][$sub_key][] = $sub_val;
                             }
                         } else {
-                            $aggregated_data[strtolower($section_name)][$key][] = $value;
+                            $aggregated[$section_lower][$key][] = $value;
                         }
                     }
                 } catch (RedisClusterException) {
@@ -114,25 +121,7 @@ public function getInfo(?string $option = null, ?array $combine = null): array {
             }
         }
 
-        $combined_info = [];
-
-        foreach ($aggregated_data as $section_name => $section_data) {
-            $combined_section = [];
-
-            foreach ($section_data as $key => $values) {
-                if (is_array(reset($values))) {
-                    foreach ($values as $sub_key => $sub_values) {
-                        $combined_section[$key][$sub_key] = $this->combineValues((string) $sub_key, $sub_values, $combine);
-                    }
-                } else {
-                    $combined_section[$key] = $this->combineValues($key, $values, $combine);
-                }
-            }
-
-            $combined_info[$section_name] = $combined_section;
-        }
-
-        $info = $combined_info;
+        $info = $this->aggregatedData($aggregated, $combine);
 
         return $option !== null ? ($info[strtolower($option)] ?? []) : $info;
     }
diff --git a/src/Dashboards/Redis/Compatibility/RedisExtra.php b/src/Dashboards/Redis/Compatibility/RedisExtra.php
@@ -25,11 +25,24 @@ public function getInfoSections(): array {
      * @return array<string, array<string, mixed>>
      */
     public function parseSectionData(string $section): array {
-        /** @var array<string, string> $info */
+        /** @var array<string, string|array<int, string>> $info */
         $info = $this->getInfo($section);
 
-        return array_map(static function (string $value): array {
-            parse_str(str_replace(',', '&', $value), $parsed);
+        return array_map(static function ($value): array {
+            // Cluster mode
+            if (is_array($value)) {
+                $aggregated = [];
+                foreach ($value as $node_string) {
+                    parse_str(str_replace(',', '&', (string) $node_string), $parsed);
+                    foreach ($parsed as $k => $v) {
+                        $aggregated[$k] = ($aggregated[$k] ?? 0) + (is_numeric($v) ? $v : 0);
+                    }
+                }
+
+                return $aggregated;
+            }
+
+            parse_str(str_replace(',', '&', (string) $value), $parsed);
 
             return $parsed;
         }, $info);
@@ -87,7 +100,38 @@ public function checkModule(string $module): bool {
     }
 
     /**
-     * Combine info values into a single value in a cluster.
+     * Helper function for cluster mode.
+     *
+     * @param array<string, array<string, mixed>> $aggregated
+     * @param null|list<string>                   $combine
+     *
+     * @return array<string, array<string, mixed>>
+     */
+    private function aggregatedData(array $aggregated, ?array $combine = null): array {
+        $combined_info = [];
+
+        foreach ($aggregated as $section_name => $section_data) {
+            foreach ($section_data as $key => $values) {
+                if ($section_name === 'commandstats' || $section_name === 'keyspace') {
+                    $combined_info[$section_name][$key] = $values;
+                    continue;
+                }
+
+                if (is_array(reset($values))) {
+                    foreach ($values as $sub_key => $sub_values) {
+                        $combined_info[$section_name][$key][$sub_key] = $this->combineValues((string) $sub_key, $sub_values, $combine);
+                    }
+                } else {
+                    $combined_info[$section_name][$key] = $this->combineValues($key, $values, $combine);
+                }
+            }
+        }
+
+        return $combined_info;
+    }
+
+    /**
+     * Helper function for cluster mode.
      *
      * @param list<mixed>       $values
      * @param list<string>|null $combine
diff --git a/src/Dashboards/Redis/RedisMetrics.php b/src/Dashboards/Redis/RedisMetrics.php
@@ -41,15 +41,45 @@ public function __construct(
 
         $schema = <<<SQL
         CREATE TABLE IF NOT EXISTS metrics (
-            id INTEGER PRIMARY KEY AUTOINCREMENT, timestamp INTEGER NOT NULL,
-            commands_per_second INTEGER, hit_rate REAL, memory_used INTEGER, memory_peak INTEGER,
-            fragmentation_ratio REAL, connections INTEGER
+            id INTEGER PRIMARY KEY AUTOINCREMENT, 
+            timestamp INTEGER NOT NULL,
+            commands_per_second INTEGER, 
+            hit_rate REAL, 
+            memory_used INTEGER, 
+            memory_peak INTEGER,
+            fragmentation_ratio REAL, 
+            connections INTEGER,
+            commands_stats TEXT
         )
         SQL;
 
         $this->pdo->exec($schema);
+
+        $this->updateSchema([
+            'commands_stats' => 'TEXT',
+        ]);
+    }
+
+    /**
+     * @param array<string, string> $new_columns
+     */
+    private function updateSchema(array $new_columns): void {
+        try {
+            $statement = $this->pdo->query('PRAGMA table_info(metrics)');
+            $existing_columns = $statement->fetchAll(PDO::FETCH_COLUMN, 1);
+
+            foreach ($new_columns as $column_name => $type) {
+                if (!in_array($column_name, $existing_columns, true)) {
+                    $this->pdo->exec(sprintf('ALTER TABLE metrics ADD COLUMN %s %s', $column_name, $type));
+                }
+            }
+        } catch (\Exception) {
+        }
     }
 
+    /**
+     * @throws JsonException
+     */
     public function collectAndRespond(): string {
         $info = $this->redis->getInfo(null, [
             'used_memory',
@@ -79,13 +109,23 @@ public function collectAndRespond(): string {
     /**
      * @param array<string, mixed> $info
      *
-     * @return array<string, int|float>
+     * @return array<string, int|float|string>
+     *
+     * @throws JsonException
      */
     private function calculateMetrics(array $info): array {
         $keyspace_hits = $info['stats']['keyspace_hits'] ?? 0;
         $keyspace_misses = $info['stats']['keyspace_misses'] ?? 0;
         $total_commands = $keyspace_hits + $keyspace_misses;
 
+        $parsed_commands = $this->redis->parseSectionData('commandstats');
+        $command_calls = [];
+
+        foreach ($parsed_commands as $cmd => $details) {
+            $name = str_replace('cmdstat_', '', $cmd);
+            $command_calls[$name] = (int) ($details['calls'] ?? 0);
+        }
+
         return [
             'timestamp'           => time(),
             'commands_per_second' => $info['stats']['instantaneous_ops_per_sec'] ?? 0,
@@ -94,6 +134,7 @@ private function calculateMetrics(array $info): array {
             'memory_peak'         => $info['memory']['used_memory_peak'] ?? 0,
             'fragmentation_ratio' => $info['memory']['mem_fragmentation_ratio'] ?? 0,
             'connections'         => $info['clients']['connected_clients'] ?? 0,
+            'commands_stats'      => json_encode($command_calls, JSON_THROW_ON_ERROR),
         ];
     }
 
@@ -119,15 +160,15 @@ private function fetchRecentMetrics(): array {
         $stmt->bindValue(':limit', $max_data_points_to_return, PDO::PARAM_INT);
         $stmt->execute();
 
-        $results = $stmt->fetchAll(PDO::FETCH_ASSOC);
-
-        return array_reverse($results);
+        return array_reverse($stmt->fetchAll(PDO::FETCH_ASSOC));
     }
 
     /**
      * @param array<int, array<string, mixed>> $db_rows
      *
      * @return array<int, array<string, mixed>>
+     *
+     * @throws JsonException
      */
     private function formatDataForResponse(array $db_rows): array {
         $formatted_results = [];
@@ -144,6 +185,7 @@ private function formatDataForResponse(array $db_rows): array {
                     'fragmentation' => $row['fragmentation_ratio'],
                 ],
                 'connections'         => $row['connections'],
+                'commands_stats'      => json_decode((string) $row['commands_stats'], true, 512, JSON_THROW_ON_ERROR),
             ];
         }
 
diff --git a/templates/dashboards/redis/metrics.twig b/templates/dashboards/redis/metrics.twig
@@ -11,6 +11,9 @@
 }) }}
 
 <div class="gap-4 md:grid md:grid-cols-4">
+    <div class="col-span-4 p-4 mb-2 bg-white rounded-md border border-gray-200 dark:bg-gray-800 dark:border-gray-700">
+        <div id="command_calls_chart" class="h-90"></div>
+    </div>
     <div class="col-span-2 p-4 mb-2 bg-white rounded-md border border-gray-200 dark:bg-gray-800 dark:border-gray-700">
         <div id="memory_chart" class="h-90"></div>
     </div>
@@ -34,6 +37,7 @@
         const initial_theme = document.documentElement.classList.contains('dark') ? 'dark' : null;
 
         const chart_config = {
+            command_calls: echarts.init(document.getElementById('command_calls_chart'), initial_theme, {renderer: 'svg'}),
             memory: echarts.init(document.getElementById('memory_chart'), initial_theme, {renderer: 'svg'}),
             fragmentation: echarts.init(document.getElementById('fragmentation_chart'), initial_theme, {renderer: 'svg'}),
             commands: echarts.init(document.getElementById('commands_chart'), initial_theme, {renderer: 'svg'}),
@@ -45,6 +49,43 @@
             if (!data || data.length === 0) return;
             const timestamps = data.map(p => p.timestamp.split(' ')[1]);
 
+            const command_series = [...new Set(data.flatMap(p => Object.keys(p.commands_stats ?? {})))].map(name => ({
+                name: name,
+                type: 'line',
+                stack: 'Total',
+                areaStyle: {},
+                emphasis: {focus: 'series'},
+                data: data.map((p, i) => {
+                    if (i === 0 || !p.commands_stats || !data[i - 1].commands_stats) return 0;
+                    const val = (p.commands_stats?.[name] ?? 0) - (data[i - 1].commands_stats?.[name] ?? 0);
+                    return val < 0 ? 0 : val;
+                })
+            })).filter(s => s.data.some(v => v > 0));
+
+            chart(chart_config.command_calls, {
+                title: 'Command Calls',
+                legend: command_series.map(s => s.name),
+                tooltip: {
+                    confine: true,
+                    formatter: function (params) {
+                        let html = `<div style="min-width: 450px;">
+                            <strong>${params[0].name}</strong>
+                            <div style="display: grid; grid-template-columns: repeat(3, 1fr); gap: 0 20px;">`;
+
+                        params.forEach(item => {
+                            if (item.value > 0) {
+                                html += `<div class="flex justify-between items-center"><span>${item.marker} ${item.seriesName}</span><strong>${item.value}</strong></div>`;
+                            }
+                        });
+
+                        html += '</div></div>';
+                        return html;
+                    }
+                },
+                yAxis: {type: 'value', name: 'Calls'},
+                series: command_series
+            }, timestamps);
+
             chart(chart_config.memory, {
                 title: 'Memory Usage',
                 legend: ['Used', 'Peak'],
@@ -91,7 +132,6 @@
                     {name: 'Connections', type: 'line', data: data.map(p => p.connections), areaStyle: {}},
                 ],
             }, timestamps);
-
         };
 
         init_metrics(render_charts, chart_config);
