A newer version of this documentation is available.

View Latest
March 16, 2025
+ 12
A list of the metrics provided by the Index Service.

The following Index-Service metrics can be queried by means of the REST APIs described in Statistics.

See also the metrics provided in Metrics for All Services; which are indeed for all Couchbase-Server services, and so support the Index Service.

This section is currently under construction.

index_avg_drain_rate

Units: NA

Labels: bucket, scope, collection, index

Description: NA

index_avg_item_size

Units: bytes

Labels: bucket, scope, collection, index

Description: Average size of each index item. Per index.

index_avg_scan_latency

Units: nanoseconds

Labels: bucket, scope, collection, index

Description: Average time (in nanoseconds) to serve a scan request. Per index.

index_cache_hits

Units: NA

Labels: bucket, scope, collection, index

Description: NA

index_cache_misses

Units: NA

Labels: bucket, scope, collection, index

Description: NA

index_data_size

Units: bytes

Labels: bucket, scope, collection, index

Description: Bytes in memory used by Index across all indexes and buckets.

index_data_size_on_disk

Units: NA

Labels: bucket, scope, collection, index

Description: NA

index_disk_size

Units: bytes

Labels: bucket, scope, collection, index

Description: Bytes on disk used by Index across all indexes and buckets.

index_frag_percent

Units: NA

Labels: bucket, scope, collection, index

Description: NA

index_items_count

Units: number

Labels: bucket, scope, collection, index

Description: Current total number of indexed documents

index_log_space_on_disk

Units: NA

Labels: bucket, scope, collection, index

Description: NA

index_memory_quota

Units:

Labels: NA

Description:

index_memory_used

Units: bytes

Labels: bucket, scope, collection, index

Description: Total memory used by the index.

index_memory_used_total

Units:

Labels: NA

Description:

index_num_docs_indexed

Units: number/sec

Labels: bucket, scope, collection, index

Description: Number of documents indexed by the indexer per second.

index_num_docs_pending

Units: NA

Labels: bucket, scope, collection, index

Description: NA

index_num_docs_queued

Units: number

Labels: bucket, scope, collection, index

Description: Number of documents queued to be indexed at the Indexer. Per Index.

index_num_requests

Units: number/sec

Labels: bucket, scope, collection, index

Description: Number of requests served by the indexer per second

index_num_rows_returned

Units: number/sec

Labels: bucket, scope, collection, index

Description: Number of index items scanned by the indexer per second across all indexes.

index_num_rows_scanned

Units: NA

Labels: bucket, scope, collection, index

Description: NA

index_raw_data_size

Units: NA

Labels: bucket, scope, collection, index

Description: NA

index_recs_in_mem

Units: NA

Labels: bucket, scope, collection, index

Description: NA

index_recs_on_disk

Units: NA

Labels: bucket, scope, collection, index

Description: NA

index_resident_percent

Units: percent

Labels: bucket, scope, collection, index

Description: Percentage of index data resident in memory. Per index.

index_scan_bytes_read

Units: bytes/sec

Labels: bucket, scope, collection, index

Description: Number of bytes/sec scanned by the index.

index_total_scan_duration

Units: NA

Labels: bucket, scope, collection, index

Description: NA