# CouchDB

### Supported Platforms

| Platform | Metrics | Logs | Traces |
| -------- | ------- | ---- | ------ |
| Linux    | ✓       | ✓    |        |
| Windows  | ✓       | ✓    |        |
| macOS    | ✓       | ✓    |        |

### Configuration Table

| Parameter            | Type                | Default                        | Description                                                                                                                                              |
| -------------------- | ------------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| telemetry\_types     | `telemetrySelector` | `["Logs", "Metrics"]`          | Choose Telemetry Type.                                                                                                                                   |
| hostname\*           | `string`            |                                | The hostname or IP address of the CouchDB system.                                                                                                        |
| port                 | `int`               | 5984                           | The TCP port of the CouchDB system.                                                                                                                      |
| username\*           | `string`            |                                | The username to use when connecting to CouchDB.                                                                                                          |
| password\*           | `string`            |                                | The password to use when connecting to CouchDB.                                                                                                          |
| collection\_interval | `int`               | 60                             | Sets how often (seconds) to scrape for metrics.                                                                                                          |
| enable\_tls          | `bool`              | false                          | Whether or not to use TLS when connecting to CouchDB.                                                                                                    |
| strict\_tls\_verify  | `bool`              | false                          | Enable to require TLS certificate verification.                                                                                                          |
| ca\_file             | `string`            |                                | Certificate authority used to validate TLS certificates. It's not required if the collector's operating system already trusts the certificate authority. |
| mutual\_tls          | `bool`              | false                          | Enable to require TLS mutual authentication.                                                                                                             |
| cert\_file           | `string`            |                                | A TLS certificate used for client authentication if mutual TLS is enabled.                                                                               |
| key\_file            | `string`            |                                | A TLS private key used for client authentication if mutual TLS is enabled.                                                                               |
| log\_paths           | `strings`           | "/var/log/couchdb/couchdb.log" | Path to CouchDB log file(s).                                                                                                                             |
| start\_at            | `enum`              | end                            | Start reading the file from the 'beginning' or 'end'.                                                                                                    |

<mark style="color:red;">\*</mark>*<mark style="color:red;">required field</mark>*


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.bindplane.com/integrations/sources/couchdb.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.