Couchbase

Prometheus Metrics

Couchbase is a distributed NoSQL document database with integrated caching, full-text search, and analytics capabilities.

Prometheus Metrics

Service Configuration

Couchbase 7.0+ exposes Prometheus metrics by default at http://localhost:8091/metrics on the management port. No additional configuration is required.

For versions older than 7.0, use a third-party Couchbase Exporter to collect metrics.

Glouton Configuration

Linux

sudo tee /etc/glouton/conf.d/99-couchbase.conf > /dev/null << 'EOF'
metric:
  prometheus:
    targets:
      - url: "http://localhost:8091/metrics"
        name: "couchbase"
        allow_metrics:
          - "kv_ops"
          - "kv_ep_tmp_oom_errors"
          - "kv_vb_active_resident_items_ratio"
          - "n1ql_requests"
          - "n1ql_errors"
          - "cm_http_requests_total"
          - "sysproc_mem_resident"
          - "kv_ep_bg_fetched"
EOF

Windows

Create or edit C:\ProgramData\glouton\conf.d\99-couchbase.conf:

metric:
  prometheus:
    targets:
      - url: "http://localhost:8091/metrics"
        name: "couchbase"
        allow_metrics:
          - "kv_ops"
          - "kv_ep_tmp_oom_errors"
          - "kv_vb_active_resident_items_ratio"
          - "n1ql_requests"
          - "n1ql_errors"
          - "cm_http_requests_total"
          - "sysproc_mem_resident"
          - "kv_ep_bg_fetched"

Glouton automatically detects configuration changes.

Customize collected metrics

The metrics below are our recommended defaults. You can adjust the allow_metrics list to include any metric from Couchbase’s monitoring documentation, or use deny_metrics to exclude specific ones. See Metrics Filtering for details.

Metric	Description
kv_ops	Total number of key-value operations per second
kv_ep_tmp_oom_errors	Number of temporary out-of-memory errors
kv_vb_active_resident_items_ratio	Ratio of active items residing in memory versus total active items
n1ql_requests	Total number of N1QL query requests
n1ql_errors	Total number of N1QL query errors
cm_http_requests_total	Total number of HTTP requests to the cluster manager
sysproc_mem_resident	Resident memory usage of the Couchbase process in bytes
kv_ep_bg_fetched	Number of items fetched from disk per second