Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

A newer version of this documentation is available.

View Latest

Search Service Metrics

    March 9, 2025
    + 12
    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 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).

    fts_avg_grpc_queries_latency     7.0.0 gauge / milliseconds

    Average latency per query, using gRPC for streaming, for an index

    fts_avg_internal_queries_latency     7.0.0 gauge / milliseconds

    Average latency of inter-node queries per unit time for an index

    fts_avg_queries_latency     7.0.0 gauge / milliseconds

    Average latency of queries per unit time for an index

    fts_batch_bytes_added     7.0.0 counter / bytes

    Total number of bytes from batches yet to be indexed.

    fts_batch_bytes_removed     7.0.0 counter / bytes

    Total number of bytes from batches which have been indexed.

    fts_curr_batches_blocked_by_herder     7.0.0 gauge

    The difference between the number of batches that have been indexed and the number of batches yet to be indexed

    fts_doc_count     7.0.0 counter

    Number of documents in the index

    fts_num_batches_introduced     7.0.0 counter

    Total number of batches introduced as part of indexing.

    fts_num_bytes_used_disk     7.0.0 gauge / bytes

    The number of bytes used on disk by the index

    fts_num_bytes_used_disk_by_root     7.0.0 gauge / bytes

    The number of bytes used on disk by the root segment

    fts_num_bytes_used_ram     7.0.0 gauge / bytes

    The number of bytes used in memory

    fts_num_files_on_disk     7.0.0 gauge

    The number of files on disk for an index

    fts_num_mutations_to_index     7.0.0 gauge

    DCP sequence numbers yet to be indexed for an index

    fts_num_pindexes_actual     7.0.0 gauge

    Total number of pindexes currently

    fts_num_pindexes_target     7.0.0 gauge

    Planned/expected number of pindexes

    fts_num_recs_to_persist     7.0.0 gauge

    The number of entries (terms, records, dictionary rows, etc) by Bleve not yet persisted to storage

    fts_num_root_filesegments     7.0.0 gauge

    The number of file segments in the root segment

    fts_num_root_memorysegments     7.0.0 gauge

    The number of memory segments in the root segment

    fts_pct_cpu_gc     7.0.0 gauge / percent

    The percentage of CPU time spent by an index in garbage collection

    fts_tot_batches_flushed_on_maxops     7.0.0 counter

    Total number of batches executed due to the batch size being greater than the maximum number of operations per batch

    fts_tot_batches_flushed_on_timer     7.0.0 counter

    Total number of batches executed at regular intervals

    fts_tot_bleve_dest_closed     7.0.0 counter

    Total number of times Bleve destinations closed

    fts_tot_bleve_dest_opened     7.0.0 counter

    The number of times Bleve destinations opened

    fts_tot_grpc_listeners_closed     7.0.0 counter

    Total number of gRPC listeners closed

    fts_tot_grpc_listeners_opened     7.0.0 counter

    Total number of gRPC listeners opened

    fts_tot_grpc_queryreject_on_memquota     7.0.0 counter

    Total number of gRPC queries rejected due to the memory quota being lesser than the estimated memory required for merging search results from all partitions from the query

    fts_tot_grpcs_listeners_closed     7.0.0 counter

    Total number of gRPC SSL listeners closed

    fts_tot_grpcs_listeners_opened     7.0.0 counter

    Total number of gRPC SSL listeners opened

    fts_tot_http_limitlisteners_closed     7.0.0 counter

    Total number of HTTP limit listeners closed

    fts_tot_http_limitlisteners_opened     7.0.0 counter

    Total number of HTTP limit listeners opened

    fts_tot_https_limitlisteners_closed     7.0.0 counter

    Total number of HTTPS limit listeners closed

    fts_tot_https_limitlisteners_opened     7.0.0 counter

    Total number of HTTPS limit listeners opened

    fts_tot_queryreject_on_memquota     7.0.0 counter

    Total number of queries rejected due to the memory quota being lesser than the estimated memory required for merging search results from all partitions from the query

    fts_tot_remote_grpc     7.0.0 counter

    Total number of remote(i.e. different node) gRPC requests

    fts_tot_remote_grpc_tls     7.0.0 counter

    Total number of remote(i.e. different node) gRPC SSL requests when adding clients.

    fts_tot_remote_http     7.0.0 counter

    Total number of remote(i.e. different node) HTTP requests

    fts_tot_remote_http2     7.0.0 counter

    Total number of remote(i.e. different node) HTTP SSL requests

    fts_total_bytes_indexed     7.0.0 gauge

    Rate of bytes indexed for an index

    fts_total_bytes_query_results     7.0.0 counter / bytes

    Size of results coming back from full text queries for search results, including the entire size of the JSON sent

    fts_total_compaction_written_bytes     7.0.0 counter / bytes

    Number of bytes written to disk as a result of compaction

    fts_total_gc     7.0.0 counter

    The number of garbage collection events triggered

    fts_total_grpc_internal_queries     7.0.0 counter

    The number of internal gRPC requests from the co-ordinating node for the query to other nodes, for an index

    fts_total_grpc_queries     7.0.0 counter

    The total number of queries, using gRPC for streaming, for an index

    fts_total_grpc_queries_error     7.0.0 counter

    The number of queries that resulted in an error, using gRPC for streaming, for an index

    fts_total_grpc_queries_slow     7.0.0 counter

    The number of queries in the slow query log, using gRPC for streaming, for an index

    fts_total_grpc_queries_timeout     7.0.0 counter

    The number of queries that exceeded the timeout, using gRPC for streaming, for an index

    fts_total_internal_queries     7.0.0 counter

    The number of internal queries from the co-ordinating node to other nodes, per unit time for an index

    fts_total_queries     7.0.0 counter

    The number of full text queries per second for an index

    fts_total_queries_error     7.0.0 counter

    The number of FTS queries for an index that resulted in an error

    fts_total_queries_rejected_by_herder     7.0.0 counter

    The number of queries rejected by the app herder when the memory used exceeds the application's query quota

    fts_total_queries_slow     7.0.0 counter

    The number of FTS queries in the slow query log

    fts_total_queries_timeout     7.0.0 counter

    The number of FTS queries for an index that exceeded the timeout

    fts_total_request_time     7.0.0 counter / nanoseconds

    Total time spent processing query requests for an index

    fts_total_term_searchers     7.0.0 counter

    Number of bleve term searchers

    fts_total_term_searchers_finished     7.0.0 counter

    Total term searchers that have finished serving a query