Skip to main content

Couchbase collector

Couchbase is an open source, distributed, JSON document database. It exposes a scale-out, key-value store with managed cache for sub-millisecond data operations, purpose-built indexers for efficient queries and a powerful query engine for executing SQL-like queries.


All metrics have "couchbase." prefix.

bucket_quota_percent_usedglobala dimension per bucketpercentage
bucket_ops_per_secglobala dimension per bucketops/s
bucket_disk_fetchesglobala dimension per bucketfetches
bucket_item_countglobala dimension per bucketitems
bucket_disk_used_statsglobala dimension per bucketbytes
bucket_data_usedglobala dimension per bucketbytes
bucket_mem_usedglobala dimension per bucketbytes
bucket_vb_active_num_non_residentglobala dimension per bucketitems


In this module 8 charts are supported because we collect basic stats from couchbase.

Buckets Basic Stats

Collected from /pools/default/buckets endpoint.

  • Quota Percent Used Per Bucket in %
  • Operations Per Second Per Bucket in ops/s
  • Disk Fetches Per Bucket in fetches
  • Item Count Per Bucket in items
  • Disk Used Per Bucket in bytes
  • Data Used Per Bucket in bytes
  • Memory Used Per Bucket in bytes
  • Number Of Non-Resident Items Per Bucket in items


Edit the go.d/couchbase.conf configuration file using edit-config from the Netdata config directory, which is typically at /etc/netdata.

cd /etc/netdata # Replace this path with your Netdata config directory
sudo ./edit-config go.d/couchbase.conf

To add a new endpoint to collect metrics from, or change the URL that Netdata looks for, add or configure the name and url values. Endpoints can be both local or remote as long as they expose their metrics on the provided URL.

Here is an example with two endpoints:

- name: local
username: admin
password: admin-password

- name: remote
username: admin
password: admin-passwor

For all available options, see the Couchbase collector's configuration file.


To troubleshoot issues with the couchbase, run the go.d.plugin with the debug option enabled. The output should give you clues as to why the collector isn't working.

  • Navigate to the plugins.d directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the plugins setting under [directories].

    cd /usr/libexec/netdata/plugins.d/
  • Switch to the netdata user.

    sudo -u netdata -s
  • Run the go.d.plugin to debug the collector:

    ./go.d.plugin -d -m couchbase

Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.