Skip to content

Latest commit

 

History

History
 
 

couch

README.md

CouchDB Integration

CouchDB dashboard

Overview

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.

Setup

Installation

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

Configuration

Host

To configure this check for an Agent running on a host:

Metric collection

  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:

    init_config:

instances:
  ## @param server - string - required
  ## The Couch server's url.
  #
  - server: http://localhost:5984

    Note: provide a db_include and db_exclude to control which databases the Agent should and should not collect metrics from.

  2. Restart the Agent.

Log collection

Available for Agent versions >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
    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.

Containerized

For containerized environments, see the Autodiscovery Integration Templates for guidance on applying the parameters below.

Metric collection
Parameter Value
<INTEGRATION_NAME> couch
<INIT_CONFIG> blank or {}
<INSTANCE_CONFIG> {"server": "http://%%host%%:5984"}
Log collection

Available for Agent versions >6.0

Collecting logs is disabled by default in the Datadog Agent. To enable it, see Kubernetes Log Collection.

Parameter Value
<LOG_CONFIG> {"source": "couchdb", "service": "<SERVICE_NAME>"}

Validation

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

Data Collected

Metrics

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

Events

The Couch check does not include any events.

Service Checks

See service_checks.json for a list of service checks provided by this integration.

Troubleshooting

Need help? Contact Datadog support.

Further Reading