Capture CouchDB data in Datadog to:

• Visualize key CouchDB metrics.
• Correlate CouchDB performance with the rest of your applications.

For performance reasons, the CouchDB version you're using is cached, so you cannot monitor CouchDB instances with different versions with the same agent instance.

Follow the instructions below to install and configure this check for an Agent running on a host. For containerized environments, see the Autodiscovery Integration Templates for guidance on applying these instructions.

The CouchDB check is included in the Datadog Agent package, so you don't need to install anything else on your CouchDB servers.

1. Edit the couch.d/conf.yaml file, in the conf.d/ folder at the root of your Agent's configuration directory to start collecting your CouchDB performance data. See the sample couch.d/conf.yaml for all available configuration options.

2. Add this configuration block to your couch.d/conf.yaml file to start gathering your CouchDB Metrics:

   init_config:
   
   instances:
     - server: http://localhost:5984 # or wherever your CouchDB is listening
     #username: <your_username>
     #password: <your_password>
     #name: <A node's Erlang name> # Only for CouchDB 2.x
     #max_nodes_per_check: If no name is specified, the agent will scan all nodes up. As that may be very long, you can limit how many to collect per check. Default: 20
     #max_dbs_per_check. Maximum number of databases to report on. Default: 50
     #tags: A list of tags applied to all metrics collected. Tags may be simple strings or key-value pairs. Default: []

   Optionally, provide a db_whitelist and db_blacklist to control which databases the Agent should and should not collect metrics from.

3. Restart the Agent to begin sending CouchDB metrics to Datadog.

Available for Agent >6.0

1. Collecting logs is disabled by default in the Datadog Agent, you need to enable it in datadog.yaml:

     logs_enabled: true

2. Add this configuration block to your couch.d/conf.yaml file to start collecting your CouchDB Logs:

     logs:
         - type: file
           path: /var/log/couchdb/couch.log
           source: couchdb
           sourcecategory: database
           service: couch

   Change the path and service parameter values and configure them for your environment. See the sample couch.d/conf.yaml for all available configuration options.

3. Restart the Agent.

Run the Agent's status subcommand and look for couch under the Checks section.

See metadata.csv for a list of metrics provided by this integration.

The Couch check does not include any events.

couchdb.can_connect:
Returns Critical if the Agent cannot connect to CouchDB to collect metrics, otherwise returns OK.

Need help? Contact Datadog support.

• Monitoring CouchDB performance with Datadog