diff --git a/content/embeds/rs-prometheus-metrics-v2.md b/content/embeds/rs-prometheus-metrics-v2.md index fcf24aa3c..2b9dc5fe0 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,30 +13,30 @@ | 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 | | proxy_connections_rate | gauge | The rate of incoming connections. Computed as `n_accepted / N` for the last interval where `n_accepted` is the number of accepted connections in this interval, and `N` is the interval in seconds. | | proxy_rate_limit_ok | gauge | Rate limit status based on the last 2 intervals.
0 = rate limit was recently exceeded
1 = rate limit was not recently exceeded | | proxy_rate_limit_overflows | counter | Total number of rate limit overflows | @@ -45,22 +45,22 @@ | 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 @@ -105,44 +105,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 | @@ -153,40 +153,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) | @@ -217,11 +217,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) |