CouchDB icon



Plugin: go.d.plugin Module: couchdb


This collector monitors CouchDB servers.

This collector is supported on all platforms.

This collector supports collecting metrics from multiple instances of this integration, including remote instances.

Default Behavior


This integration doesn’t support auto-detection.


The default configuration for this integration does not impose any limits on data collection.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.



No action required.



The configuration file name for this integration is go.d/couchdb.conf.

You can edit the configuration file using the edit-config script from the Netdata config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/couchdb.conf


The following options can be defined globally: update_every, autodetection_retry.

Name Description Default Required
update_every Data collection frequency. 1 False
autodetection_retry Recheck interval in seconds. Zero means no recheck will be scheduled. 0 False
url Server URL. True
node CouchDB node name. Same as -name vm.args argument. _local False
databases List of database names for which db-specific stats should be displayed, space separated. False
username Username for basic HTTP authentication. False
password Password for basic HTTP authentication. False
proxy_url Proxy URL. False
proxy_username Username for proxy basic HTTP authentication. False
proxy_password Password for proxy basic HTTP authentication. False
timeout HTTP request timeout. 2 False
method HTTP request method. GET False
body HTTP request body. False
headers HTTP request headers. False
not_follow_redirects Redirect handling policy. Controls whether the client follows redirects. False False
tls_skip_verify Server certificate chain and hostname validation policy. Controls whether the client performs this check. False False
tls_ca Certification authority that the client uses when verifying the server’s certificates. False
tls_cert Client tls certificate. False
tls_key Client tls key. False



An example configuration.

  - name: local

Basic HTTP auth

Local server with basic HTTP authentication, node name and multiple databases defined. Make sure to match the node name with the NODENAME value in your CouchDB’s etc/vm.args file. Typically, this is of the form in a cluster, or couchdb@ for a single-node server.

  - name: local
    node: couchdb@
    databases: my-db other-db
    username: foo
    password: bar


Note: When you define multiple jobs, their names must be unique.

Collecting metrics from local and remote instances.

  - name: local

  - name: remote


Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

Per CouchDB instance

These metrics refer to the entire monitored application.

This scope has no labels.


Metric Dimensions Unit
couchdb.activity db_reads, db_writes, view_reads requests/s
couchdb.request_methods copy, delete, get, head, options, post, put requests/s
couchdb.response_codes 200, 201, 202, 204, 206, 301, 302, 304, 400, 401, 403, 404, 406, 409, 412, 413, 414, 415, 416, 417, 500, 501, 503 responses/s
couchdb.response_code_classes 2xx, 3xx, 4xx, 5xx responses/s
couchdb.active_tasks indexer, db_compaction, replication, view_compaction tasks
couchdb.replicator_jobs running, pending, crashed, internal_replication_jobs jobs
couchdb.open_files files files
couchdb.erlang_vm_memory atom, binaries, code, ets, procs, other B
couchdb.proccounts os_procs, erl_procs processes
couchdb.peakmsgqueue peak_size messages
couchdb.reductions reductions reductions
couchdb.db_sizes_file a dimension per database KiB
couchdb.db_sizes_external a dimension per database KiB
couchdb.db_sizes_active a dimension per database KiB
couchdb.db_doc_count a dimension per database docs
couchdb.db_doc_del_count a dimension per database docs


There are no alerts configured by default for this integration.


Debug Mode

To troubleshoot issues with the couchdb collector, 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 couchdb

Get Netdata

Sign up for free

Want to see a demonstration of Netdata for multiple use cases?

Go to Live Demo