﻿---
title: CouchDB module
description: This is the couchdb module. The default metricset is server. The Couchdb module is tested in CI with Couchdb 1.7 and 2.3. Because of the differences between...
url: https://www.elastic.co/elastic/docs-builder/docs/2620/reference/beats/metricbeat/metricbeat-module-couchdb
products:
  - Beats
  - Metricbeat
applies_to:
  - Elastic Stack: Generally available in 9.0+
---

# CouchDB module
This is the couchdb module.
The default metricset is `server`.

## Compatibility

The Couchdb module is tested in CI with Couchdb 1.7 and 2.3. Because of the differences between v1 and v2 for exposing metrics, the path to request metrics for each version is different:
- v1.* uses `[host]:5984/_stats` so the hosts of your config should just be `[host]:5984`
- v2.* exposes metrics in various places. Local in `[host]:5986/_stats` and cluster wide in `[host]:5984/_node/[node-name]/_stats` or `[host]:5984/_node/_local/_stats`. Recommended config is `[host]:5986` to use the local path (double check that you are using port `5986`) or to use the full path on `5984`  `[host]:5984/_node/[node name or _local]/_stats`


## Dashboard

The CouchDB module comes with a predefined dashboard for CouchDB database specific stats. For example:
![metricbeat couchdb overview](https://www.elastic.co/elastic/docs-builder/docs/2620/reference/beats/metricbeat/images/metricbeat-couchdb-overview.png)

## Example configuration

The CouchDB module supports the standard configuration options that are described in [Modules](https://www.elastic.co/elastic/docs-builder/docs/2620/reference/beats/metricbeat/configuration-metricbeat). Here is an example configuration:
```yaml
metricbeat.modules:
- module: couchdb
  metricsets: ["server"]
  period: 10s
  hosts: ["localhost:5984"]
```

This module supports TLS connections when using `ssl` config field, as described in [SSL](https://www.elastic.co/elastic/docs-builder/docs/2620/reference/beats/metricbeat/configuration-ssl). It also supports the options described in [Standard HTTP config options](/elastic/docs-builder/docs/2620/reference/beats/metricbeat/configuration-metricbeat#module-http-config-options).

## Metricsets

The following metricsets are available:
- [server](https://www.elastic.co/elastic/docs-builder/docs/2620/reference/beats/metricbeat/metricbeat-metricset-couchdb-server)