From 3705dd09839de62e0de5864cb41e4c731f0ee997 Mon Sep 17 00:00:00 2001 From: Rachel Elledge Date: Thu, 31 Jul 2025 12:02:20 -0500 Subject: [PATCH 1/7] DOC-5527 Attempted to fix an issue where markdown tables overlap and are blocked by the on this page panel for certain window sizes --- assets/css/index.css | 28 +++++ content/embeds/rs-prometheus-metrics-v2.md | 132 ++++++++++----------- 2 files changed, 94 insertions(+), 66 deletions(-) diff --git a/assets/css/index.css b/assets/css/index.css index f91f8f6f3..0bf184139 100644 --- a/assets/css/index.css +++ b/assets/css/index.css @@ -579,6 +579,34 @@ html { scrollbar-gutter: stable; } +/* Make tables responsive to avoid TOC overlap */ +@media (min-width: 1280px) { + /* On XL screens where TOC is visible, make tables horizontally scrollable */ + .docs .prose table { + display: block; + overflow-x: auto; + white-space: nowrap; + max-width: calc(100vw - 400px); /* Account for TOC + nav + margins */ + } + + .docs .prose table thead, + .docs .prose table tbody, + .docs .prose table tr { + display: table; + width: 100%; + table-layout: fixed; + } + + .docs .prose table td, + .docs .prose table th { + white-space: normal; + word-wrap: break-word; + padding: 0.5rem; + } +} + + + /* Chroma syntax highlighting */ /* Background */ diff --git a/content/embeds/rs-prometheus-metrics-v2.md b/content/embeds/rs-prometheus-metrics-v2.md index d5c85a62e..6070b8b76 100644 --- a/content/embeds/rs-prometheus-metrics-v2.md +++ b/content/embeds/rs-prometheus-metrics-v2.md @@ -102,72 +102,72 @@ | Metric | Description | | :-------- | :---------- | -| redis_server_active_defrag_running | Automatic memory defragmentation current aggressiveness (% cpu) | -| redis_server_allocator_active | Total used memory, including external fragmentation | -| redis_server_allocator_allocated | Total allocated memory | -| redis_server_allocator_resident | Total resident memory (RSS) | -| redis_server_aof_last_cow_size | Last AOFR, CopyOnWrite memory | -| redis_server_aof_rewrite_in_progress | The number of simultaneous AOF rewrites that are in progress | -| redis_server_aof_rewrites | Number of AOF rewrites this process executed | -| redis_server_aof_delayed_fsync | Number of times an AOF fsync caused delays in the main Redis thread (inducing latency); this can indicate that the disk is slow or overloaded | -| redis_server_blocked_clients | Count the clients waiting on a blocking call | -| redis_server_connected_clients | Number of client connections to the specific shard | -| redis_server_connected_slaves | Number of connected replicas | -| redis_server_db_avg_ttl | Average TTL of all volatile keys | -| redis_server_db0_avg_ttl | Average TTL of all volatile keys. Deprecated. | -| redis_server_db_keys | Total key count. | -| redis_server_db0_keys | Total key count. Deprecated. | -| redis_server_evicted_keys | Keys evicted so far (since restart) | -| redis_server_expire_cycle_cpu_milliseconds | The cumulative amount of time spent on active expiry cycles | -| redis_server_expired_keys | Keys expired so far since restart | -| redis_server_forwarding_state | Shard forwarding state (on or off) | -| redis_server_hashes_items_under_1M | Number of hash keys with under 1 million elements | -| redis_server_hashes_items_1M_to_8M | Number of hash keys with an element count between 1 million and 8 million | -| redis_server_hashes_items_over_8M | Number of hash keys with over 8 million elements | -| redis_server_keys_trimmed | The number of keys that were trimmed in the current or last resharding process | -| redis_server_keyspace_read_hits | Number of read operations accessing an existing keyspace | -| redis_server_keyspace_read_misses | Number of read operations accessing a non-existing keyspace | -| redis_server_keyspace_write_hits | Number of write operations accessing an existing keyspace | -| redis_server_keyspace_write_misses | Number of write operations accessing a non-existing keyspace | -| redis_server_lists_items_under_1M | Number of list keys with under 1 million elements | -| redis_server_lists_items_1M_to_8M | Number of list keys with an element count between 1 million and 8 million | -| redis_server_lists_items_over_8M | Number of list keys with over 8 million elements | -| redis_server_master_link_status | Indicates if the replica is connected to its master | -| redis_server_master_repl_offset | Number of bytes sent to replicas by the shard; calculate the throughput for a time period by comparing the value at different times | -| redis_server_master_sync_in_progress | The primary shard is synchronizing (1 true; 0 false) | -| redis_server_max_process_mem | Current memory limit configured by redis_mgr according to node free memory | -| redis_server_maxmemory | Current memory limit configured by redis_mgr according to database memory limits | -| redis_server_mem_aof_buffer | Current size of AOF buffer | -| redis_server_mem_clients_normal | Current memory used for input and output buffers of non-replica clients | -| redis_server_mem_clients_slaves | Current memory used for input and output buffers of replica clients | -| redis_server_mem_fragmentation_ratio | Memory fragmentation ratio (1.3 means 30% overhead) | -| redis_server_mem_not_counted_for_evict | Portion of used_memory (in bytes) that's not counted for eviction and OOM error | -| redis_server_mem_replication_backlog | Size of replication backlog | -| redis_server_module_fork_in_progress | A binary value that indicates if there is an active fork spawned by a module (1) or not (0) | -| namedprocess_namegroup_cpu_seconds_total | Shard process CPU usage in seconds | -| namedprocess_namegroup_thread_cpu_seconds_total | Shard main thread CPU time spent in seconds | -| namedprocess_namegroup_open_filedesc | Shard number of open file descriptors | -| namedprocess_namegroup_memory_bytes | Shard memory size in bytes | -| namedprocess_namegroup_oldest_start_time_seconds | Shard start time of the process since unix epoch in seconds | -| redis_server_rdb_bgsave_in_progress | Indication if bgsave is currently in progress | -| redis_server_rdb_last_cow_size | Last bgsave (or SYNC fork) used CopyOnWrite memory | -| redis_server_rdb_saves | Total count of bgsaves since the process was restarted (including replica fullsync and persistence) | -| redis_server_sets_items_under_1M | Number of set keys with under 1 million elements | -| redis_server_sets_items_1M_to_8M | Number of set keys with an element count between 1 million and 8 million | -| redis_server_sets_items_over_8M | Number of set keys with over 8 million elements | -| redis_server_repl_touch_bytes | Number of bytes sent to replicas as TOUCH commands by the shard as a result of a READ command that was processed; calculate the throughput for a time period by comparing the value at different times | -| redis_server_total_commands_processed | Number of commands processed by the shard; calculate the number of commands for a time period by comparing the value at different times | -| redis_server_total_connections_received | Number of connections received by the shard; calculate the number of connections for a time period by comparing the value at different times | -| redis_server_total_net_input_bytes | Number of bytes received by the shard; calculate the throughput for a time period by comparing the value at different times | -| redis_server_total_net_output_bytes | Number of bytes sent by the shard; calculate the throughput for a time period by comparing the value at different times | -| redis_server_up | Shard is up and running | -| redis_server_strings_sizes_under_128M | Number of string keys with a memory size under 128 megabytes | -| redis_server_strings_sizes_128M_to_512M | Number of string keys with a memory size between 128 and 512 megabytes | -| redis_server_strings_sizes_over_512M | Number of string keys with a memory size over 512 megabytes | -| redis_server_used_memory | Memory used by shard (in BigRedis this includes flash) (bytes) | -| redis_server_zsets_items_under_1M | Number of sorted set keys with under 1 million elements | -| redis_server_zsets_items_1M_to_8M | Number of sorted set keys with an element count between 1 million and 8 million | -| redis_server_zsets_items_over_8M | Number of sorted set keys with over 8 million elements | +| redis_server_active_defrag_running | Automatic memory defragmentation current aggressiveness (% cpu) | +| redis_server_allocator_active | Total used memory, including external fragmentation | +| redis_server_allocator_allocated | Total allocated memory | +| redis_server_allocator_resident | Total resident memory (RSS) | +| redis_server_aof_last_cow_size | Last AOFR, CopyOnWrite memory | +| redis_server_aof_rewrite_in_progress | The number of simultaneous AOF rewrites that are in progress | +| redis_server_aof_rewrites | Number of AOF rewrites this process executed | +| redis_server_aof_delayed_fsync | Number of times an AOF fsync caused delays in the main Redis thread (inducing latency); this can indicate that the disk is slow or overloaded | +| redis_server_blocked_clients | Count the clients waiting on a blocking call | +| redis_server_connected_clients | Number of client connections to the specific shard | +| redis_server_connected_slaves | Number of connected replicas | +| redis_server_db_avg_ttl | Average TTL of all volatile keys | +| redis_server_db0_avg_ttl | Average TTL of all volatile keys. Deprecated. | +| redis_server_db_keys | Total key count. | +| redis_server_db0_keys | Total key count. Deprecated. | +| redis_server_evicted_keys | Keys evicted so far (since restart) | +| redis_server_expire_cycle_cpu_milliseconds | The cumulative amount of time spent on active expiry cycles | +| redis_server_expired_keys | Keys expired so far since restart | +| redis_server_forwarding_state | Shard forwarding state (on or off) | +| redis_server_hashes_items_under_1M | Number of hash keys with under 1 million elements | +| redis_server_hashes_items_1M_to_8M | Number of hash keys with an element count between 1 million and 8 million | +| redis_server_hashes_items_over_8M | Number of hash keys with over 8 million elements | +| redis_server_keys_trimmed | The number of keys that were trimmed in the current or last resharding process | +| redis_server_keyspace_read_hits | Number of read operations accessing an existing keyspace | +| redis_server_keyspace_read_misses | Number of read operations accessing a non-existing keyspace | +| redis_server_keyspace_write_hits | Number of write operations accessing an existing keyspace | +| redis_server_keyspace_write_misses | Number of write operations accessing a non-existing keyspace | +| redis_server_lists_items_under_1M | Number of list keys with under 1 million elements | +| redis_server_lists_items_1M_to_8M | Number of list keys with an element count between 1 million and 8 million | +| redis_server_lists_items_over_8M | Number of list keys with over 8 million elements | +| redis_server_master_link_status | Indicates if the replica is connected to its master | +| redis_server_master_repl_offset | Number of bytes sent to replicas by the shard; calculate the throughput for a time period by comparing the value at different times | +| redis_server_master_sync_in_progress | The primary shard is synchronizing (1 true; 0 false) | +| redis_server_max_process_mem | Current memory limit configured by redis_mgr according to node free memory | +| redis_server_maxmemory | Current memory limit configured by redis_mgr according to database memory limits | +| redis_server_mem_aof_buffer | Current size of AOF buffer | +| redis_server_mem_clients_normal | Current memory used for input and output buffers of non-replica clients | +| redis_server_mem_clients_slaves | Current memory used for input and output buffers of replica clients | +| redis_server_mem_fragmentation_ratio | Memory fragmentation ratio (1.3 means 30% overhead) | +| redis_server_mem_not_counted_for_evict | Portion of used_memory (in bytes) that's not counted for eviction and OOM error | +| redis_server_mem_replication_backlog | Size of replication backlog | +| redis_server_module_fork_in_progress | A binary value that indicates if there is an active fork spawned by a module (1) or not (0) | +| namedprocess_namegroup_cpu_seconds_total | Shard process CPU usage in seconds | +| namedprocess_namegroup_thread_cpu_seconds_total | Shard main thread CPU time spent in seconds | +| namedprocess_namegroup_open_filedesc | Shard number of open file descriptors | +| namedprocess_namegroup_memory_bytes | Shard memory size in bytes | +| namedprocess_namegroup_oldest_start_time_seconds | Shard start time of the process since unix epoch in seconds | +| redis_server_rdb_bgsave_in_progress | Indication if bgsave is currently in progress | +| redis_server_rdb_last_cow_size | Last bgsave (or SYNC fork) used CopyOnWrite memory | +| redis_server_rdb_saves | Total count of bgsaves since the process was restarted (including replica fullsync and persistence) | +| redis_server_sets_items_under_1M | Number of set keys with under 1 million elements | +| redis_server_sets_items_1M_to_8M | Number of set keys with an element count between 1 million and 8 million | +| redis_server_sets_items_over_8M | Number of set keys with over 8 million elements | +| redis_server_repl_touch_bytes | Number of bytes sent to replicas as TOUCH commands by the shard as a result of a READ command that was processed; calculate the throughput for a time period by comparing the value at different times | +| redis_server_total_commands_processed | Number of commands processed by the shard; calculate the number of commands for a time period by comparing the value at different times | +| redis_server_total_connections_received | Number of connections received by the shard; calculate the number of connections for a time period by comparing the value at different times | +| redis_server_total_net_input_bytes | Number of bytes received by the shard; calculate the throughput for a time period by comparing the value at different times | +| redis_server_total_net_output_bytes | Number of bytes sent by the shard; calculate the throughput for a time period by comparing the value at different times | +| redis_server_up | Shard is up and running | +| redis_server_strings_sizes_under_128M | Number of string keys with a memory size under 128 megabytes | +| redis_server_strings_sizes_128M_to_512M | Number of string keys with a memory size between 128 and 512 megabytes | +| redis_server_strings_sizes_over_512M | Number of string keys with a memory size over 512 megabytes | +| redis_server_used_memory | Memory used by shard (in BigRedis this includes flash) (bytes) | +| redis_server_zsets_items_under_1M | Number of sorted set keys with under 1 million elements | +| redis_server_zsets_items_1M_to_8M | Number of sorted set keys with an element count between 1 million and 8 million | +| redis_server_zsets_items_over_8M | Number of sorted set keys with over 8 million elements | | redis_server_search_gc_bytes_collected | The total amount of memory freed by the garbage collectors from indexes in the shard's memory in bytes. [3](#tnote-3) | | redis_server_search_bytes_collected | The total amount of memory freed by the garbage collectors from indexes in the shard's memory in bytes. Deprecated in 8.0 (renamed redis_server_search_gc_bytes_collected), but still available in older versions. [1](#tnote-1) | | redis_server_search_gc_marked_deleted_vectors | The number of vectors marked as deleted in the vector indexes that have not yet been cleaned. [3](#tnote-3) | From 2f25cff9faf267dc581b387a4372202324a98e4c Mon Sep 17 00:00:00 2001 From: Rachel Elledge Date: Thu, 31 Jul 2025 13:41:20 -0500 Subject: [PATCH 2/7] DOC-5527 Changed fix for table/mini-ToC overlap from standard CSS to mostly Tailwind CSS for consistency --- assets/css/index.css | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) diff --git a/assets/css/index.css b/assets/css/index.css index 0bf184139..06210572c 100644 --- a/assets/css/index.css +++ b/assets/css/index.css @@ -581,27 +581,21 @@ html { /* Make tables responsive to avoid TOC overlap */ @media (min-width: 1280px) { - /* On XL screens where TOC is visible, make tables horizontally scrollable */ + /* On XL screens where TOC is visible, make tables horizontally scrollable when needed*/ .docs .prose table { - display: block; - overflow-x: auto; - white-space: nowrap; + @apply block overflow-x-auto whitespace-nowrap; max-width: calc(100vw - 400px); /* Account for TOC + nav + margins */ } .docs .prose table thead, .docs .prose table tbody, .docs .prose table tr { - display: table; - width: 100%; - table-layout: fixed; + @apply table w-full table-fixed; } .docs .prose table td, .docs .prose table th { - white-space: normal; - word-wrap: break-word; - padding: 0.5rem; + @apply whitespace-normal break-words p-2; } } From f90c671aed2d99c4eb286a62cea828fa42c79942 Mon Sep 17 00:00:00 2001 From: Rachel Elledge Date: Thu, 31 Jul 2025 14:37:27 -0500 Subject: [PATCH 3/7] DOC-5527 Changed table column names from break-all to break-normal to prevent strange wrapping --- assets/css/index.css | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/assets/css/index.css b/assets/css/index.css index 06210572c..98bbd78c6 100644 --- a/assets/css/index.css +++ b/assets/css/index.css @@ -593,8 +593,13 @@ html { @apply table w-full table-fixed; } - .docs .prose table td, + /* Table headers should break naturally at word boundaries */ .docs .prose table th { + @apply whitespace-normal break-normal p-2; + } + + /* Table data cells can break more aggressively for long content */ + .docs .prose table td { @apply whitespace-normal break-words p-2; } } From 2d57988f8039e2ad848473e2c8fcf7568ab2f743 Mon Sep 17 00:00:00 2001 From: Rachel Elledge Date: Thu, 31 Jul 2025 16:13:42 -0500 Subject: [PATCH 4/7] DOC-5527 Excluded post-categories from the table overlap fixes to prevent strange formatting of the product tags under the page titles --- assets/css/index.css | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/assets/css/index.css b/assets/css/index.css index 98bbd78c6..087baab0c 100644 --- a/assets/css/index.css +++ b/assets/css/index.css @@ -582,25 +582,31 @@ html { /* Make tables responsive to avoid TOC overlap */ @media (min-width: 1280px) { /* On XL screens where TOC is visible, make tables horizontally scrollable when needed*/ - .docs .prose table { + /* Exclude the post-categories table at the top of pages */ + .docs .prose table:not(.post-categories table) { @apply block overflow-x-auto whitespace-nowrap; max-width: calc(100vw - 400px); /* Account for TOC + nav + margins */ } - .docs .prose table thead, - .docs .prose table tbody, - .docs .prose table tr { + .docs .prose table:not(.post-categories table) thead, + .docs .prose table:not(.post-categories table) tbody, + .docs .prose table:not(.post-categories table) tr { @apply table w-full table-fixed; } /* Table headers should break naturally at word boundaries */ - .docs .prose table th { + .docs .prose table:not(.post-categories table) th { @apply whitespace-normal break-normal p-2; } /* Table data cells can break more aggressively for long content */ - .docs .prose table td { - @apply whitespace-normal break-words p-2; + .docs .prose table:not(.post-categories table) td { + @apply whitespace-normal break-normal p-2; + } + + /* Prevent content from extending under the fixed "On this page" TOC */ + .docs .prose { + @apply mr-64; /* 256px margin = 240px TOC width + 16px buffer */ } } From 9c25ab1f27b78e3e198099030cf0461b2325e154 Mon Sep 17 00:00:00 2001 From: Rachel Elledge Date: Fri, 1 Aug 2025 11:22:00 -0500 Subject: [PATCH 5/7] DOC-5527 Reverted changes that attemped to fix the overlap issue with tables and the on this page ToC since it caused other visual issues --- assets/css/index.css | 29 ----- content/embeds/rs-prometheus-metrics-v2.md | 132 ++++++++++----------- 2 files changed, 66 insertions(+), 95 deletions(-) diff --git a/assets/css/index.css b/assets/css/index.css index 087baab0c..54945ffb1 100644 --- a/assets/css/index.css +++ b/assets/css/index.css @@ -579,36 +579,7 @@ html { scrollbar-gutter: stable; } -/* Make tables responsive to avoid TOC overlap */ -@media (min-width: 1280px) { - /* On XL screens where TOC is visible, make tables horizontally scrollable when needed*/ - /* Exclude the post-categories table at the top of pages */ - .docs .prose table:not(.post-categories table) { - @apply block overflow-x-auto whitespace-nowrap; - max-width: calc(100vw - 400px); /* Account for TOC + nav + margins */ - } - - .docs .prose table:not(.post-categories table) thead, - .docs .prose table:not(.post-categories table) tbody, - .docs .prose table:not(.post-categories table) tr { - @apply table w-full table-fixed; - } - - /* Table headers should break naturally at word boundaries */ - .docs .prose table:not(.post-categories table) th { - @apply whitespace-normal break-normal p-2; - } - /* Table data cells can break more aggressively for long content */ - .docs .prose table:not(.post-categories table) td { - @apply whitespace-normal break-normal p-2; - } - - /* Prevent content from extending under the fixed "On this page" TOC */ - .docs .prose { - @apply mr-64; /* 256px margin = 240px TOC width + 16px buffer */ - } -} diff --git a/content/embeds/rs-prometheus-metrics-v2.md b/content/embeds/rs-prometheus-metrics-v2.md index 6070b8b76..d5c85a62e 100644 --- a/content/embeds/rs-prometheus-metrics-v2.md +++ b/content/embeds/rs-prometheus-metrics-v2.md @@ -102,72 +102,72 @@ | Metric | Description | | :-------- | :---------- | -| redis_server_active_defrag_running | Automatic memory defragmentation current aggressiveness (% cpu) | -| redis_server_allocator_active | Total used memory, including external fragmentation | -| redis_server_allocator_allocated | Total allocated memory | -| redis_server_allocator_resident | Total resident memory (RSS) | -| redis_server_aof_last_cow_size | Last AOFR, CopyOnWrite memory | -| redis_server_aof_rewrite_in_progress | The number of simultaneous AOF rewrites that are in progress | -| redis_server_aof_rewrites | Number of AOF rewrites this process executed | -| redis_server_aof_delayed_fsync | Number of times an AOF fsync caused delays in the main Redis thread (inducing latency); this can indicate that the disk is slow or overloaded | -| redis_server_blocked_clients | Count the clients waiting on a blocking call | -| redis_server_connected_clients | Number of client connections to the specific shard | -| redis_server_connected_slaves | Number of connected replicas | -| redis_server_db_avg_ttl | Average TTL of all volatile keys | -| redis_server_db0_avg_ttl | Average TTL of all volatile keys. Deprecated. | -| redis_server_db_keys | Total key count. | -| redis_server_db0_keys | Total key count. Deprecated. | -| redis_server_evicted_keys | Keys evicted so far (since restart) | -| redis_server_expire_cycle_cpu_milliseconds | The cumulative amount of time spent on active expiry cycles | -| redis_server_expired_keys | Keys expired so far since restart | -| redis_server_forwarding_state | Shard forwarding state (on or off) | -| redis_server_hashes_items_under_1M | Number of hash keys with under 1 million elements | -| redis_server_hashes_items_1M_to_8M | Number of hash keys with an element count between 1 million and 8 million | -| redis_server_hashes_items_over_8M | Number of hash keys with over 8 million elements | -| redis_server_keys_trimmed | The number of keys that were trimmed in the current or last resharding process | -| redis_server_keyspace_read_hits | Number of read operations accessing an existing keyspace | -| redis_server_keyspace_read_misses | Number of read operations accessing a non-existing keyspace | -| redis_server_keyspace_write_hits | Number of write operations accessing an existing keyspace | -| redis_server_keyspace_write_misses | Number of write operations accessing a non-existing keyspace | -| redis_server_lists_items_under_1M | Number of list keys with under 1 million elements | -| redis_server_lists_items_1M_to_8M | Number of list keys with an element count between 1 million and 8 million | -| redis_server_lists_items_over_8M | Number of list keys with over 8 million elements | -| redis_server_master_link_status | Indicates if the replica is connected to its master | -| redis_server_master_repl_offset | Number of bytes sent to replicas by the shard; calculate the throughput for a time period by comparing the value at different times | -| redis_server_master_sync_in_progress | The primary shard is synchronizing (1 true; 0 false) | -| redis_server_max_process_mem | Current memory limit configured by redis_mgr according to node free memory | -| redis_server_maxmemory | Current memory limit configured by redis_mgr according to database memory limits | -| redis_server_mem_aof_buffer | Current size of AOF buffer | -| redis_server_mem_clients_normal | Current memory used for input and output buffers of non-replica clients | -| redis_server_mem_clients_slaves | Current memory used for input and output buffers of replica clients | -| redis_server_mem_fragmentation_ratio | Memory fragmentation ratio (1.3 means 30% overhead) | -| redis_server_mem_not_counted_for_evict | Portion of used_memory (in bytes) that's not counted for eviction and OOM error | -| redis_server_mem_replication_backlog | Size of replication backlog | -| redis_server_module_fork_in_progress | A binary value that indicates if there is an active fork spawned by a module (1) or not (0) | -| namedprocess_namegroup_cpu_seconds_total | Shard process CPU usage in seconds | -| namedprocess_namegroup_thread_cpu_seconds_total | Shard main thread CPU time spent in seconds | -| namedprocess_namegroup_open_filedesc | Shard number of open file descriptors | -| namedprocess_namegroup_memory_bytes | Shard memory size in bytes | -| namedprocess_namegroup_oldest_start_time_seconds | Shard start time of the process since unix epoch in seconds | -| redis_server_rdb_bgsave_in_progress | Indication if bgsave is currently in progress | -| redis_server_rdb_last_cow_size | Last bgsave (or SYNC fork) used CopyOnWrite memory | -| redis_server_rdb_saves | Total count of bgsaves since the process was restarted (including replica fullsync and persistence) | -| redis_server_sets_items_under_1M | Number of set keys with under 1 million elements | -| redis_server_sets_items_1M_to_8M | Number of set keys with an element count between 1 million and 8 million | -| redis_server_sets_items_over_8M | Number of set keys with over 8 million elements | -| redis_server_repl_touch_bytes | Number of bytes sent to replicas as TOUCH commands by the shard as a result of a READ command that was processed; calculate the throughput for a time period by comparing the value at different times | -| redis_server_total_commands_processed | Number of commands processed by the shard; calculate the number of commands for a time period by comparing the value at different times | -| redis_server_total_connections_received | Number of connections received by the shard; calculate the number of connections for a time period by comparing the value at different times | -| redis_server_total_net_input_bytes | Number of bytes received by the shard; calculate the throughput for a time period by comparing the value at different times | -| redis_server_total_net_output_bytes | Number of bytes sent by the shard; calculate the throughput for a time period by comparing the value at different times | -| redis_server_up | Shard is up and running | -| redis_server_strings_sizes_under_128M | Number of string keys with a memory size under 128 megabytes | -| redis_server_strings_sizes_128M_to_512M | Number of string keys with a memory size between 128 and 512 megabytes | -| redis_server_strings_sizes_over_512M | Number of string keys with a memory size over 512 megabytes | -| redis_server_used_memory | Memory used by shard (in BigRedis this includes flash) (bytes) | -| redis_server_zsets_items_under_1M | Number of sorted set keys with under 1 million elements | -| redis_server_zsets_items_1M_to_8M | Number of sorted set keys with an element count between 1 million and 8 million | -| redis_server_zsets_items_over_8M | Number of sorted set keys with over 8 million elements | +| redis_server_active_defrag_running | Automatic memory defragmentation current aggressiveness (% cpu) | +| redis_server_allocator_active | Total used memory, including external fragmentation | +| redis_server_allocator_allocated | Total allocated memory | +| redis_server_allocator_resident | Total resident memory (RSS) | +| redis_server_aof_last_cow_size | Last AOFR, CopyOnWrite memory | +| redis_server_aof_rewrite_in_progress | The number of simultaneous AOF rewrites that are in progress | +| redis_server_aof_rewrites | Number of AOF rewrites this process executed | +| redis_server_aof_delayed_fsync | Number of times an AOF fsync caused delays in the main Redis thread (inducing latency); this can indicate that the disk is slow or overloaded | +| redis_server_blocked_clients | Count the clients waiting on a blocking call | +| redis_server_connected_clients | Number of client connections to the specific shard | +| redis_server_connected_slaves | Number of connected replicas | +| redis_server_db_avg_ttl | Average TTL of all volatile keys | +| redis_server_db0_avg_ttl | Average TTL of all volatile keys. Deprecated. | +| redis_server_db_keys | Total key count. | +| redis_server_db0_keys | Total key count. Deprecated. | +| redis_server_evicted_keys | Keys evicted so far (since restart) | +| redis_server_expire_cycle_cpu_milliseconds | The cumulative amount of time spent on active expiry cycles | +| redis_server_expired_keys | Keys expired so far since restart | +| redis_server_forwarding_state | Shard forwarding state (on or off) | +| redis_server_hashes_items_under_1M | Number of hash keys with under 1 million elements | +| redis_server_hashes_items_1M_to_8M | Number of hash keys with an element count between 1 million and 8 million | +| redis_server_hashes_items_over_8M | Number of hash keys with over 8 million elements | +| redis_server_keys_trimmed | The number of keys that were trimmed in the current or last resharding process | +| redis_server_keyspace_read_hits | Number of read operations accessing an existing keyspace | +| redis_server_keyspace_read_misses | Number of read operations accessing a non-existing keyspace | +| redis_server_keyspace_write_hits | Number of write operations accessing an existing keyspace | +| redis_server_keyspace_write_misses | Number of write operations accessing a non-existing keyspace | +| redis_server_lists_items_under_1M | Number of list keys with under 1 million elements | +| redis_server_lists_items_1M_to_8M | Number of list keys with an element count between 1 million and 8 million | +| redis_server_lists_items_over_8M | Number of list keys with over 8 million elements | +| redis_server_master_link_status | Indicates if the replica is connected to its master | +| redis_server_master_repl_offset | Number of bytes sent to replicas by the shard; calculate the throughput for a time period by comparing the value at different times | +| redis_server_master_sync_in_progress | The primary shard is synchronizing (1 true; 0 false) | +| redis_server_max_process_mem | Current memory limit configured by redis_mgr according to node free memory | +| redis_server_maxmemory | Current memory limit configured by redis_mgr according to database memory limits | +| redis_server_mem_aof_buffer | Current size of AOF buffer | +| redis_server_mem_clients_normal | Current memory used for input and output buffers of non-replica clients | +| redis_server_mem_clients_slaves | Current memory used for input and output buffers of replica clients | +| redis_server_mem_fragmentation_ratio | Memory fragmentation ratio (1.3 means 30% overhead) | +| redis_server_mem_not_counted_for_evict | Portion of used_memory (in bytes) that's not counted for eviction and OOM error | +| redis_server_mem_replication_backlog | Size of replication backlog | +| redis_server_module_fork_in_progress | A binary value that indicates if there is an active fork spawned by a module (1) or not (0) | +| namedprocess_namegroup_cpu_seconds_total | Shard process CPU usage in seconds | +| namedprocess_namegroup_thread_cpu_seconds_total | Shard main thread CPU time spent in seconds | +| namedprocess_namegroup_open_filedesc | Shard number of open file descriptors | +| namedprocess_namegroup_memory_bytes | Shard memory size in bytes | +| namedprocess_namegroup_oldest_start_time_seconds | Shard start time of the process since unix epoch in seconds | +| redis_server_rdb_bgsave_in_progress | Indication if bgsave is currently in progress | +| redis_server_rdb_last_cow_size | Last bgsave (or SYNC fork) used CopyOnWrite memory | +| redis_server_rdb_saves | Total count of bgsaves since the process was restarted (including replica fullsync and persistence) | +| redis_server_sets_items_under_1M | Number of set keys with under 1 million elements | +| redis_server_sets_items_1M_to_8M | Number of set keys with an element count between 1 million and 8 million | +| redis_server_sets_items_over_8M | Number of set keys with over 8 million elements | +| redis_server_repl_touch_bytes | Number of bytes sent to replicas as TOUCH commands by the shard as a result of a READ command that was processed; calculate the throughput for a time period by comparing the value at different times | +| redis_server_total_commands_processed | Number of commands processed by the shard; calculate the number of commands for a time period by comparing the value at different times | +| redis_server_total_connections_received | Number of connections received by the shard; calculate the number of connections for a time period by comparing the value at different times | +| redis_server_total_net_input_bytes | Number of bytes received by the shard; calculate the throughput for a time period by comparing the value at different times | +| redis_server_total_net_output_bytes | Number of bytes sent by the shard; calculate the throughput for a time period by comparing the value at different times | +| redis_server_up | Shard is up and running | +| redis_server_strings_sizes_under_128M | Number of string keys with a memory size under 128 megabytes | +| redis_server_strings_sizes_128M_to_512M | Number of string keys with a memory size between 128 and 512 megabytes | +| redis_server_strings_sizes_over_512M | Number of string keys with a memory size over 512 megabytes | +| redis_server_used_memory | Memory used by shard (in BigRedis this includes flash) (bytes) | +| redis_server_zsets_items_under_1M | Number of sorted set keys with under 1 million elements | +| redis_server_zsets_items_1M_to_8M | Number of sorted set keys with an element count between 1 million and 8 million | +| redis_server_zsets_items_over_8M | Number of sorted set keys with over 8 million elements | | redis_server_search_gc_bytes_collected | The total amount of memory freed by the garbage collectors from indexes in the shard's memory in bytes. [3](#tnote-3) | | redis_server_search_bytes_collected | The total amount of memory freed by the garbage collectors from indexes in the shard's memory in bytes. Deprecated in 8.0 (renamed redis_server_search_gc_bytes_collected), but still available in older versions. [1](#tnote-1) | | redis_server_search_gc_marked_deleted_vectors | The number of vectors marked as deleted in the vector indexes that have not yet been cleaned. [3](#tnote-3) | From 9d1e0b835b82013fc7ce44f0ccc1156a62772e0d Mon Sep 17 00:00:00 2001 From: Rachel Elledge Date: Fri, 1 Aug 2025 11:23:03 -0500 Subject: [PATCH 6/7] DOC-5527 Removed excess whitespace from index.css --- assets/css/index.css | 4 ---- 1 file changed, 4 deletions(-) diff --git a/assets/css/index.css b/assets/css/index.css index 54945ffb1..f91f8f6f3 100644 --- a/assets/css/index.css +++ b/assets/css/index.css @@ -579,10 +579,6 @@ html { scrollbar-gutter: stable; } - - - - /* Chroma syntax highlighting */ /* Background */ From 6a9df2779f7f8e87e398fa1d84c66e57c1ed518c Mon Sep 17 00:00:00 2001 From: Rachel Elledge Date: Fri, 1 Aug 2025 14:20:04 -0500 Subject: [PATCH 7/7] DOC-5527 Adjusted span tags with break-all style to improve readability of v2 metric names in tables --- content/embeds/rs-prometheus-metrics-v2.md | 146 ++++++++++----------- 1 file changed, 73 insertions(+), 73 deletions(-) diff --git a/content/embeds/rs-prometheus-metrics-v2.md b/content/embeds/rs-prometheus-metrics-v2.md index d5c85a62e..7e841ef7d 100644 --- a/content/embeds/rs-prometheus-metrics-v2.md +++ b/content/embeds/rs-prometheus-metrics-v2.md @@ -2,8 +2,8 @@ | Metric | Type | Description | | :-------- | :--- | :---------- | -| endpoint_client_connections | counter | Number of client connection establishment events | -| endpoint_client_disconnections | counter | Number of client disconnections initiated by the client | +| endpoint_client_connections | counter | Number of client connection establishment events | +| endpoint_client_disconnections | counter | Number of client disconnections initiated by the client | | endpoint_client_connection_expired | counter | Total number of client connections with expired TTL (Time To Live) | | endpoint_client_establishment_failures | counter | Number of client connections that failed to establish properly | | endpoint_client_expiration_refresh | counter | Number of expiration time changes of clients | @@ -13,51 +13,51 @@ | endpoint_disconnected_ldap_client | counter | Number of LDAP clients disconnected | | endpoint_disconnected_user_password_client | counter | Number of user&password clients disconnected | | endpoint_disposed_commands_after_client_caching | counter | Total number of client caching commands that were disposed due to misuse | -| endpoint_egress | counter | Number of egress bytes | -| endpoint_egress_pending | counter | Number of send-pending bytes | +| endpoint_egress | counter | Number of egress bytes | +| endpoint_egress_pending | counter | Number of send-pending bytes | | endpoint_egress_pending_discarded | counter | Number of send-pending bytes that were discarded due to disconnection | | endpoint_failed_cba_authentication | counter | Number of clients that failed certificate-based authentication | | endpoint_failed_ldap_authentication | counter | Number of clients that failed LDAP authentication | | endpoint_failed_user_password_authentication | counter | Number of clients that failed user password authentication | -| endpoint_ingress | counter | Number of ingress bytes | +| endpoint_ingress | counter | Number of ingress bytes | | endpoint_longest_pipeline_histogram | counter | Tracks the distribution of longest observed pipeline lengths, where a pipeline is a sequence of client commands sent without waiting for responses. | -| endpoint_other_requests | counter | Number of other requests | +| endpoint_other_requests | counter | Number of other requests | | endpoint_other_requests_latency_histogram | histogram | Latency (in µs) histogram of other commands | | endpoint_other_requests_latency_histogram_bucket | histogram | Latency histograms for commands other than read or write commands. Can be used to represent different latency percentiles.
p99.9 example:
`histogram_quantile(0.999, sum(rate(endpoint_other_requests_latency_histogram_bucket{cluster="$cluster", db="$db"}[$__rate_interval]) ) by (le, db))` | -| endpoint_other_responses | counter | Number of other responses | -| endpoint_proxy_disconnections | counter | Number of client disconnections initiated by the proxy | -| endpoint_read_requests | counter | Number of read requests | +| endpoint_other_responses | counter | Number of other responses | +| endpoint_proxy_disconnections | counter | Number of client disconnections initiated by the proxy | +| endpoint_read_requests | counter | Number of read requests | | endpoint_read_requests_latency_histogram | histogram | Latency (in µs) histogram of read commands | | endpoint_read_requests_latency_histogram_bucket | histogram | Latency histograms for read commands. Can be used to represent different latency percentiles.
p99.9 example:
`histogram_quantile(0.999, sum(rate(endpoint_read_requests_latency_histogram_bucket{cluster="$cluster", db="$db"}[$__rate_interval]) ) by (le, db))` | -| endpoint_read_responses | counter | Number of read responses | +| endpoint_read_responses | counter | Number of read responses | | endpoint_successful_cba_authentication | counter | Number of clients that successfully authenticated with certificate-based authentication | | endpoint_successful_ldap_authentication | counter | Number of clients that successfully authenticated with LDAP | | endpoint_successful_user_password_authentication | counter | Number of clients that successfully authenticated with user&password | -| endpoint_write_requests | counter | Number of write requests | +| endpoint_write_requests | counter | Number of write requests | | endpoint_write_requests_latency_histogram | histogram | Latency (in µs) histogram of write commands | | endpoint_write_requests_latency_histogram_bucket | histogram | Latency histograms for write commands. Can be used to represent different latency percentiles.
p99.9 example:
`histogram_quantile(0.999, sum(rate(endpoint_write_requests_latency_histogram_bucket{cluster="$cluster", db="$db"}[$__rate_interval]) ) by (le, db))` | -| endpoint_write_responses | counter | Number of write responses | +| endpoint_write_responses | counter | Number of write responses | ## Node metrics | Metric | Type |Description | | :-------- | :--- | :---------- | -| node_available_flash_bytes | gauge | Available flash in the node (bytes) | +| node_available_flash_bytes | gauge | Available flash in the node (bytes) | | node_available_flash_no_overbooking_bytes | gauge | Available flash in the node (bytes), without taking into account overbooking | | node_available_memory_bytes | gauge | Amount of free memory in the node (bytes) that is available for database provisioning | | node_available_memory_no_overbooking_bytes | gauge | Available RAM in the node (bytes) without taking into account overbooking | -| node_bigstore_free_bytes | gauge | Sum of free space of back-end flash (used by flash database's [BigRedis]) on all cluster nodes (bytes); returned only when BigRedis is enabled | +| node_bigstore_free_bytes | gauge | Sum of free space of back-end flash (used by flash database's [BigRedis]) on all cluster nodes (bytes); returned only when BigRedis is enabled | | node_cert_expires_in_seconds | gauge | Certificate expiration (in seconds) per given node; read more about [certificates in Redis Enterprise]({{< relref "/operate/rs/security/certificates" >}}) and [monitoring certificates]({{< relref "/operate/rs/security/certificates/monitor-certificates" >}}) | | node_ephemeral_storage_avail_bytes | gauge | Disk space available to RLEC processes on configured ephemeral disk (bytes) | | node_ephemeral_storage_free_bytes | gauge | Free disk space on configured ephemeral disk (bytes) | -| node_memory_MemFree_bytes | gauge | Free memory in the node (bytes) | +| node_memory_MemFree_bytes | gauge | Free memory in the node (bytes) | | node_persistent_storage_avail_bytes | gauge | Disk space available to RLEC processes on configured persistent disk (bytes) | | node_persistent_storage_free_bytes | gauge | Free disk space on configured persistent disk (bytes) | | node_provisional_flash_bytes | gauge | Amount of flash available for new shards on this node, taking into account overbooking, max Redis servers, reserved flash, and provision and migration thresholds (bytes) | | node_provisional_flash_no_overbooking_bytes | gauge | Amount of flash available for new shards on this node, without taking into account overbooking, max Redis servers, reserved flash, and provision and migration thresholds (bytes) | | node_provisional_memory_bytes | gauge | Amount of RAM that is available for provisioning to databases out of the total RAM allocated for databases | | node_provisional_memory_no_overbooking_bytes | gauge | Amount of RAM that is available for provisioning to databases out of the total RAM allocated for databases, without taking into account overbooking | -| node_metrics_up | gauge | Node is part of the cluster and is connected | +| node_metrics_up | gauge | Node is part of the cluster and is connected | ## Cluster metrics @@ -102,44 +102,44 @@ | Metric | Description | | :-------- | :---------- | -| redis_server_active_defrag_running | Automatic memory defragmentation current aggressiveness (% cpu) | -| redis_server_allocator_active | Total used memory, including external fragmentation | -| redis_server_allocator_allocated | Total allocated memory | -| redis_server_allocator_resident | Total resident memory (RSS) | -| redis_server_aof_last_cow_size | Last AOFR, CopyOnWrite memory | +| redis_server_active_defrag_running | Automatic memory defragmentation current aggressiveness (% cpu) | +| redis_server_allocator_active | Total used memory, including external fragmentation | +| redis_server_allocator_allocated | Total allocated memory | +| redis_server_allocator_resident | Total resident memory (RSS) | +| redis_server_aof_last_cow_size | Last AOFR, CopyOnWrite memory | | redis_server_aof_rewrite_in_progress | The number of simultaneous AOF rewrites that are in progress | -| redis_server_aof_rewrites | Number of AOF rewrites this process executed | -| redis_server_aof_delayed_fsync | Number of times an AOF fsync caused delays in the main Redis thread (inducing latency); this can indicate that the disk is slow or overloaded | -| redis_server_blocked_clients | Count the clients waiting on a blocking call | -| redis_server_connected_clients | Number of client connections to the specific shard | -| redis_server_connected_slaves | Number of connected replicas | -| redis_server_db_avg_ttl | Average TTL of all volatile keys | -| redis_server_db0_avg_ttl | Average TTL of all volatile keys. Deprecated. | -| redis_server_db_keys | Total key count. | -| redis_server_db0_keys | Total key count. Deprecated. | -| redis_server_evicted_keys | Keys evicted so far (since restart) | +| redis_server_aof_rewrites | Number of AOF rewrites this process executed | +| redis_server_aof_delayed_fsync | Number of times an AOF fsync caused delays in the main Redis thread (inducing latency); this can indicate that the disk is slow or overloaded | +| redis_server_blocked_clients | Count the clients waiting on a blocking call | +| redis_server_connected_clients | Number of client connections to the specific shard | +| redis_server_connected_slaves | Number of connected replicas | +| redis_server_db_avg_ttl | Average TTL of all volatile keys | +| redis_server_db0_avg_ttl | Average TTL of all volatile keys. Deprecated. | +| redis_server_db_keys | Total key count. | +| redis_server_db0_keys | Total key count. Deprecated. | +| redis_server_evicted_keys | Keys evicted so far (since restart) | | redis_server_expire_cycle_cpu_milliseconds | The cumulative amount of time spent on active expiry cycles | -| redis_server_expired_keys | Keys expired so far since restart | -| redis_server_forwarding_state | Shard forwarding state (on or off) | -| redis_server_hashes_items_under_1M | Number of hash keys with under 1 million elements | -| redis_server_hashes_items_1M_to_8M | Number of hash keys with an element count between 1 million and 8 million | -| redis_server_hashes_items_over_8M | Number of hash keys with over 8 million elements | -| redis_server_keys_trimmed | The number of keys that were trimmed in the current or last resharding process | -| redis_server_keyspace_read_hits | Number of read operations accessing an existing keyspace | -| redis_server_keyspace_read_misses | Number of read operations accessing a non-existing keyspace | -| redis_server_keyspace_write_hits | Number of write operations accessing an existing keyspace | +| redis_server_expired_keys | Keys expired so far since restart | +| redis_server_forwarding_state | Shard forwarding state (on or off) | +| redis_server_hashes_items_under_1M | Number of hash keys with under 1 million elements | +| redis_server_hashes_items_1M_to_8M | Number of hash keys with an element count between 1 million and 8 million | +| redis_server_hashes_items_over_8M | Number of hash keys with over 8 million elements | +| redis_server_keys_trimmed | The number of keys that were trimmed in the current or last resharding process | +| redis_server_keyspace_read_hits | Number of read operations accessing an existing keyspace | +| redis_server_keyspace_read_misses | Number of read operations accessing a non-existing keyspace | +| redis_server_keyspace_write_hits | Number of write operations accessing an existing keyspace | | redis_server_keyspace_write_misses | Number of write operations accessing a non-existing keyspace | -| redis_server_lists_items_under_1M | Number of list keys with under 1 million elements | -| redis_server_lists_items_1M_to_8M | Number of list keys with an element count between 1 million and 8 million | -| redis_server_lists_items_over_8M | Number of list keys with over 8 million elements | -| redis_server_master_link_status | Indicates if the replica is connected to its master | -| redis_server_master_repl_offset | Number of bytes sent to replicas by the shard; calculate the throughput for a time period by comparing the value at different times | +| redis_server_lists_items_under_1M | Number of list keys with under 1 million elements | +| redis_server_lists_items_1M_to_8M | Number of list keys with an element count between 1 million and 8 million | +| redis_server_lists_items_over_8M | Number of list keys with over 8 million elements | +| redis_server_master_link_status | Indicates if the replica is connected to its master | +| redis_server_master_repl_offset | Number of bytes sent to replicas by the shard; calculate the throughput for a time period by comparing the value at different times | | redis_server_master_sync_in_progress | The primary shard is synchronizing (1 true; 0 false) | -| redis_server_max_process_mem | Current memory limit configured by redis_mgr according to node free memory | -| redis_server_maxmemory | Current memory limit configured by redis_mgr according to database memory limits | -| redis_server_mem_aof_buffer | Current size of AOF buffer | -| redis_server_mem_clients_normal | Current memory used for input and output buffers of non-replica clients | -| redis_server_mem_clients_slaves | Current memory used for input and output buffers of replica clients | +| redis_server_max_process_mem | Current memory limit configured by redis_mgr according to node free memory | +| redis_server_maxmemory | Current memory limit configured by redis_mgr according to database memory limits | +| redis_server_mem_aof_buffer | Current size of AOF buffer | +| redis_server_mem_clients_normal | Current memory used for input and output buffers of non-replica clients | +| redis_server_mem_clients_slaves | Current memory used for input and output buffers of replica clients | | redis_server_mem_fragmentation_ratio | Memory fragmentation ratio (1.3 means 30% overhead) | | redis_server_mem_not_counted_for_evict | Portion of used_memory (in bytes) that's not counted for eviction and OOM error | | redis_server_mem_replication_backlog | Size of replication backlog | @@ -150,40 +150,40 @@ | namedprocess_namegroup_memory_bytes | Shard memory size in bytes | | namedprocess_namegroup_oldest_start_time_seconds | Shard start time of the process since unix epoch in seconds | | redis_server_rdb_bgsave_in_progress | Indication if bgsave is currently in progress | -| redis_server_rdb_last_cow_size | Last bgsave (or SYNC fork) used CopyOnWrite memory | -| redis_server_rdb_saves | Total count of bgsaves since the process was restarted (including replica fullsync and persistence) | -| redis_server_sets_items_under_1M | Number of set keys with under 1 million elements | -| redis_server_sets_items_1M_to_8M | Number of set keys with an element count between 1 million and 8 million | -| redis_server_sets_items_over_8M | Number of set keys with over 8 million elements | -| redis_server_repl_touch_bytes | Number of bytes sent to replicas as TOUCH commands by the shard as a result of a READ command that was processed; calculate the throughput for a time period by comparing the value at different times | +| redis_server_rdb_last_cow_size | Last bgsave (or SYNC fork) used CopyOnWrite memory | +| redis_server_rdb_saves | Total count of bgsaves since the process was restarted (including replica fullsync and persistence) | +| redis_server_sets_items_under_1M | Number of set keys with under 1 million elements | +| redis_server_sets_items_1M_to_8M | Number of set keys with an element count between 1 million and 8 million | +| redis_server_sets_items_over_8M | Number of set keys with over 8 million elements | +| redis_server_repl_touch_bytes | Number of bytes sent to replicas as TOUCH commands by the shard as a result of a READ command that was processed; calculate the throughput for a time period by comparing the value at different times | | redis_server_total_commands_processed | Number of commands processed by the shard; calculate the number of commands for a time period by comparing the value at different times | | redis_server_total_connections_received | Number of connections received by the shard; calculate the number of connections for a time period by comparing the value at different times | -| redis_server_total_net_input_bytes | Number of bytes received by the shard; calculate the throughput for a time period by comparing the value at different times | +| redis_server_total_net_input_bytes | Number of bytes received by the shard; calculate the throughput for a time period by comparing the value at different times | | redis_server_total_net_output_bytes | Number of bytes sent by the shard; calculate the throughput for a time period by comparing the value at different times | -| redis_server_up | Shard is up and running | +| redis_server_up | Shard is up and running | | redis_server_strings_sizes_under_128M | Number of string keys with a memory size under 128 megabytes | | redis_server_strings_sizes_128M_to_512M | Number of string keys with a memory size between 128 and 512 megabytes | | redis_server_strings_sizes_over_512M | Number of string keys with a memory size over 512 megabytes | -| redis_server_used_memory | Memory used by shard (in BigRedis this includes flash) (bytes) | -| redis_server_zsets_items_under_1M | Number of sorted set keys with under 1 million elements | -| redis_server_zsets_items_1M_to_8M | Number of sorted set keys with an element count between 1 million and 8 million | -| redis_server_zsets_items_over_8M | Number of sorted set keys with over 8 million elements | +| redis_server_used_memory | Memory used by shard (in BigRedis this includes flash) (bytes) | +| redis_server_zsets_items_under_1M | Number of sorted set keys with under 1 million elements | +| redis_server_zsets_items_1M_to_8M | Number of sorted set keys with an element count between 1 million and 8 million | +| redis_server_zsets_items_over_8M | Number of sorted set keys with over 8 million elements | | redis_server_search_gc_bytes_collected | The total amount of memory freed by the garbage collectors from indexes in the shard's memory in bytes. [3](#tnote-3) | -| redis_server_search_bytes_collected | The total amount of memory freed by the garbage collectors from indexes in the shard's memory in bytes. Deprecated in 8.0 (renamed redis_server_search_gc_bytes_collected), but still available in older versions. [1](#tnote-1) | +| redis_server_search_bytes_collected | The total amount of memory freed by the garbage collectors from indexes in the shard's memory in bytes. Deprecated in 8.0 (renamed redis_server_search_gc_bytes_collected), but still available in older versions. [1](#tnote-1) | | redis_server_search_gc_marked_deleted_vectors | The number of vectors marked as deleted in the vector indexes that have not yet been cleaned. [3](#tnote-3) | -| redis_server_search_marked_deleted_vectors | The number of vectors marked as deleted in the vector indexes that have not yet been cleaned. Deprecated in 8.0 (renamed redis_server_search_gc_marked_deleted_vectors), but still available in older versions. [1](#tnote-1) | +| redis_server_search_marked_deleted_vectors | The number of vectors marked as deleted in the vector indexes that have not yet been cleaned. Deprecated in 8.0 (renamed redis_server_search_gc_marked_deleted_vectors), but still available in older versions. [1](#tnote-1) | | redis_server_search_gc_total_cycles | The total number of garbage collection cycles executed. [3](#tnote-3) | -| redis_server_search_total_cycles | The total number of garbage collection cycles executed. Deprecated in 8.0 (renamed redis_server_search_gc_total_cycles), but still available in older versions. [1](#tnote-1) | +| redis_server_search_total_cycles | The total number of garbage collection cycles executed. Deprecated in 8.0 (renamed redis_server_search_gc_total_cycles), but still available in older versions. [1](#tnote-1) | | redis_server_search_gc_total_docs_not_collected_by_gc | The number of documents marked as deleted, whose memory has not yet been freed by the garbage collector. [3](#tnote-3) | -| redis_server_search_total_docs_not_collected_by_gc | The number of documents marked as deleted, whose memory has not yet been freed by the garbage collector. Deprecated in 8.0 (renamed redis_server_search_gc_total_docs_not_collected_by_gc), but still available in older versions. [1](#tnote-1) | +| redis_server_search_total_docs_not_collected_by_gc | The number of documents marked as deleted, whose memory has not yet been freed by the garbage collector. Deprecated in 8.0 (renamed redis_server_search_gc_total_docs_not_collected_by_gc), but still available in older versions. [1](#tnote-1) | | redis_server_search_gc_total_ms_run | The total duration of all garbage collection cycles in the shard, measured in milliseconds. [3](#tnote-3) | -| redis_server_search_total_ms_run | The total duration of all garbage collection cycles in the shard, measured in milliseconds. Deprecated in 8.0 (renamed redis_server_search_gc_total_ms_run), but still available in older versions. [1](#tnote-1) | +| redis_server_search_total_ms_run | The total duration of all garbage collection cycles in the shard, measured in milliseconds. Deprecated in 8.0 (renamed redis_server_search_gc_total_ms_run), but still available in older versions. [1](#tnote-1) | | redis_server_search_cursors_internal_idle | The total number of coordinator cursors that are currently holding pending results in the shard. [3](#tnote-3) | | redis_server_search_cursors_user_idle | The total number of cursors that were explicitly requested by users, that are currently holding pending results in the shard. [3](#tnote-3) | -| redis_server_search_global_idle | The total number of user and internal cursors currently holding pending results in the shard. Deprecated in 8.0 (split into redis_server_search_cursors_internal_idle and redis_server_search_cursors_user_idle), but still available in older versions. [1](#tnote-1) | +| redis_server_search_global_idle | The total number of user and internal cursors currently holding pending results in the shard. Deprecated in 8.0 (split into redis_server_search_cursors_internal_idle and redis_server_search_cursors_user_idle), but still available in older versions. [1](#tnote-1) | | redis_server_search_cursors_internal_active | The total number of coordinator cursors in the shard, either holding pending results or actively executing `FT.CURSOR READ`. [3](#tnote-3) | | redis_server_search_cursors_user_active | The total number of user cursors in the shard, either holding pending results or actively executing `FT.CURSOR READ`. [3](#tnote-3) | -| redis_server_search_global_total | The total number of user and internal cursors in the shard, either holding pending results or actively executing `FT.CURSOR READ`. Deprecated in 8.0 (split into redis_server_search_cursors_internal_active and redis_server_search_cursors_user_active), but still available in older versions. [1](#tnote-1) | +| redis_server_search_global_total | The total number of user and internal cursors in the shard, either holding pending results or actively executing `FT.CURSOR READ`. Deprecated in 8.0 (split into redis_server_search_cursors_internal_active and redis_server_search_cursors_user_active), but still available in older versions. [1](#tnote-1) | | redis_server_search_number_of_indexes | Total number of indexes in the shard [1](#tnote-1) | | redis_server_search_number_of_active_indexes | The total number of indexes running a background indexing and/or background query processing operation. Background indexing refers to vector ingestion process, or in-progress background indexer. [1](#tnote-1) | | redis_server_search_number_of_active_indexes_running_queries | Total count of indexes currently running a background query process. [1](#tnote-1) | @@ -214,11 +214,11 @@ | redis_server_search_largest_memory_index | The memory usage of the index with the largest memory usage in the shard in bytes. [1](#tnote-1) | | redis_server_search_total_indexing_time | The total time spent on indexing operations, excluding the background indexing of vectors in the `HNSW` graph. [1](#tnote-1) | | redis_server_search_used_memory_vector_index | The total memory usage of all vector indexes in the shard. [1](#tnote-1) | -| redis_server_search_global_idle | The total number of user and internal cursors currently holding pending results in the shard. [1](#tnote-1) | -| redis_server_search_global_total | The total number of user and internal cursors in the shard, either holding pending results or actively executing `FT.CURSOR READ`. [1](#tnote-1) | +| redis_server_search_global_idle | The total number of user and internal cursors currently holding pending results in the shard. [1](#tnote-1) | +| redis_server_search_global_total | The total number of user and internal cursors in the shard, either holding pending results or actively executing `FT.CURSOR READ`. [1](#tnote-1) | | redis_server_search_bytes_collected | The total amount of memory freed by the garbage collectors from indexes in the shard memory in bytes. [1](#tnote-1) | -| redis_server_search_total_cycles | The total number of garbage collection cycles executed [1](#tnote-1) | -| redis_server_search_total_ms_run | The total duration of all garbage collection cycles in the shard, measured in milliseconds. [1](#tnote-1) | +| redis_server_search_total_cycles | The total number of garbage collection cycles executed [1](#tnote-1) | +| redis_server_search_total_ms_run | The total duration of all garbage collection cycles in the shard, measured in milliseconds. [1](#tnote-1) | | redis_server_search_total_docs_not_collected_by_gc | The number of documents marked as deleted whose memory has not yet been freed by the garbage collector. [1](#tnote-1) | | redis_server_search_marked_deleted_vectors | The number of vectors marked as deleted in the vector indexes that have not yet been cleaned. [1](#tnote-1) | | redis_server_search_total_queries_processed | The total number of successful query executions (When using cursors, not counting reading from existing cursors) in the shard. [1](#tnote-1) |