> ## Documentation Index
> Fetch the complete documentation index at: https://otel.fyi/llms.txt
> Use this file to discover all available pages before exploring further.

# Couchdb

> OpenTelemetry receiver for Couchdb

# Couchdb Receiver

![Status](https://img.shields.io/badge/status-beta-yellow)

**Available in:** `contrib`

**Maintainers:** [@antonblock](https://github.com/antonblock)

**Source:** [opentelemetry-collector-contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/couchdbreceiver)

## Supported Telemetry

![Metrics](https://img.shields.io/badge/metrics-beta-green)

## Overview

## 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](https://pkg.go.dev/time#ParseDuration). Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`.

### Example Configuration

```yaml theme={null}
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 in [config.go](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/couchdbreceiver/config.go) with detailed sample configurations in [testdata/config.yaml](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/couchdbreceiver/testdata/config.yaml). TLS config is documented further under the [opentelemetry collector's configtls package](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md).

## Metrics

Details about the metrics produced by this receiver can be found in [metadata.yaml](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/couchdbreceiver/metadata.yaml)

## Metrics

| Metric Name                      | Description                               | Unit          | Type          | Attributes        |
| -------------------------------- | ----------------------------------------- | ------------- | ------------- | ----------------- |
| ✅ `couchdb.average_request_time` | The average duration of a served request. | ms            | Gauge         |                   |
| ✅ `couchdb.database.open`        | The number of open databases.             | \{databases}  | UpDownCounter |                   |
| ✅ `couchdb.database.operations`  | The number of database operations.        | \{operations} | Counter       | operation         |
| ✅ `couchdb.file_descriptor.open` | The number of open file descriptors.      | \{files}      | UpDownCounter |                   |
| ✅ `couchdb.httpd.bulk_requests`  | The number of bulk requests.              | \{requests}   | Counter       |                   |
| ✅ `couchdb.httpd.requests`       | The number of HTTP requests by method.    | \{requests}   | Counter       | http.method       |
| ✅ `couchdb.httpd.responses`      | The number of each HTTP status code.      | \{responses}  | Counter       | http.status\_code |
| ✅ `couchdb.httpd.views`          | The number of views read.                 | \{views}      | Counter       | view              |

## Attributes

| Attribute Name     | Description             | Type   | Values                                                    |
| ------------------ | ----------------------- | ------ | --------------------------------------------------------- |
| `http.method`      | An HTTP request method. | string | `COPY`, `DELETE`, `GET`, `HEAD`, `OPTIONS`, `POST`, `PUT` |
| `http.status_code` | An HTTP status code.    | string |                                                           |
| `operation`        | The operation type.     | string | `writes`, `reads`                                         |
| `view`             | The view type.          | string | `temporary_view_reads`, `view_reads`                      |

## Resource Attributes

| Attribute Name      | Description           | Type   | Enabled |
| ------------------- | --------------------- | ------ | ------- |
| `couchdb.node.name` | The name of the node. | string | ✅       |

## Configuration

### Example Configuration

```yaml theme={null}
couchdb:
  endpoint: http://localhost:5984
  username: otelu
  password: ${env:COUCHDB_PASSWORD}
  collection_interval: 60s
```

***

*Last generated: 2026-07-06*