Apache CouchDB OpenTelemetry Assets

Apache CouchDB is an open-source NoSQL document database that exposes a RESTful HTTP API for all operations. This content pack provides dashboards, alert rules, and SLO templates for CouchDB metrics collected using the OpenTelemetry CouchDB receiver, covering latency, traffic, errors, and saturation.

The CouchDB OpenTelemetry assets have been tested with:

OpenTelemetry CouchDB receiver v0.145.0

• CouchDB 3.5.1

You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it. You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware.

The CouchDB receiver scrapes metrics from the /_node/{node-name}/_stats/couchdb endpoint. Ensure CouchDB is running and the collector host can reach it. Create a CouchDB user with read access to the stats endpoint, or use an existing admin account. No additional CouchDB configuration is required — the stats API is enabled by default.

Configure the OpenTelemetry Collector (or Elastic Distribution of OpenTelemetry Collector) to receive CouchDB metrics and export them to Elasticsearch. Use the following placeholders in the configuration:

• <COUCHDB_ENDPOINT> — CouchDB base URL (for example, http://localhost:5984).
• <COUCHDB_USERNAME> — CouchDB username for authentication.
• <COUCHDB_PASSWORD> — CouchDB password. Use env:COUCHDB_PASSWORD and set the variable in your environment.
• <ES_ENDPOINT> — Elasticsearch ingest endpoint (for example, https://elasticsearch:9200).
• <ES_API_KEY> — Elasticsearch API key for authentication. Prefer env:ES_API_KEY and set the variable in your environment.

receivers:
  couchdb:
    endpoint: <COUCHDB_ENDPOINT>
    username: <COUCHDB_USERNAME>
    password: ${env:COUCHDB_PASSWORD}
    collection_interval: 10s

exporters:
  elasticsearch/otel:
    endpoints: [<ES_ENDPOINT>]
    api_key: ${env:ES_API_KEY}
    mapping:
      mode: otel

service:
  pipelines:
    metrics:
      receivers: [couchdb]
      exporters: [elasticsearch/otel]

Refer to the metadata.yaml of the OpenTelemetry CouchDB receiver for details on available metrics.

This integration includes one or more Kibana dashboards that visualizes the data collected by the integration. The screenshots below illustrate how the ingested data is displayed.