Skip to content

Latest commit

 

History

History
 
 

couchbase

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

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.

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

  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 performance metrics and logs. See the sample couchbase.d/conf.yaml for all available configuration options.

Metric Collection

  1. Add this configuration block to your couchbase.d/conf.yaml file to start gathering your Couchbase Metrics:

    init_config:
    
    instances:
      - server: http://localhost:8091 # or wherever your Couchbase is listening
        #username: <your_username>
        #password: <your_password>
    
  2. Restart the Agent to begin sending Couchbase metrics to Datadog.

Log collection

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

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

    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.

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 rebalances.

Service Checks

  • couchbase.can_connect:

Returns Critical if the Agent cannot connect to Couchbase to collect metrics.

  • couchbase.by_node.cluster_membership:

Returns Critical if the node failed over. Returns Warning if the node is added to the cluster but is waiting for a rebalance. Returns Ok otherwise.

  • couchbase.by_node.health_status:

Returns Critical if the node is unhealthy. Returns Ok otherwise.

Troubleshooting

Need help? Contact Datadog support.

Further Reading