Docs » Available host and application monitors » Configure application receivers for databases » Apache CouchDB

Apache CouchDB 🔗

The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the Apache CouchDB monitor type to monitor metrics from CouchDB instances by calling the _stats endpoint for instances.

This integration is only available on Kubernetes and Linux.

Benefits 🔗

After you configure the integration, you can access these features:

  • View metrics. You can create your own custom dashboards, and most monitors provide built-in dashboards as well. For information about dashboards, see View dashboards in Observability Cloud.

  • View a data-driven visualization of the physical servers, virtual machines, AWS instances, and other resources in your environment that are visible to Infrastructure Monitoring. For information about navigators, see Splunk Infrastructure Monitoring navigators.

  • Access the Metric Finder and search for metrics sent by the monitor. For information, see Use the Metric Finder.

Installation 🔗

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

  2. Download collectd-couchdb in GitHub.

  3. Move the file to /usr/share/collectd/collectd-couchdb.

  4. Modify the sample configuration file for the plugin in /etc/collectd/managed_config according to the Configuration section.

  5. Install the Python requirements:

    $ sudo pip install -r requirements.txt
  6. Restart the OpenTelemetry collector.

Configuration 🔗

To use this integration of a Smart Agent monitor with the Collector:

  1. Include the Smart Agent receiver in your configuration file.

  2. Add the monitor type to the Collector configuration, both in the receiver and pipelines sections.

Example 🔗

To activate this integration, add the following to your Collector configuration:

    type: couchdb
    ...  # Additional config

Next, add the monitor to the service > pipelines > metrics > receivers section of your configuration file:

      receivers: [smartagent/couchdb]

Configuration settings 🔗

The following table shows the configuration options for this monitor:



Example value


Path on disk where collectd can find this module.



Host name of the CouchDB member



Port at which the member can be reached



Name of the CouchDB node in the cluster



Boolean; true to indicate if the uncommented enhanced metrics in are needed.



Username required for authentication of CouchDB



Password required for authentication of CouchDB



Metric emitted by _stats api to be activated.

“metric listed in docs”


Metric emitted by _stats api to be deactivated.

“metric listed in docs”


Space-separated key-value pair for a user-defined dimension

dimension_name dimension_value


Number of seconds between calls to CouchDB API.



Path to the keyfile



Path to the certificate



Path to the ca file


Metrics 🔗

The following metrics are available for this integration:

Notes 🔗

  • Learn more about the available metric types in Observability Cloud.

  • Default metrics are those metrics included in host-based subscriptions in Observability Cloud, such as host, container, or bundled metrics. Custom metrics are not provided by default and might be subject to charges. See more about metric categories.

  • To add additional metrics, see how to configure extraMetrics using the Collector.

Troubleshooting 🔗

If you are not able to see your data in Splunk Observability Cloud, try these tips:

To learn about even more support options, see Splunk Customer Success.