Docs » Configure application receivers » Configure application receivers for hosts and servers » Couchbase server

Couchbase server 🔗

Description 🔗

The Splunk Distribution of OpenTelemetry Collector provides this integration as the Couchbase server monitor with the SignalFx Smart Agent receiver. The integration collects metrics from Couchbase servers.

To see the monitor source, view the signalfx-agent project on GitHub.

Installation 🔗

Follow these steps to deploy the integration:

  1. Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform.

  2. Complete the Configuration.

Configuration 🔗

The Splunk Distribution of OpenTelemetry Collector allows embedding a Smart Agent monitor configuration in an associated Smart Agent Receiver instance.

Note: Providing a Couchbase server monitor entry in your Smart Agent or Collector configuration is required for its use. Use the appropriate form for your agent type.

Smart Agent 🔗

To activate this monitor in the Smart Agent, add the following to your agent configuration:

monitors:  # All monitor config goes under this key
 - type: collectd/couchbase
   ...  # Additional config

See Smart Agent example configuration for an autogenerated example of a YAML configuration file, with default values where applicable.

Splunk Distribution of OpenTelemetry Collector 🔗

To activate this monitor in the OpenTelemetry Collector, add the following to your agent configuration:

receivers:
    smartagent/couchbase:
        type: collectd/couchbase
        ...  # Additional config

To complete the monitor activation, you must also include the smartagent/couchbase receiver item in a metrics pipeline. To do this, add the receiver item to the service > pipelines > metrics > receivers section of your configuration file.

See configuration examples for specific use cases that show how the collector can integrate and complement existing environments.

Metrics 🔗

The integration emits some metrics about the bucket’s performance across the cluster, and some metrics about the bucket’s performance per node. Metrics beginning with gauge.bucket.basic.* and gauge.bucket.quota.* are reported once per cluster. All other bucket metrics (gauge.bucket.*) are reported by every node that hosts that bucket. To analyze bucket performance for the entire bucket, apply functions like Sum or Mean to group node-level metrics together by bucket.