A newer version of this documentation is available.

View Latest

Query Service Metrics

    March 9, 2025
    + 12
    A list of the metrics provided by the Query Service.

    The following Query 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).

    n1ql_active_requests     7.0.0 gauge

    Total number of active requests.

    n1ql_at_plus     7.0.0 counter

    Total number of N1QL requests with at_plus index consistency.

    n1ql_audit_actions     7.0.0 counter

    The total number of audit records sent to the server. Some requests cause more than one audit record to be emitted. Records in the output queue that have not yet been sent to the server are not counted.

    n1ql_audit_actions_failed     7.0.0 counter

    The total number of audit records sent to the server that failed.

    n1ql_audit_requests_filtered     7.0.0 counter

    The number of potentially auditable requests that cause no audit action to be taken.

    n1ql_audit_requests_total     7.0.0 counter

    The total number of potentially auditable requests sent to the query engine.

    n1ql_bulk_get_errors     7.2.4 counter

    Count of errors due to bulk get operations

    n1ql_cancelled     7.0.0 counter

    Total number of cancelled requests.

    n1ql_cas_mismatch_errors     7.2.4 counter

    Count of CAS mismatch errors

    n1ql_deletes     7.0.0 counter

    Total number of DELETE operations.

    n1ql_errors     7.0.0 counter

    The total number of N1QL errors returned so far.

    n1ql_index_scans     7.0.0 counter

    Total number of secondary index scans.

    n1ql_index_scans_fts     7.2.4 counter

    Total number of index scans performed by FTS.

    n1ql_index_scans_gsi     7.2.4 counter

    Total number of index scans performed by GSI.

    n1ql_inserts     7.0.0 counter

    Total number of INSERT operations.

    n1ql_invalid_requests     7.0.0 counter

    Total number of requests for unsupported endpoints.

    n1ql_load     7.0.0 gauge

    The current utilization factor of the servicers on the query node.

    n1ql_mem_quota_exceeded_errors     7.2.4 counter

    Count of memory quota exceeded errors

    n1ql_mutations     7.0.0 counter

    Total number of document mutations.

    n1ql_prepared     7.0.0 counter

    Total number of prepared statements executed.

    n1ql_primary_scans     7.0.0 counter

    Total number of primary index scans.

    n1ql_primary_scans_fts     7.2.4 counter

    Total number of primary scans performed by FTS.

    n1ql_primary_scans_gsi     7.2.4 counter

    Total number of primary scans performed by GSI.

    n1ql_queued_requests     7.0.0 gauge

    Total number of queued requests.

    n1ql_request_time     7.0.0 counter / nanoseconds

    Total end-to-end time to process all queries.

    n1ql_requests     7.0.0 counter

    Total number of N1QL requests.

    n1ql_requests_1000ms     7.0.0 counter

    Number of queries that take longer than 1000ms.

    n1ql_requests_250ms     7.0.0 counter

    Number of queries that take longer than 250ms.

    n1ql_requests_5000ms     7.0.0 counter

    Number of queries that take longer than 5000ms.

    n1ql_requests_500ms     7.0.0 counter

    Number of queries that take longer than 500ms.

    n1ql_result_count     7.0.0 counter

    Total number of results (documents) returned by the query engine.

    n1ql_result_size     7.0.0 counter / bytes

    Total size of data returned by the query engine.

    n1ql_scan_plus     7.0.0 counter

    Total number of N1QL requests with request_plus index consistency.

    n1ql_selects     7.0.0 counter

    Total number of SELECT requests.

    n1ql_service_time     7.0.0 counter / nanoseconds

    Time to execute all queries.

    n1ql_timeouts     7.2.4 counter

    Count of request timeout errors

    n1ql_transaction_time     7.0.0 counter / nanoseconds

    Total elapsed time of transactions so far.

    n1ql_transactions     7.0.0 counter

    Total number of transactions.

    n1ql_unauthorized_users     7.2.4 counter

    Count of unauthorized access errors

    n1ql_unbounded     7.0.0 counter

    Total number of N1QL requests with not_bounded index consistency.

    n1ql_updates     7.0.0 counter

    Total number of UPDATE requests.

    n1ql_warnings     7.0.0 counter

    The total number of N1QL warnings returned so far.