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

Query Service Metrics

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

      As a brief introduction however, this is how you would go about building a REST command for the n1ql_active_requests metric.

      Using CURL to retrieve Query Service metrics

      Run the following command from your shell console to get the total number of active requests.

      curl -X GET --location "http://localhost:8091/pools/default/stats/range/n1ql_active_requests" \
    --basic --user Administrator:password

      See Query Service Metrics Cross Reference if you are looking for a metric name you know from an alternative supported or legacy tool.

      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.0gauge

      Total number of active requests.

      n1ql_allocated_values     7.6.0counter

      The total number of values allocated in the query engine.

      n1ql_at_plus     7.0.0counter

      Total number of N1QL requests with at_plus index consistency.

      n1ql_audit_actions     7.0.0counter

      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.0counter

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

      n1ql_audit_requests_filtered     7.0.0counter

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

      n1ql_audit_requests_total     7.0.0counter

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

      n1ql_boot_timestamp_seconds     7.6.0gauge / seconds

      The time the service booted in fractional seconds since Unix epoch.

      n1ql_bucket_reads     7.6.0gauge

      The total number of reads on the bucket.

      n1ql_bucket_retries     7.6.0gauge

      The total number of retries on the bucket.

      n1ql_bucket_writes     7.6.0gauge

      The total number of writes on the bucket.

      n1ql_bulk_get_errors     7.2.4counter

      Count of errors due to bulk get operations

      n1ql_cancelled     7.0.0counter

      Total number of cancelled requests.

      n1ql_cas_mismatch_errors     7.2.4counter

      Count of CAS mismatch errors

      n1ql_counter_cu_total     7.6.0counter / seconds

      The number of distinct operations recording Compute Units (CUs) with Regulator.

      n1ql_credit_cu_total     7.6.0counter / seconds

      The number of Compute Units (CUs) refunded.

      n1ql_credit_ru_total     7.6.0counter / seconds

      The number of Read Units (RUs) refunded.

      n1ql_credit_wu_total     7.6.0counter / seconds

      The number of Write Units (WUs) refunded.

      n1ql_curl_call_errors     7.6.2counter

      The number of CURL() calls made by statements that failed (returned an error).

      n1ql_curl_calls     7.6.2counter

      The number of CURL() calls made by statements.

      n1ql_deletes     7.0.0counter

      Total number of DELETE operations.

      n1ql_errors     7.0.0counter

      The total number of N1QL errors returned so far.

      n1ql_ffdc_manual     7.6.6counter

      The total number of ffdc captures triggered due to manual invocation of ffdc admin api

      n1ql_ffdc_memory_rate     7.6.6counter

      The total number of ffdc captures triggered due to memory usage rate increasing by 20% of the average memory usage over the past 2 hours

      n1ql_ffdc_memory_threshold     7.6.6counter

      The total number of ffdc captures triggered due to memory usage exceeding the 80% threshold

      n1ql_ffdc_plus_queue_full     7.6.6counter

      The total number of ffdc captures triggered due to the plus-request queue being full

      n1ql_ffdc_request_queue_full     7.6.6counter

      The total number of ffdc captures triggered due to the unbounded-request queue being full

      n1ql_ffdc_shutdown     7.6.6counter

      The total number of ffdc captures triggered due to shutdown processing exceeding 30 minutes

      n1ql_ffdc_sigterm     7.6.6counter

      The total number of ffdc captures triggered by a SIGTERM signal

      n1ql_ffdc_stalled_queue     7.6.6counter

      The total number of ffdc captures triggered due to no requests being processed when the queued requests exceed three times the number of servicers within the last 30 seconds

      n1ql_ffdc_total     7.6.6counter

      The total number of ffdc occurrences

      n1ql_index_scans     7.0.0counter

      Total number of secondary index scans.

      n1ql_index_scans_fts     7.2.4counter

      Total number of index scans performed by FTS.

      n1ql_index_scans_gsi     7.2.4counter

      Total number of index scans performed by GSI.

      n1ql_index_scans_seq     7.6.0counter

      Total number of sequential scans.

      n1ql_inserts     7.0.0counter

      Total number of INSERT operations.

      n1ql_invalid_requests     7.0.0counter

      Total number of requests for unsupported endpoints.

      n1ql_load     7.0.0gauge

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

      n1ql_load_factor     7.6.0gauge

      The total load factor of the query node.

      n1ql_mem_quota_exceeded_errors     7.2.4counter

      Count of memory quota exceeded errrors

      n1ql_meter_cu_total     7.6.0counter / seconds

      The number of Compute Units (CUs) recorded.

      n1ql_mutations     7.0.0counter

      Total number of document mutations.

      n1ql_node_memory     7.6.0gauge / bytes

      The total size of in use memory in the query node.

      n1ql_node_rss     7.6.1gauge / bytes

      The resident set size (RSS) of the query node process.

      n1ql_op_count_total     7.6.0counter / seconds

      The number of distinct operations recorded with Regulator.

      n1ql_prepared     7.0.0counter

      Total number of prepared statements executed.

      n1ql_primary_scans     7.0.0counter

      Total number of primary index scans.

      n1ql_primary_scans_fts     7.2.4counter

      Total number of primary scans performed by FTS.

      n1ql_primary_scans_gsi     7.2.4counter

      Total number of primary scans performed by GSI.

      n1ql_primary_scans_seq     7.6.0counter

      Total number of primary sequential scans.

      n1ql_queued_requests     7.0.0gauge

      Total number of queued requests.

      n1ql_reject_count_total     7.6.0counter / seconds

      The number of times Regulator instructed an operation to be rejected.

      n1ql_request_time     7.0.0counter / nanoseconds

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

      n1ql_requests     7.0.0counter

      Total number of N1QL requests.

      n1ql_requests_1000ms     7.0.0counter

      Number of queries that take longer than 1000ms.

      n1ql_requests_250ms     7.0.0counter

      Number of queries that take longer than 250ms.

      n1ql_requests_5000ms     7.0.0counter

      Number of queries that take longer than 5000ms.

      n1ql_requests_500ms     7.0.0counter

      Number of queries that take longer than 500ms.

      n1ql_result_count     7.0.0counter

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

      n1ql_result_size     7.0.0counter / bytes

      Total size of data returned by the query engine.

      n1ql_scan_plus     7.0.0counter

      Total number of N1QL requests with request_plus index consistency.

      n1ql_selects     7.0.0counter

      Total number of SELECT requests.

      n1ql_service_time     7.0.0counter / nanoseconds

      Time to execute all queries.

      n1ql_temp_space_errors     7.6.0counter

      Count of temp space related errors

      n1ql_tenant_kv_throttle_count     7.6.0gauge

      The total number of times KV has been throttled for queries on this tenant.

      n1ql_tenant_kv_throttle_seconds_total     7.6.0gauge / seconds

      The total amount of time KV has been throttled for queries on this tenant.

      n1ql_tenant_memory     7.6.0gauge / bytes

      The total size of in use tenant memory.

      n1ql_tenant_reads     7.6.0gauge

      The total number of reads on the tenant.

      n1ql_tenant_retries     7.6.0gauge

      The total number of retries on the tenant.

      n1ql_tenant_writes     7.6.0gauge

      The total number of writes on the tenant.

      n1ql_throttle_count_total     7.6.0counter / seconds

      The number of times Regulator instructed an operation to throttle.

      n1ql_throttle_seconds_total     7.6.0counter / seconds

      The total time spent throttling (in seconds).

      n1ql_timeouts     7.2.4counter

      Count of request timeout errors

      n1ql_transaction_time     7.0.0counter / nanoseconds

      Total elapsed time of transactions so far.

      n1ql_transactions     7.0.0counter

      Total number of transactions.

      n1ql_unauthorized_users     7.2.4counter

      Count of unauthorized access errors

      n1ql_unbounded     7.0.0counter

      Total number of N1QL requests with not_bounded index consistency.

      n1ql_updates     7.0.0counter

      Total number of UPDATE requests.

      n1ql_warnings     7.0.0counter

      The total number of N1QL warnings returned so far.