|
1 | 1 | export const accordionDescriptions = { |
2 | | - memoryUsageMetrics: |
| 2 | + memoryUsageMetrics: |
3 | 3 | "Detailed metrics for tracking Valkey's memory usage across data, scripts, functions, and peak consumption.", |
4 | | - uptimeMetrics: |
| 4 | + uptimeMetrics: |
5 | 5 | "Tracks server uptime and script eviction to monitor overall system activity and availability.", |
6 | | - replicationPersistenceMetrics: |
| 6 | + replicationPersistenceMetrics: |
7 | 7 | "Metrics that track database snapshots, data changes, and replication backlog health to ensure reliable syncing and persistence.", |
8 | | - clientConnectivityMetrics: |
| 8 | + clientConnectivityMetrics: |
9 | 9 | "Metrics tracking client connections, activity, and connection limits to monitor workload and health.", |
10 | | - commandExecutionMetrics: |
| 10 | + commandExecutionMetrics: |
11 | 11 | "Metrics showing command volume, failures, slow operations, and errors to evaluate performance and stability.", |
12 | | - dataEffectivenessEvictionMetrics: |
| 12 | + dataEffectivenessEvictionMetrics: |
13 | 13 | "Tracks key activity, expirations, evictions, and cache hit-rates to assess data efficiency and access performance.", |
14 | | - messagingMetrics: "Tracks Pub/Sub channels, patterns, and clients to measure real-time activity.", |
| 14 | + messagingMetrics: "Tracks Pub/Sub channels, patterns, and clients to measure real-time activity.", |
15 | 15 | } |
16 | 16 |
|
17 | 17 | export const singleMetricDescriptions = { |
18 | | - // for memory usage |
19 | | - used_memory: { |
20 | | - description: "Total number of bytes allocated by Valkey using its allocator.", |
21 | | - unit: "Unit: Bytes" |
22 | | - }, |
23 | | - used_memory_dataset: { |
24 | | - description: "The size in bytes of the dataset.", |
25 | | - unit: "Unit: Bytes" |
26 | | - }, |
27 | | - used_memory_functions: { |
28 | | - description: "Number of bytes overhead by Function scripts (part of used_memory).", |
29 | | - unit: "Unit: Bytes" |
30 | | - }, |
31 | | - used_memory_vm_eval: { |
32 | | - description: "Number of bytes used by the script VM engines for EVAL framework (not part of used_memory).", |
33 | | - unit: "Unit: Bytes" |
34 | | - }, |
35 | | - used_memory_peak: { |
36 | | - description: "Peak memory consumed by Valkey.", |
37 | | - unit: "Unit: Bytes" |
38 | | - }, |
39 | | - used_memory_scripts: { |
40 | | - description: "Number of bytes overhead by the EVAL scripts + Number of bytes overhead by Function scripts (part of used_memory).", |
41 | | - unit: "Unit: Bytes" |
42 | | - }, |
43 | | - total_system_memory: { |
44 | | - description: "Total amount of memory that the Valkey instance has available.", |
45 | | - unit: "Unit: Bytes" |
46 | | - }, |
| 18 | + // for memory usage |
| 19 | + used_memory: { |
| 20 | + description: "Total number of bytes allocated by Valkey using its allocator.", |
| 21 | + unit: "Unit: Bytes", |
| 22 | + }, |
| 23 | + used_memory_dataset: { |
| 24 | + description: "The size in bytes of the dataset.", |
| 25 | + unit: "Unit: Bytes", |
| 26 | + }, |
| 27 | + used_memory_functions: { |
| 28 | + description: "Number of bytes overhead by Function scripts (part of used_memory).", |
| 29 | + unit: "Unit: Bytes", |
| 30 | + }, |
| 31 | + used_memory_vm_eval: { |
| 32 | + description: "Number of bytes used by the script VM engines for EVAL framework (not part of used_memory).", |
| 33 | + unit: "Unit: Bytes", |
| 34 | + }, |
| 35 | + used_memory_peak: { |
| 36 | + description: "Peak memory consumed by Valkey.", |
| 37 | + unit: "Unit: Bytes", |
| 38 | + }, |
| 39 | + used_memory_scripts: { |
| 40 | + description: "Number of bytes overhead by the EVAL scripts + Number of bytes overhead by Function scripts (part of used_memory).", |
| 41 | + unit: "Unit: Bytes", |
| 42 | + }, |
| 43 | + total_system_memory: { |
| 44 | + description: "Total amount of memory that the Valkey instance has available.", |
| 45 | + unit: "Unit: Bytes", |
| 46 | + }, |
47 | 47 |
|
48 | | - // uptime metrics |
49 | | - evicted_scripts: { |
50 | | - description: "Number of evicted EVAL scripts due to LRU policy.", |
51 | | - unit: "" |
52 | | - }, |
53 | | - uptime_in_seconds: { |
54 | | - description: "Number of seconds since Valkey server start.", |
55 | | - unit: "Unit: Seconds" |
56 | | - }, |
57 | | - total_net_input_bytes: { |
58 | | - description: "The total number of bytes read from the network.", |
59 | | - unit: "Unit: Bytes" |
60 | | - }, |
61 | | - total_net_output_bytes: { |
62 | | - description: "The total number of bytes written to the network.", |
63 | | - unit: "Unit: Bytes" |
64 | | - }, |
| 48 | + // uptime metrics |
| 49 | + evicted_scripts: { |
| 50 | + description: "Number of evicted EVAL scripts due to LRU policy.", |
| 51 | + unit: "", |
| 52 | + }, |
| 53 | + uptime_in_seconds: { |
| 54 | + description: "Number of seconds since Valkey server start.", |
| 55 | + unit: "Unit: Seconds", |
| 56 | + }, |
| 57 | + total_net_input_bytes: { |
| 58 | + description: "The total number of bytes read from the network.", |
| 59 | + unit: "Unit: Bytes", |
| 60 | + }, |
| 61 | + total_net_output_bytes: { |
| 62 | + description: "The total number of bytes written to the network.", |
| 63 | + unit: "Unit: Bytes", |
| 64 | + }, |
65 | 65 |
|
66 | | - // replication and persistence metrics |
67 | | - rdb_bgsave_in_progress: { |
68 | | - description: "Flag indicating a RDB save is on-going, including a diskless replication RDB save.", |
69 | | - unit: "" |
70 | | - }, |
71 | | - rdb_changes_since_last_save: { |
72 | | - description: "Number of changes since the last RDB file save.", |
73 | | - unit: "" |
74 | | - }, |
75 | | - rdb_saves: { |
76 | | - description: "Number of RDB snapshots performed since startup.", |
77 | | - unit: "" |
78 | | - }, |
79 | | - mem_replication_backlog: { |
80 | | - description: "Memory used by replication backlog.", |
81 | | - unit: "" |
82 | | - }, |
83 | | - sync_full: { |
84 | | - description: "The number of full resyncs with replicas.", |
85 | | - unit: "" |
86 | | - }, |
87 | | - repl_backlog_active: { |
88 | | - description: "Flag indicating replication backlog is active.", |
89 | | - unit: "" |
90 | | - }, |
| 66 | + // replication and persistence metrics |
| 67 | + rdb_bgsave_in_progress: { |
| 68 | + description: "Flag indicating a RDB save is on-going, including a diskless replication RDB save.", |
| 69 | + unit: "", |
| 70 | + }, |
| 71 | + rdb_changes_since_last_save: { |
| 72 | + description: "Number of changes since the last RDB file save.", |
| 73 | + unit: "", |
| 74 | + }, |
| 75 | + rdb_saves: { |
| 76 | + description: "Number of RDB snapshots performed since startup.", |
| 77 | + unit: "", |
| 78 | + }, |
| 79 | + mem_replication_backlog: { |
| 80 | + description: "Memory used by replication backlog.", |
| 81 | + unit: "", |
| 82 | + }, |
| 83 | + sync_full: { |
| 84 | + description: "The number of full resyncs with replicas.", |
| 85 | + unit: "", |
| 86 | + }, |
| 87 | + repl_backlog_active: { |
| 88 | + description: "Flag indicating replication backlog is active.", |
| 89 | + unit: "", |
| 90 | + }, |
91 | 91 |
|
92 | | - // client connectivity metrics |
93 | | - blocked_clients: { |
94 | | - description: "Number of clients pending on a blocking call.", |
95 | | - unit: "" |
96 | | - }, |
97 | | - clients_in_timeout_table: { |
98 | | - description: "Number of clients in the clients timeout table.", |
99 | | - unit: "" |
100 | | - }, |
101 | | - connected_clients: { |
102 | | - description: "Number of client connections (excluding connections from replicas).", |
103 | | - unit: "" |
104 | | - }, |
105 | | - connected_slaves: { |
106 | | - description: "Number of connected replicas.", |
107 | | - unit: "" |
108 | | - }, |
109 | | - total_connections_received: { |
110 | | - description: "Total number of connections accepted by the server.", |
111 | | - unit: "" |
112 | | - }, |
113 | | - evicted_clients: { |
114 | | - description: "Number of evicted clients due to maxmemory-clients limit.", |
115 | | - unit: "" |
116 | | - }, |
117 | | - rejected_connections: { |
118 | | - description: "Number of connections rejected because of maxclients limit.", |
119 | | - unit: "" |
120 | | - }, |
121 | | - total_reads_processed: { |
122 | | - description: "Total number of read events processed.", |
123 | | - unit: "" |
124 | | - }, |
125 | | - total_writes_processed: { |
126 | | - description: "Total number of write events processed.", |
127 | | - unit: "" |
128 | | - }, |
129 | | - tracking_clients: { |
130 | | - description: "Number of clients being tracked.", |
131 | | - unit: "" |
132 | | - }, |
133 | | - watching_clients: { |
134 | | - description: "Number of clients in watching mode.", |
135 | | - unit: "" |
136 | | - }, |
| 92 | + // client connectivity metrics |
| 93 | + blocked_clients: { |
| 94 | + description: "Number of clients pending on a blocking call.", |
| 95 | + unit: "", |
| 96 | + }, |
| 97 | + clients_in_timeout_table: { |
| 98 | + description: "Number of clients in the clients timeout table.", |
| 99 | + unit: "", |
| 100 | + }, |
| 101 | + connected_clients: { |
| 102 | + description: "Number of client connections (excluding connections from replicas).", |
| 103 | + unit: "", |
| 104 | + }, |
| 105 | + connected_slaves: { |
| 106 | + description: "Number of connected replicas.", |
| 107 | + unit: "", |
| 108 | + }, |
| 109 | + total_connections_received: { |
| 110 | + description: "Total number of connections accepted by the server.", |
| 111 | + unit: "", |
| 112 | + }, |
| 113 | + evicted_clients: { |
| 114 | + description: "Number of evicted clients due to maxmemory-clients limit.", |
| 115 | + unit: "", |
| 116 | + }, |
| 117 | + rejected_connections: { |
| 118 | + description: "Number of connections rejected because of maxclients limit.", |
| 119 | + unit: "", |
| 120 | + }, |
| 121 | + total_reads_processed: { |
| 122 | + description: "Total number of read events processed.", |
| 123 | + unit: "", |
| 124 | + }, |
| 125 | + total_writes_processed: { |
| 126 | + description: "Total number of write events processed.", |
| 127 | + unit: "", |
| 128 | + }, |
| 129 | + tracking_clients: { |
| 130 | + description: "Number of clients being tracked.", |
| 131 | + unit: "", |
| 132 | + }, |
| 133 | + watching_clients: { |
| 134 | + description: "Number of clients in watching mode.", |
| 135 | + unit: "", |
| 136 | + }, |
137 | 137 |
|
138 | | - // command execution metrics |
139 | | - total_commands_processed: { |
140 | | - description: "Total number of commands processed by server.", |
141 | | - unit: "" |
142 | | - }, |
143 | | - total_blocking_keys: { |
144 | | - description: "Number of blocking keys.", |
145 | | - unit: "" |
146 | | - }, |
147 | | - total_error_replies: { |
148 | | - description: "Total number of issued error replies, that is the sum of rejected commands (errors prior command execution) and failed commands (errors within the command execution).", |
149 | | - unit: "" |
150 | | - }, |
151 | | - total_watched_keys: { |
152 | | - description: "Number of watched keys.", |
153 | | - unit: "" |
154 | | - }, |
155 | | - unexpected_error_replies: { |
156 | | - description: "Number of unexpected error replies, that are types of errors from an AOF load or replication.", |
157 | | - unit: "" |
158 | | - }, |
| 138 | + // command execution metrics |
| 139 | + total_commands_processed: { |
| 140 | + description: "Total number of commands processed by server.", |
| 141 | + unit: "", |
| 142 | + }, |
| 143 | + total_blocking_keys: { |
| 144 | + description: "Number of blocking keys.", |
| 145 | + unit: "", |
| 146 | + }, |
| 147 | + total_error_replies: { |
| 148 | + description: "Total number of issued error replies, that is the sum of rejected commands and failed commands.", |
| 149 | + unit: "", |
| 150 | + }, |
| 151 | + total_watched_keys: { |
| 152 | + description: "Number of watched keys.", |
| 153 | + unit: "", |
| 154 | + }, |
| 155 | + unexpected_error_replies: { |
| 156 | + description: "Number of unexpected error replies, that are types of errors from an AOF load or replication.", |
| 157 | + unit: "", |
| 158 | + }, |
159 | 159 |
|
160 | | - // data effectiveness and eviction metrics |
161 | | - evicted_keys: { |
162 | | - description: "Number of evicted keys due to maxmemory limit.", |
163 | | - unit: "" |
164 | | - }, |
165 | | - expired_keys: { |
166 | | - description: "Total number of key expiration events.", |
167 | | - unit: "" |
168 | | - }, |
169 | | - expired_stale_perc: { |
170 | | - description: "The percentage of keys probably expired.", |
171 | | - unit: "" |
172 | | - }, |
173 | | - keyspace_hits: { |
174 | | - description: "Number of successful lookup of keys in the main dictionary.", |
175 | | - unit: "" |
176 | | - }, |
177 | | - keyspace_misses: { |
178 | | - description: "Number of failed lookup of keys in the main dictionary.", |
179 | | - unit: "" |
180 | | - }, |
181 | | - number_of_cached_scripts: { |
182 | | - description: "The number of EVAL scripts cached by the server.", |
183 | | - unit: "" |
184 | | - }, |
185 | | - number_of_functions: { |
186 | | - description: "The number of functions.", |
187 | | - unit: "" |
188 | | - }, |
| 160 | + // data effectiveness and eviction metrics |
| 161 | + evicted_keys: { |
| 162 | + description: "Number of evicted keys due to maxmemory limit.", |
| 163 | + unit: "", |
| 164 | + }, |
| 165 | + expired_keys: { |
| 166 | + description: "Total number of key expiration events.", |
| 167 | + unit: "", |
| 168 | + }, |
| 169 | + expired_stale_perc: { |
| 170 | + description: "The percentage of keys probably expired.", |
| 171 | + unit: "", |
| 172 | + }, |
| 173 | + keyspace_hits: { |
| 174 | + description: "Number of successful lookup of keys in the main dictionary.", |
| 175 | + unit: "", |
| 176 | + }, |
| 177 | + keyspace_misses: { |
| 178 | + description: "Number of failed lookup of keys in the main dictionary.", |
| 179 | + unit: "", |
| 180 | + }, |
| 181 | + number_of_cached_scripts: { |
| 182 | + description: "The number of EVAL scripts cached by the server.", |
| 183 | + unit: "", |
| 184 | + }, |
| 185 | + number_of_functions: { |
| 186 | + description: "The number of functions.", |
| 187 | + unit: "", |
| 188 | + }, |
189 | 189 |
|
190 | | - // messaging metrics |
191 | | - pubsubshard_channels: { |
192 | | - description: "Global number of pub/sub shard channels with client subscriptions.", |
193 | | - unit: "" |
194 | | - }, |
195 | | - pubsub_channels: { |
196 | | - description: "Global number of pub/sub channels with client subscriptions.", |
197 | | - unit: "" |
198 | | - }, |
199 | | - pubsub_clients: { |
200 | | - description: "Number of clients in pubsub mode.", |
201 | | - unit: "" |
202 | | - }, |
203 | | - pubsub_patterns: { |
204 | | - description: "Global number of pub/sub pattern with client subscriptions.", |
205 | | - unit: "" |
206 | | - }, |
| 190 | + // messaging metrics |
| 191 | + pubsubshard_channels: { |
| 192 | + description: "Global number of pub/sub shard channels with client subscriptions.", |
| 193 | + unit: "", |
| 194 | + }, |
| 195 | + pubsub_channels: { |
| 196 | + description: "Global number of pub/sub channels with client subscriptions.", |
| 197 | + unit: "", |
| 198 | + }, |
| 199 | + pubsub_clients: { |
| 200 | + description: "Number of clients in pubsub mode.", |
| 201 | + unit: "", |
| 202 | + }, |
| 203 | + pubsub_patterns: { |
| 204 | + description: "Global number of pub/sub pattern with client subscriptions.", |
| 205 | + unit: "", |
| 206 | + }, |
207 | 207 | } |
0 commit comments