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 🔗
Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform.
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.
Read more on how to Use Smart Agent monitors with the Collector.
See how to set up the Smart Agent receiver.
Learn about config options in Collector default configuration.
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; |
“false” |
Username |
Username required for authentication of CouchDB |
“admin” |
Password |
Password required for authentication of CouchDB |
“admin” |
IncludeMetric |
Metric emitted by |
“metric listed in docs” |
ExcludeMetric |
Metric emitted by |
“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 🔗
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:
Submit a case in the Splunk Support Portal
Available to Splunk Observability Cloud customers
-
Available to Splunk Observability Cloud customers
Ask a question and get answers through community support at Splunk Answers
Available to Splunk Observability Cloud customers and free trial users
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide
Available to Splunk Observability Cloud customers and free trial users
To learn how to join, see Get Started with Splunk Community - Chat groups
To learn about even more support options, see Splunk Customer Success.