A newer version of this documentation is available.

View Latest

Index Service Metrics

      +
      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.

      Tip
      • The x.y.z badge shows the Couchbase Server version the metric was added in.

      • The type / unit badge shows shows the Prometheus type and unit (if present).

      index_avg_disk_bps     7.2.0 gauge

      Sum of disk bytes written per second, of all indexes, located on this node

      index_avg_drain_rate     7.0.0 gauge

      Average number of documents indexed per second, for this index

      index_avg_item_size     7.0.0 gauge / bytes

      Average size of the indexed items, for this index

      index_avg_mutation_rate     7.2.0 gauge

      Sum of mutation rates of all indexes, located on this node

      index_avg_resident_percent     7.2.0 gauge

      Average resident percent across all indexes, located on this node

      index_avg_scan_latency     7.0.0 gauge / Nanoseconds

      Average latency observed by the index scans, for this index

      index_cache_hits     7.0.0 counter

      Number of times the required index page is found in memory, for this index

      index_cache_misses     7.0.0 counter

      Number of times the required index page is NOT found in memory, for this index

      index_data_size     7.0.0 gauge / bytes

      The approximate size of the valid uncompressed index data, for this index

      index_data_size_on_disk     7.0.0 gauge / bytes

      The size of the valid compressed index data, for this index

      index_disk_size     7.0.0 gauge / bytes

      Total disk space taken up by this index, after compression. This includes index data files, checkpoints etc.

      index_frag_percent     7.0.0 gauge

      Percentage of invalid index data, for this index

      index_items_count     7.0.0 gauge

      The actual number of items present in the latest index snapshot, for this index

      index_log_space_on_disk     7.0.0 gauge / bytes

      The size of the index data files - including garbage, for this index

      index_memory_quota     7.0.0 gauge / bytes

      Configured memory quota for the index service nodes

      index_memory_rss     7.2.0 gauge / bytes

      Resident set size of the indexer process, running on this node

      index_memory_total_storage     7.2.0 gauge / bytes

      Amount of memory used by the index memory allocator, on this node

      index_memory_used     7.0.0 gauge / bytes

      The memory used by this index

      index_memory_used_storage     7.2.0 gauge / bytes

      Amount of memory used by underlying index storage, on this node

      index_memory_used_total     7.0.0 gauge / bytes

      Total memory used by the indexer process

      index_num_docs_indexed     7.0.0 counter

      Number of document updates (of type insert, modify, delete) observed by this index

      index_num_docs_pending     7.0.0 gauge

      Number of pending updates that are yet to be received by index service, for this index

      index_num_docs_queued     7.0.0 gauge

      Number of updates queued (but not yet processed) by index service, for this index

      index_num_indexes     7.2.0 gauge

      Total number of indexes, located on this node

      index_num_requests     7.0.0 counter

      Number of scan requests received by the index service, for this index

      index_num_rows_returned     7.0.0 counter

      Number of rows/index entries returned as the scan result during index scans, for this index

      index_num_rows_scanned     7.0.0 counter

      Number of rows/index entries read during the index scans, for this index

      index_num_storage_instances     7.2.0 gauge

      Total number of storage instances, located on this node

      index_raw_data_size     7.0.0 gauge / bytes

      Encoded, uncompressed size of the index data, for this index

      index_recs_in_mem     7.0.0 gauge

      Number of index entries cached in memory, for this index

      index_recs_on_disk     7.0.0 gauge

      Number of index entries stored on disk, which are not cached in memory, for this index

      index_resident_percent     7.0.0 gauge

      Ratio of records in memory to total records, for this index

      index_scan_bytes_read     7.0.0 counter / bytes

      Number of bytes read from the index storage during index scans, for this index

      index_total_data_size     7.2.0 gauge / bytes

      Sum of data size of all indexes, located on this node

      index_total_disk_size     7.2.0 gauge / bytes

      Sum of disk size of all indexes, located on this node

      index_total_drain_rate     7.2.0 gauge

      Sum of drain rate of all indexes, located on this node

      index_total_requests     7.2.0 counter

      Sum of number of requests received by all indexes, located on this node

      index_total_rows_returned     7.2.0 counter

      Sum of number of rows returned during index scan across all indexes, located on this node

      index_total_rows_scanned     7.2.0 counter

      Sum of number of rows scanned during index scans across all indexes, located on this node

      index_total_scan_duration     7.0.0 counter / Nanoseconds

      Total time taken by the scans requests, for this index