Skip to main content

Apache CouchDB monitoring with Netdata

Monitors vital statistics of a local Apache CouchDB 2.x server.

This module monitors one or more CouchDB instances, depending on your configuration.

Metrics

All metrics have "couchdb." prefix.

MetricScopeDimensionsUnits
activityglobaldb_reads, db_writes, view_readsrequests/s
request_methodsglobalcopy, delete, get, head, options, post, putrequests/s
response_codesglobal200, 201, 202, 204, 206, 301, 302, 304, 400, 401, 403, 404, 406, 409, 412, 413, 414, 415, 416, 417, 500, 501, 503responses/s
response_code_classesglobal2xx, 3xx, 4xx, 5xxresponses/s
active_tasksglobalindexer, db_compaction, replication, view_compactiontasks
replicator_jobsglobalrunning, pending, crashed, internal_replication_jobsjobs
open_filesglobalfilesfiles
erlang_vm_memoryglobalatom, binaries, code, ets, procs, otherB
proccountsglobalos_procs, erl_procsprocesses
peakmsgqueueglobalpeak_sizemessages
reductionsglobalreductionsreductions
db_sizes_fileglobala dimension per databaseKiB
db_sizes_externalglobala dimension per databaseKiB
db_sizes_activeglobala dimension per databaseKiB
db_doc_countglobala dimension per databasedocs
db_doc_del_countglobala dimension per databasedocs

Configuration

Edit the go.d/couchdb.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, if different
sudo ./edit-config go.d/couchdb.conf

Sample for a local server running on port 5984:

local:
user: 'admin'
pass: 'password'
node: '[email protected]'

Be sure to specify a correct admin-level username and password.

You may also need to change the node name; this should match the value of -name NODENAME in your CouchDB's etc/vm.args file. Typically, this is of the form [email protected] in a cluster, or [email protected] / [email protected] for a single-node server.

If you want per-database statistics, these need to be added to the configuration, separated by spaces:

local:
databases: 'db1 db2 db3 ...'

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

Troubleshooting

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

Was this page helpful?

Contribute