Skip to main content

CouchDB

Plugin: go.d.plugin Module: couchdb

Overview

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

Auto-Detection

This integration doesn't support auto-detection.

Limits

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.

Metrics

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.

Metrics:

MetricDimensionsUnit
couchdb.activitydb_reads, db_writes, view_readsrequests/s
couchdb.request_methodscopy, delete, get, head, options, post, putrequests/s
couchdb.response_codes200, 201, 202, 204, 206, 301, 302, 304, 400, 401, 403, 404, 406, 409, 412, 413, 414, 415, 416, 417, 500, 501, 503responses/s
couchdb.response_code_classes2xx, 3xx, 4xx, 5xxresponses/s
couchdb.active_tasksindexer, db_compaction, replication, view_compactiontasks
couchdb.replicator_jobsrunning, pending, crashed, internal_replication_jobsjobs
couchdb.open_filesfilesfiles
couchdb.erlang_vm_memoryatom, binaries, code, ets, procs, otherB
couchdb.proccountsos_procs, erl_procsprocesses
couchdb.peakmsgqueuepeak_sizemessages
couchdb.reductionsreductionsreductions
couchdb.db_sizes_filea dimension per databaseKiB
couchdb.db_sizes_externala dimension per databaseKiB
couchdb.db_sizes_activea dimension per databaseKiB
couchdb.db_doc_counta dimension per databasedocs
couchdb.db_doc_del_counta dimension per databasedocs

Alerts

There are no alerts configured by default for this integration.

Setup

Prerequisites

No action required.

Configuration

File

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

Options

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

Config
NameDescriptionDefaultRequired
update_everyData collection frequency.1no
autodetection_retryRecheck interval in seconds. Zero means no recheck will be scheduled.0no
urlServer URL.http://127.0.0.1:5984yes
nodeCouchDB node name. Same as -name vm.args argument._localno
databasesList of database names for which db-specific stats should be displayed, space separated.no
usernameUsername for basic HTTP authentication.no
passwordPassword for basic HTTP authentication.no
proxy_urlProxy URL.no
proxy_usernameUsername for proxy basic HTTP authentication.no
proxy_passwordPassword for proxy basic HTTP authentication.no
timeoutHTTP request timeout.2no
methodHTTP request method.GETno
bodyHTTP request body.no
headersHTTP request headers.no
not_follow_redirectsRedirect handling policy. Controls whether the client follows redirects.nono
tls_skip_verifyServer certificate chain and hostname validation policy. Controls whether the client performs this check.nono
tls_caCertification authority that the client uses when verifying the server's certificates.no
tls_certClient tls certificate.no
tls_keyClient tls key.no

Examples

Basic

An example configuration.

Config
jobs:
- name: local
url: http://127.0.0.1:5984

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 [email protected] in a cluster, or [email protected] for a single-node server.

Config
jobs:
- name: local
url: http://127.0.0.1:5984
node: [email protected]
databases: my-db other-db
username: foo
password: bar

Multi-instance

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

Collecting metrics from local and remote instances.

Config
jobs:
- name: local
url: http://127.0.0.1:5984

- name: remote
url: http://203.0.113.0:5984

Troubleshooting

Debug Mode

Important: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.

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

Getting Logs

If you're encountering problems with the couchdb collector, follow these steps to retrieve logs and identify potential issues:

  • Run the command specific to your system (systemd, non-systemd, or Docker container).
  • Examine the output for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.

System with systemd

Use the following command to view logs generated since the last Netdata service restart:

journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep couchdb

System without systemd

Locate the collector log file, typically at /var/log/netdata/collector.log, and use grep to filter for collector's name:

grep couchdb /var/log/netdata/collector.log

Note: This method shows logs from all restarts. Focus on the latest entries for troubleshooting current issues.

Docker Container

If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:

docker logs netdata 2>&1 | grep couchdb

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