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 Splunk 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 Use navigators in Splunk Infrastructure Monitoring.
Access the Metric Finder and search for metrics sent by the monitor. For information, see Search the Metric Finder and Metadata Catalog.

Installation 🔗

Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform.
- Install on Kubernetes
- Install on Linux
Download collectd-couchdb in GitHub.
Move the couchdb_plugin.py file to /usr/share/collectd/collectd-couchdb.
Modify the sample configuration file for the plugin in /etc/collectd/managed_config according to the configuration section.
Install the Python requirements:
```
$ sudo pip install -r requirements.txt
```
Restart the OpenTelemetry collector.

Configuration 🔗

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

Include the Smart Agent receiver in your configuration file.
Add the monitor type to the Collector configuration, both in the receiver and pipelines sections.

See how to Use Smart Agent monitors with the Collector.
See how to set up the Smart Agent receiver.
For a list of common configuration options, refer to Common configuration settings for monitors.
Learn more about the Collector at Get started: Understand and use the Collector.

Example 🔗

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

receivers:
  smartagent/couchdb:
    type: couchdb
    ...  # Additional config

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

service:
  pipelines:
    metrics:
      receivers: [smartagent/couchdb]

Configuration settings 🔗

The following table shows the configuration options for this monitor:

Option	Definition	Example value
ModulePath	Path on disk where collectd can find this module.	“/usr/share/collectd/collectd-couchdb/”
Host	Host name of the CouchDB member	“localhost”
Port	Port at which the member can be reached	“5984”
Node	Name of the CouchDB node in the cluster	“couchdb@test_node”
EnhancedMetrics	Boolean; `true` to indicate if the uncommented enhanced metrics in couchdb_metrics.py are needed.	“false”
Username	Username required for authentication of CouchDB	“admin”
Password	Password required for authentication of CouchDB	“admin”
IncludeMetric	Metric emitted by `_stats` api to be activated.	“metric listed in docs”
ExcludeMetric	Metric emitted by `_stats` api to be deactivated.	“metric listed in docs”
Dimension	Space-separated key-value pair for a user-defined dimension	dimension_name dimension_value
Interval	Number of seconds between calls to CouchDB API.	10
ssl_keyfile	Path to the keyfile	“path/to/file”
ssl_certificate	Path to the certificate	“path/to/file”
ssl_ca_certs	Path to the ca file	“path/to/file”

Metrics 🔗

The following metrics are available for this integration:

Notes 🔗

To learn more about the available in Splunk Observability Cloud see Metric types
In host-based subscription plans, default metrics are those metrics included in host-based subscriptions in Splunk Observability Cloud, such as host, container, or bundled metrics. Custom metrics are not provided by default and might be subject to charges. See Metric categories for more information.
In MTS-based subscription plans, all metrics are custom.
To add additional metrics, see how to configure extraMetrics in Add additional metrics

Troubleshooting 🔗

If you are a Splunk Observability Cloud customer and are not able to see your data in Splunk Observability Cloud, you can get help in the following ways.

Available to Splunk Observability Cloud customers

Submit a case in the Splunk Support Portal .
Contact Splunk Support .

Available to prospective customers and free trial users

Ask a question and get answers through community support at Splunk Answers .
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide. To join, see Chat groups in the Get Started with Splunk Community manual.

This page was last updated on Dec 09, 2024.

Related Topics