README.md 2.8 KB

CouchDB Receiver

Status
Stability beta: metrics
Distributions contrib, observiq, sumo
Issues Open issues Closed issues
Code Owners @djaglowski

This receiver fetches stats from a couchdb server using the /_node/{node-name}/_stats/couchdb endpoint.

Prerequisites

This receiver supports Couchdb versions 2.3+ and 3.1+.

Configuration

The following settings are required:

  • username
  • password

The following settings are optional:

  • endpoint (default: http://localhost:5984): The URL of the couchdb endpoint

  • collection_interval (default = 60s): This receiver collects metrics on an interval. This value must be a string readable by Golang's time.ParseDuration. Valid time units are ns, us (or µs), ms, s, m, h.

Example Configuration

receivers:
  couchdb:
    endpoint: http://localhost:5984
    username: otelu
    password: ${env:COUCHDB_PASSWORD}
    collection_interval: 60s

The full list of settings exposed for this receiver are documented here with detailed sample configurations here. TLS config is documented further under the opentelemetry collector's configtls package.

Metrics

Details about the metrics produced by this receiver can be found in metadata.yaml