A newer version of this documentation is available.

View Latest

Search Service Metrics

    • UNDER CONSTRUCTION
      +
      A list of the metrics provided by the Search Service.

      The following Search Service metrics can be queried by means of the REST APIs described in Getting Cluster Statistics.

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

      This section is currently under construction.

      fts_avg_grpc_queries_latency

      Units: NA

      Labels: bucket, scope, collection, index

      Description: NA

      fts_avg_internal_queries_latency

      Units: NA

      Labels: bucket, scope, collection, index

      Description: NA

      fts_avg_queries_latency

      Units: millisecond

      Labels: bucket, scope, collection, index

      Description: Average milliseconds to answer a Search query. Per index. (measured from avg_queries_latency)

      fts_batch_bytes_added

      Units: NA

      Labels: NA

      Description: NA

      fts_batch_bytes_removed

      Units: NA

      Labels: NA

      Description: NA

      fts_curr_batches_blocked_by_herder

      Units: number

      Labels: NA

      Description: DCP batches blocked by throttler due to high memory consumption.

      fts_doc_count

      Units: number

      Labels: bucket, scope, collection, index

      Description: Number of documents examined. Per index. (measured from doc_count)

      fts_num_bytes_used_disk

      Units: bytes

      Labels: bucket, scope, collection, index

      Description: Bytes stored on disk for all Search indexes in this bucket.

      fts_num_bytes_used_disk_by_root

      Units: NA

      Labels: bucket, scope, collection, index

      Description: NA

      fts_num_bytes_used_ram

      Units: bytes

      Labels: NA

      Description: Bytes of RAM used by Search across all indexes and all buckets on this server.

      fts_num_files_on_disk

      Units: number

      Labels: bucket, scope, collection, index

      Description: Number of search files on disk across all partitions.

      fts_num_mutations_to_index

      Units: number

      Labels: bucket, scope, collection, index

      Description: Number of mutations not yet indexed. Per index. (measured from num_mutations_to_index)

      fts_num_pindexes_actual

      Units: number

      Labels: bucket, scope, collection, index

      Description: Number of index partitions. Per index. (including replica partitions, measured from num_pindexes_actual)

      fts_num_pindexes_target

      Units: number

      Labels: bucket, scope, collection, index

      Description: Number of index partitions expected. Per index. (including replica partitions, measured from num_pindexes_target)

      fts_num_recs_to_persist

      Units: number

      Labels: bucket, scope, collection, index

      Description: Number of index records not yet persisted to disk. Per index. (measured from num_recs_to_persist)

      fts_num_root_filesegments

      Units: number

      Labels: bucket, scope, collection, index

      Description: Number of file segments in the index across all partitions. (measured from num_root_filesegments)

      fts_num_root_memorysegments

      Units: number

      Labels: bucket, scope, collection, index

      Description: Number of memory segments in the index across all partitions. (measured from num_root_memorysegments)

      fts_pct_cpu_gc

      Units: NA

      Labels: NA

      Description: NA

      fts_tot_batches_flushed_on_maxops

      Units: NA

      Labels: NA

      Description: NA

      fts_tot_batches_flushed_on_timer

      Units: NA

      Labels: NA

      Description: NA

      fts_tot_bleve_dest_closed

      Units: NA

      Labels: NA

      Description: NA

      fts_tot_bleve_dest_opened

      Units: NA

      Labels: NA

      Description: NA

      fts_tot_grpc_listeners_closed

      Units: NA

      Labels: NA

      Description: NA

      fts_tot_grpc_listeners_opened

      Units: NA

      Labels: NA

      Description: NA

      fts_tot_grpc_queryreject_on_memquota

      Units: NA

      Labels: NA

      Description: NA

      fts_tot_grpcs_listeners_closed

      Units: NA

      Labels: NA

      Description: NA

      fts_tot_grpcs_listeners_opened

      Units: NA

      Labels: NA

      Description: NA

      fts_tot_http_limitlisteners_closed

      Units: NA

      Labels: NA

      Description: NA

      fts_tot_http_limitlisteners_opened

      Units: NA

      Labels: NA

      Description: NA

      fts_tot_https_limitlisteners_closed

      Units: NA

      Labels: NA

      Description: NA

      fts_tot_https_limitlisteners_opened

      Units: NA

      Labels: NA

      Description: NA

      fts_tot_queryreject_on_memquota

      Units: NA

      Labels: NA

      Description: NA

      fts_tot_remote_grpc

      Units: NA

      Labels: NA

      Description: NA

      fts_tot_remote_grpc_tls

      Units: NA

      Labels: NA

      Description: NA

      fts_tot_remote_http

      Units: NA

      Labels: NA

      Description: NA

      fts_tot_remote_http2

      Units: NA

      Labels: NA

      Description: NA

      fts_total_bytes_indexed

      Units: bytes/sec

      Labels: bucket, scope, collection, index

      Description: Search bytes indexed per second for all Search indexes in this bucket.

      fts_total_bytes_query_results

      Units: bytes/sec

      Labels: bucket, scope, collection, index

      Description: Bytes returned in results per second. Per index. (measured from total_bytes_query_results)

      fts_total_compaction_written_bytes

      Units: bytes/sec

      Labels: bucket, scope, collection, index

      Description: Compaction bytes written per second. Per index. (measured from total_compaction_written_bytes)

      fts_total_gc

      Units: NA

      Labels: NA

      Description: NA

      fts_total_grpc_internal_queries

      Units: NA

      Labels: bucket, scope, collection, index

      Description: NA

      fts_total_grpc_queries_error

      Units: NA

      Labels: bucket, scope, collection, index

      Description: NA

      fts_total_grpc_queries_slow

      Units: NA

      Labels: bucket, scope, collection, index

      Description: NA

      fts_total_grpc_queries_timeout

      Units: NA

      Labels: bucket, scope, collection, index

      Description: NA

      fts_total_internal_queries

      Units: NA

      Labels: bucket, scope, collection, index

      Description: NA

      fts_total_queries

      Units: number/sec

      Labels: bucket, scope, collection, index

      Description: Search queries per second for all Search indexes in this bucket.

      fts_total_queries_error

      Units: number/sec

      Labels: bucket, scope, collection, index

      Description: Number of queries per second (including timeouts) that resulted in errors. Per index. (measured from total_queries_error)

      fts_total_queries_rejected_by_herder

      Units: number

      Labels: NA

      Description: Number of queries rejected by throttler due to high memory consumption.

      fts_total_queries_slow

      Units: number/sec

      Labels: bucket, scope, collection, index

      Description: Number of slow queries (> 5s to run) per second. Per index. (measured from total_queries_slow)

      fts_total_queries_timeout

      Units: number/sec

      Labels: bucket, scope, collection, index

      Description: Number of queries that timeout per second. Per index. (measured from total_queries_timeout)

      fts_total_request_time

      Units: NA

      Labels: bucket, scope, collection, index

      Description: NA

      fts_total_term_searchers

      Units: number/sec

      Labels: bucket, scope, collection, index

      Description: Number of term searchers started per second. Per index. (measured from total_term_searchers)

      fts_total_term_searchers_finished

      Units: NA

      Labels: bucket, scope, collection, index

      Description: NA