diff --git a/content/embeds/rs-prometheus-metrics-v2.md b/content/embeds/rs-prometheus-metrics-v2.md index a705a173a8..a800d7ce0e 100644 --- a/content/embeds/rs-prometheus-metrics-v2.md +++ b/content/embeds/rs-prometheus-metrics-v2.md @@ -176,47 +176,61 @@ | 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_gc_bytes_collected | The total amount of memory freed by the garbage collectors from indexes in the shard's memory in bytes. [4](#tnote-4) | | 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_gc_marked_deleted_vectors | The number of vectors marked as deleted in the vector indexes that have not yet been cleaned. [4](#tnote-4) | | 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_gc_total_cycles | The total number of garbage collection cycles executed. [4](#tnote-4) | | 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_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. [4](#tnote-4) | | 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_gc_total_ms_run | The total duration of all garbage collection cycles in the shard, measured in milliseconds. [4](#tnote-4) | | 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_cursors_internal_idle | The total number of coordinator cursors that are currently holding pending results in the shard. [4](#tnote-4) | +| 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. [4](#tnote-4) | | 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_cursors_internal_active | The total number of coordinator cursors in the shard, either holding pending results or actively executing `FT.CURSOR READ`. [4](#tnote-4) | +| 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`. [4](#tnote-4) | | 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_total_num_docs_in_indexes | The total number of documents currently indexed across all indexes in the shard. [2](#tnote-2) | | redis_server_search_number_of_active_indexes_running_queries | Total count of indexes currently running a background query process. [1](#tnote-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](#tnote-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](#tnote-1) | -| redis_server_search_fields_text_Text | The total number of `TEXT` fields across all indexes in the shard. [1](#tnote-1) | +| redis_server_search_fields_text_Text | The total number of `TEXT` fields across all indexes in the shard. This field appears only if its value is larger than 0. [1](#tnote-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](#tnote-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](#tnote-1) | -| redis_server_search_fields_numeric_Numeric | The total number of `NUMERIC` fields across all indexes in the shard. [1](#tnote-1) | +| redis_server_search_fields_text_IndexErrors | The total number of indexing failures caused by attempts to index a document containing a `TEXT` field. This field appears only if `TEXT` fields exist. [1](#tnote-1) | +| redis_server_search_fields_numeric_Numeric | The total number of `NUMERIC` fields across all indexes in the shard. This field appears only if its value is larger than 0. [1](#tnote-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](#tnote-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](#tnote-1) | -| redis_server_search_fields_tag_Tag | The total number of `TAG` fields across all indexes in the shard. [1](#tnote-1) | +| redis_server_search_fields_numeric_IndexErrors | The total number of indexing failures caused by attempts to index a document containing a `NUMERIC` field. This field appears only if `NUMERIC` fields exist. [1](#tnote-1) | +| redis_server_search_fields_tag_Tag | The total number of `TAG` fields across all indexes in the shard. This field appears only if its value is larger than 0. [1](#tnote-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](#tnote-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](#tnote-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](#tnote-1) | -| redis_server_search_fields_geo_Geo | The total number of `GEO` fields across all indexes in the shard. [1](#tnote-1) | +| redis_server_search_fields_tag_IndexErrors | The total number of indexing failures caused by attempts to index a document containing a `TAG` field. This field appears only if `TAG` fields exist. [1](#tnote-1) | +| redis_server_search_fields_geo_Geo | The total number of `GEO` fields across all indexes in the shard. This field appears only if its value is larger than 0. [1](#tnote-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](#tnote-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](#tnote-1) | -| redis_server_search_fields_vector_Vector | The total number of `VECTOR` fields across all indexes in the shard. [1](#tnote-1) | -| redis_server_search_fields_vector_Flat | The total number of `FLAT VECTOR` fields across all indexes in the shard. [1](#tnote-1) | -| redis_server_search_fields_vector_HNSW | The total number of `HNSW VECTOR` fields across all indexes in the shard. [1](#tnote-1) | -| redis_server_search_fields_geoshape_Geoshape | The total number of `GEOSHAPE` fields across all indexes in the shard. [2](#tnote-2) | +| redis_server_search_fields_geo_IndexErrors | The total number of indexing failures caused by attempts to index a document containing a `GEO` field. This field appears only if `GEO` fields exist. [1](#tnote-1) | +| redis_server_search_fields_vector_Vector | The total number of `VECTOR` fields across all indexes in the shard. This field appears only if its value is larger than 0. [1](#tnote-1) | +| redis_server_search_fields_vector_Flat | The total number of `FLAT VECTOR` fields across all indexes in the shard. This field appears only if its value is larger than 0. [1](#tnote-1) | +| redis_server_search_fields_vector_HNSW | The total number of `HNSW VECTOR` fields across all indexes in the shard. This field appears only if its value is larger than 0. [1](#tnote-1) | +| redis_server_search_fields_vector_SVS_VAMANA | The total number of `SVS-VAMANA VECTOR` fields across all indexes in the shard. This field appears only if its value is larger than 0. [4](#tnote-4) | +| redis_server_search_fields_vector_SVS_VAMANA_Compressed | The total number of `SVS-VAMANA VECTOR` fields with `COMPRESSION` enabled (e.g., `LVQ8`) across all indexes in the shard. This field appears only if its value is larger than 0. [4](#tnote-4) | +| redis_server_search_fields_vector_IndexErrors | The total number of indexing failures caused by attempts to index a document containing a `VECTOR` field. This field appears only if `VECTOR` fields exist. [1](#tnote-1) | +| redis_server_search_fields_geoshape_Geoshape | The total number of `GEOSHAPE` fields across all indexes in the shard. This field appears only if its value is larger than 0. [2](#tnote-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](#tnote-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](#tnote-2) | -| redis_server_search_fields__IndexErrors | The total number of indexing failures caused by attempts to index a document containing `` field. [1](#tnote-1) | +| redis_server_search_fields_geoshape_IndexErrors | The total number of indexing failures caused by attempts to index a document containing a `GEOSHAPE` field. This field appears only if `GEOSHAPE` fields exist. [2](#tnote-2) | +| redis_server_search_total_indexing_ops_text_fields | The total number of indexing operations performed on `TEXT` fields across all indexes in the shard. [2](#tnote-2) | +| redis_server_search_total_indexing_ops_tag_fields | The total number of indexing operations performed on `TAG` fields across all indexes in the shard. [2](#tnote-2) | +| redis_server_search_total_indexing_ops_numeric_fields | The total number of indexing operations performed on `NUMERIC` fields across all indexes in the shard. [2](#tnote-2) | +| redis_server_search_total_indexing_ops_geo_fields | The total number of indexing operations performed on `GEO` fields across all indexes in the shard. [2](#tnote-2) | +| redis_server_search_total_indexing_ops_geoshape_fields | The total number of indexing operations performed on `GEOSHAPE` fields across all indexes in the shard. [2](#tnote-2) | +| redis_server_search_total_indexing_ops_vector_fields | The total number of indexing operations performed on `VECTOR` fields across all indexes in the shard. [2](#tnote-2) | | redis_server_search_used_memory_indexes | The total memory allocated by all indexes in the shard in bytes. [1](#tnote-1) | | redis_server_search_smallest_memory_index | The memory usage of the index with the smallest memory usage in the shard in bytes. [1](#tnote-1) | | 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) | @@ -235,7 +249,31 @@ | redis_server_search_total_active_queries | The total number of background queries currently being executed in the shard, excluding `FT.CURSOR READ`. [1](#tnote-1) | | redis_server_search_errors_indexing_failures | The total number of indexing failures recorded across all indexes in the shard. [1](#tnote-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](#tnote-1) | +| redis_server_search_OOM_indexing_failures_indexes_count | The count of indexes that experienced out-of-memory (OOM) failures during background indexing. [2](#tnote-2) | +| redis_server_search_shard_total_query_errors_syntax | The total number of query syntax errors occurred in the shard. [2](#tnote-2) | +| redis_server_search_shard_total_query_errors_arguments | The total number of queries in the shard that failed due to missing or invalid arguments. [2](#tnote-2) | +| redis_server_search_shard_total_query_errors_timeout | The total number of query timeout errors occurred in the shard (when timeout policy is 'fail'). [2](#tnote-2) | +| redis_server_search_shard_total_query_warnings_timeout | The total number of query timeout warnings occurred in the shard (when timeout policy is 'return partial results'). [2](#tnote-2) | +| redis_server_search_shard_total_query_errors_oom | The total number of query out-of-memory errors occurred in the shard. [4](#tnote-4) | +| redis_server_search_shard_total_query_warnings_oom | The total number of query out-of-memory warnings occurred in the shard. [4](#tnote-4) | +| redis_server_search_shard_total_query_warnings_max_prefix_expansions | The total number of max prefix expansion warnings occurred in the shard. [2](#tnote-2) | +| redis_server_search_coord_total_query_errors_syntax | The total number of query syntax errors occurred at the coordinator. [2](#tnote-2) | +| redis_server_search_coord_total_query_errors_arguments | The total number of query argument errors encountered by the shard's coordinator. [2](#tnote-2) | +| redis_server_search_coord_total_query_errors_timeout | The total number of query timeout errors encountered by the shard's coordinator (when timeout policy is 'fail'). [2](#tnote-2) | +| redis_server_search_coord_total_query_warnings_timeout | The total number of query timeout warnings encountered by the shard's coordinator (when timeout policy is 'return partial results'). [2](#tnote-2) | +| redis_server_search_coord_total_query_errors_oom | The total number of query out-of-memory errors encountered by the shard's coordinator. [4](#tnote-4) | +| redis_server_search_coord_total_query_warnings_oom | The total number of query out-of-memory warnings encountered by the shard's coordinator. [4](#tnote-4) | +| redis_server_search_coord_total_query_warnings_max_prefix_expansions | The total number of max prefix expansion warnings encountered by the shard's coordinator. [2](#tnote-2) | +| redis_server_search_uv_threads_running_queries | The number of I/O threads currently handling query distribution to shards in cluster environments. [2](#tnote-2) | +| redis_server_search_uv_threads_running_topology_update | The number of UV threads currently running topology updates. [3](#tnote-3) | +| redis_server_search_active_worker_threads | The number of active worker threads. [2](#tnote-2) | +| redis_server_search_active_coord_threads | The number of active coordinator threads. [2](#tnote-2) | +| redis_server_search_workers_low_priority_pending_jobs | The number of pending low-priority jobs in worker threads, such as vector background indexing, graph updates and vector garbage collection in graph based indexes. [2](#tnote-2) | +| redis_server_search_workers_high_priority_pending_jobs | The number of pending high-priority jobs in worker threads, such as query execution. [2](#tnote-2) | +| redis_server_search_workers_admin_priority_pending_jobs | The number of pending admin-priority jobs in worker threads, such as threadpool configuration changes. [3](#tnote-3) | +| redis_server_search_coord_high_priority_pending_jobs | The number of pending jobs in the coordinator thread queue. Coordinator threads only have a high-priority queue and are primarily used for query distribution. [2](#tnote-2) | 1. Available since RediSearch 2.6. 2. Available since RediSearch 2.8. -3. Available since RediSearch 8.0. +3. Available since RediSearch 2.10. +4. Available since RediSearch 8.0.