Prometheus metrics v2 preview
V2 metrics available to Prometheus as of Redis Enterprise Software version 7.8.2.
You can integrate Redis Enterprise Software with Prometheus and Grafana to create dashboards for important metrics.
The v2 metrics in the following tables are available as of Redis Enterprise Software version 7.8.0. For help transitioning from v1 metrics to v2 PromQL, see Prometheus v1 metrics and equivalent v2 PromQL.
The v2 scraping endpoint also exposes metrics for node_exporter version 1.8.1. For more information, see the Prometheus node_exporter GitHub repository.
Database metrics
| 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_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 |
| endpoint_client_tracking_off_requests | counter | Total number of CLIENT TRACKING OFF requests |
| endpoint_client_tracking_on_requests | counter | Total number of CLIENT TRACKING ON requests |
| endpoint_disconnected_cba_client | counter | Number of certificate-based clients disconnected |
| 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_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_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_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_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_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_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 |
Node metrics
| Metric | Type | Description |
|---|---|---|
| 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_cert_expires_in_seconds | gauge | Certificate expiration (in seconds) per given node; read more about certificates in Redis Enterprise and monitoring 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_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 |
Cluster metrics
| Metric | Type | Description |
|---|---|---|
| generation{cluster_wd=<node_uid>} | gauge | Generation number of the specific cluster_wd |
| has_qourum{cluster_wd=<node_uid>, has_witness_disk=BOOL} | gauge | Has_qourum = 1 No quorum = 0 |
| is_primary{cluster_wd=<node_uid>} | gauge | primary = 1 secondary = 0 |
| license_shards_limit | gauge | Total shard limit by the license by shard type (ram / flash) |
| total_live_nodes_count{cluster_wd=<node_uid>} | gauge | Number of live nodes |
| total_node_count{cluster_wd=<node_uid>} | gauge | Number of nodes |
| total_primary_selection_ended{cluster_wd=<node_uid>} | counter | Monotonic counter for each selection process that ended |
| total_primary_selections{cluster_wd=<node_uid>} | counter | Monotonic counter for each selection process that started |
Replication metrics
| Metric | Type | Description |
|---|---|---|
| database_syncer_config | gauge | Used as a placeholder for configuration labels |
| database_syncer_current_status | gauge | Syncer status for traffic; 0 = in-sync, 2 = out of sync |
| database_syncer_dst_connectivity_state | gauge | Destination connectivity state |
| database_syncer_dst_connectivity_state_ms | gauge | Destination connectivity state duration |
| database_syncer_dst_lag | gauge | Lag in milliseconds between the syncer and the destination |
| database_syncer_dst_repl_offset | gauge | Offset of the last command acknowledged |
| database_syncer_flush_counter | gauge | Number of destination flushes |
| database_syncer_ingress_bytes | gauge | Number of bytes read from source shard |
| database_syncer_ingress_bytes_decompressed | gauge | Number of bytes read from source shard |
| database_syncer_internal_state | gauge | Internal state of the syncer |
| database_syncer_lag_ms | gauge | Lag time between the source and the destination for traffic in milliseconds |
| database_syncer_rdb_size | gauge | The source's RDB size in bytes to be transferred during the syncing phase |
| database_syncer_rdb_transferred | gauge | Number of bytes transferred from the source's RDB during the syncing phase |
| database_syncer_src_connectivity_state | gauge | Source connectivity state |
| database_syncer_src_connectivity_state_ms | gauge | Source connectivity state duration |
| database_syncer_src_repl_offset | gauge | Last known source offset |
| database_syncer_state | gauge | Internal state of the shard syncer |
| database_syncer_syncer_repl_offset | gauge | Offset of the last command handled by the syncer |
| database_syncer_total_requests | gauge | Number of destination writes |
| database_syncer_total_responses | gauge | Number of destination writes acknowledged |
Shard metrics
| 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_db0_avg_ttl | Average TTL of all volatile keys |
| redis_server_expired_keys | Total count of volatile keys |
| redis_server_db0_keys | Total key count |
| 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_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_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_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_used_memory | Memory used by shard (in BigRedis this includes flash) (bytes) |
| redis_server_search_number_of_indexes | Total number of indexes in the shard 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 |
| redis_server_search_number_of_active_indexes_running_queries | Total count of indexes currently running a background query process. 1 |
| redis_server_search_number_of_active_indexes_indexing | Total count of indexes currently undergoing a background indexing process. Background indexing refers to vector ingestion process, or in-progress background indexer. This metric is limited by the number of WORKER threads allocated for writing operations + the number of indexes. 1 |
| redis_server_search_total_active_write_threads | Total count of background write (indexing) processes currently running in the shard. Background indexing refers to vector ingestion process, or in-progress background indexer. This metric is limited by the number of threads allocated for writing operations. 1 |
| redis_server_search_fields_text_Text | The total number of TEXT fields across all indexes in the shard. 1 |
| redis_server_search_fields_text_Sortable | The total number of SORTABLE TEXT fields across all indexes in the shard. This field appears only if its value is larger than 0. 1 |
| redis_server_search_fields_text_NoIndex | The total number of NOINDEX TEXT fields across all indexes in the shard; i.e., used for sorting only but not indexed. This field appears only if its value is larger than 0. 1 |
| redis_server_search_fields_numeric_Numeric | The total number of NUMERIC fields across all indexes in the shard. 1 |
| redis_server_search_fields_numeric_Sortable | The total number of SORTABLE NUMERIC fields across all indexes in the shard. This field appears only if its value is larger than 0. 1 |
| redis_server_search_fields_numeric_NoIndex | The total number of NOINDEX NUMERIC fields across all indexes in the shard, which are used for sorting only but not indexed. This field appears only if its value is larger than 0. 1 |
| redis_server_search_fields_tag_Tag | The total number of TAG fields across all indexes in the shard. 1 |
| redis_server_search_fields_tag_Sortable | The total number of SORTABLE TAG fields across all indexes in the shard. This field appears only if its value is larger than 0. 1 |
| redis_server_search_fields_tag_NoIndex | The total number of NOINDEX TAG fields across all indexes in the shard; i.e., used for sorting only but not indexed. This field appears only if its value is larger than 0. 1 |
| redis_server_search_fields_tag_CaseSensitive | The total number of CASESENSITIVE TAG fields across all indexes in the shard. This field appears only if its value is larger than 0. 1 |
| redis_server_search_fields_geo_Geo | The total number of GEO fields across all indexes in the shard. 1 |
| redis_server_search_fields_geo_Sortable | The total number of SORTABLE GEO fields across all indexes in the shard. This field appears only if its value is larger than 0. 1 |
| redis_server_search_fields_geo_NoIndex | The total number of NOINDEX GEO fields across all indexes in the shard; i.e., used for sorting only but not indexed. This field appears only if its value is larger than 0. 1 |
| redis_server_search_fields_vector_Vector | The total number of VECTOR fields across all indexes in the shard. 1 |
| redis_server_search_fields_vector_Flat | The total number of FLAT VECTOR fields across all indexes in the shard. 1 |
| redis_server_search_fields_vector_HNSW | The total number of HNSW VECTOR fields across all indexes in the shard. 1 |
| redis_server_search_fields_geoshape_Geoshape | The total number of GEOSHAPE fields across all indexes in the shard. 2 |
| redis_server_search_fields_geoshape_Sortable | The total number of SORTABLE GEOSHAPE fields across all indexes in the shard. This field appears only if its value is larger than 0. 2 |
| redis_server_search_fields_geoshape_NoIndex | The total number of NOINDEX GEOSHAPE fields across all indexes in the shard; i.e., used for sorting only but not indexed. This field appears only if its value is larger than 0. 2 |
| redis_server_search_fields_ |
The total number of indexing failures caused by attempts to index a document containing <field> field. 1 |
| redis_server_search_used_memory_indexes | The total memory allocated by all indexes in the shard in bytes. 1 |
| redis_server_search_smallest_memory_index | The memory usage of the index with the smallest memory usage in the shard in bytes. 1 |
| redis_server_search_largest_memory_index | The memory usage of the index with the largest memory usage in the shard in bytes. 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 |
| redis_server_search_used_memory_vector_index | The total memory usage of all vector indexes in the shard. 1 |
| redis_server_search_global_idle | The total number of user and internal cursors currently holding pending results in the shard. 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 |
| redis_server_search_bytes_collected | The total amount of memory freed by the garbage collectors from indexes in the shard memory in bytes. 1 |
| redis_server_search_total_cycles | The total number of garbage collection cycles executed 1 |
| redis_server_search_total_ms_run | The total duration of all garbage collection cycles in the shard, measured in milliseconds. 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 |
| redis_server_search_marked_deleted_vectors | The number of vectors marked as deleted in the vector indexes that have not yet been cleaned. 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 |
| redis_server_search_total_query_commands | The total number of successful query command executions (including FT.SEARCH, FT.AGGREGATE, and FT.CURSOR READ). 1 |
| redis_server_search_total_query_execution_time_ms | The cumulative execution time of all query commands, including FT.SEARCH, FT.AGGREGATE, and FT.CURSOR READ, measured in ms. 1 |
| redis_server_search_total_active_queries | The total number of background queries currently being executed in the shard, excluding FT.CURSOR READ. 1 |
| redis_server_search_errors_indexing_failures | The total number of indexing failures recorded across all indexes in the shard. 1 |
| redis_server_search_errors_for_index_with_max_failures | The number of indexing failures in the index with the highest count of failures. 1 |