diff --git a/content/commands/info/index.md b/content/commands/info/index.md index e62d2b7f50..09f1737937 100644 --- a/content/commands/info/index.md +++ b/content/commands/info/index.md @@ -507,6 +507,23 @@ The **modules** section contains additional information about loaded modules if **RediSearch fields** +* `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) +* `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 `search_gc_bytes_collected`), but still available in older versions. [1](#tnote-1) +* `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) +* `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 `search_gc_marked_delete_vectors`), but still available in older versions. [1](#tnote-1) +* `search_gc_total_cycles`: The total number of garbage collection cycles executed. [3](#tnote-3) +* `search_total_cycles`: The total number of garbage collection cycles executed. Deprecated in 8.0 (renamed `search_gc_total_cycles`), but still available in older versions. [1](#tnote-1) +* `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) +* `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 `search_gc_total_docs_not_collected`), but still available in older versions. [1](#tnote-1) +* `search_gc_total_ms_run`: The total duration of all garbage collection cycles in the shard, measured in milliseconds. [3](#tnote-3) +* `search_total_ms_run`: The total duration of all garbage collection cycles in the shard, measured in milliseconds. Deprecated in 8.0 (renamed `search_gc_total_ms_run`), but still available in older versions. [1](#tnote-1) + +* `search_cursors_internal_idle`: The total number of coordinator cursors that are currently holding pending results in the shard. [3](#tnote-3) +* `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) +* `search_global_idle`: The total number of user and internal cursors currently holding pending results in the shard.. Deprecated in 8.0 (split into `search_cursors_internal_idle` and `search_cursors_user_idle`) but still available in older versions. [1](#tnote-1) +* `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) +* `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) +* `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 `search_cursors_internal_active` and `search_cursors_user_active`), but still available in older versions. [1](#tnote-1) * `search_number_of_indexes`: The total number of indexes in the shard. [1](#tnote-1) * `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) * `search_number_of_active_indexes_running_queries`: The total count of indexes currently running a background query process. [1](#tnote-1) @@ -540,8 +557,6 @@ The **modules** section contains additional information about loaded modules if * `search_largest_memory_index_human`: The memory usage of the index with the largest memory usage in the shard in MB. [1](#tnote-1) * `search_total_indexing_time`: The total time spent on indexing operations, excluding the background indexing of vectors in the HNSW graph. [1](#tnote-1) * `search_used_memory_vector_index`: The total memory usage of all vector indexes in the shard. [1](#tnote-1) -* `search_global_idle`: The total number of user and internal cursors currently holding pending results in the shard. [1](#tnote-1) -* `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) * `search_bytes_collected`: The total amount of memory freed by the garbage collectors from indexes in the shard memory in bytes. [1](#tnote-1) * `search_total_cycles`: The total number of garbage collection cycles executed. [1](#tnote-1) * `search_total_ms_run`: The total duration of all garbage collection cycles in the shard, measured in milliseconds. [1](#tnote-1) @@ -556,6 +571,7 @@ The **modules** section contains additional information about loaded modules if 1. Available in RediSearch 2.6. 2. Available in RediSearch 2.8. +3. Available in RediSearch 8.0. The **keyspace** section provides statistics on the main dictionary of each database. The statistics are the number of keys, and the number of keys with an expiration. diff --git a/content/integrate/prometheus-with-redis-enterprise/prometheus-metrics-definitions.md b/content/integrate/prometheus-with-redis-enterprise/prometheus-metrics-definitions.md index bcb3312d0f..dfc1aa5058 100644 --- a/content/integrate/prometheus-with-redis-enterprise/prometheus-metrics-definitions.md +++ b/content/integrate/prometheus-with-redis-enterprise/prometheus-metrics-definitions.md @@ -174,6 +174,22 @@ The v2 metrics in the following tables are available as of Redis Enterprise Soft | 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_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) | +| 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_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_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_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_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_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) | @@ -219,4 +235,5 @@ The v2 metrics in the following tables are available as of Redis Enterprise Soft | redis_server_search_errors_for_index_with_max_failures | The number of indexing failures in the index with the highest count of failures. [1](#tnote-1) | 1. Available since RediSearch 2.6. -2. Available since RediSearch 2.8. \ No newline at end of file +2. Available since RediSearch 2.8. +3. Available since RediSearch 8.0. \ No newline at end of file