Skip to content

Latest commit

 

History

History
 
 

couchbase

README.md

Couchbase Integration

Couchbase Bytes Read

Overview

Identify busy buckets, track cache miss ratios, and more. This Agent check collects metrics like:

  • Hard disk and memory used by data
  • Current connections
  • Total objects
  • Operations per second
  • Disk write queue size

And many more.

Setup

Installation

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

Configuration

Host

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

Metric collection

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

    init_config:

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

  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 couchbase.d/conf.yaml file to start collecting your Couchbase Logs:

    logs:
  - type: file
    path: /opt/couchbase/var/lib/couchbase/logs/couchdb.log
    source: couchdb

    Change the path and service parameter values and configure them for your environment. See the sample couchbase.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> couchbase
<INIT_CONFIG> blank or {}
<INSTANCE_CONFIG> {"server": "http://%%host%%:8091"}

Validation

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

Data Collected

Metrics

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

Events

The Couchbase check emits an event to Datadog each time the cluster is rebalanced.

Service Checks

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

Troubleshooting

Need help? Contact Datadog support.

Further Reading