Back to Beats

Couchbase module [metricbeat-module-couchbase]

docs/reference/metricbeat/metricbeat-module-couchbase.md

9.4.01.5 KB
Original Source

% This file is generated! See metricbeat/scripts/mage/docs_collector.go

Couchbase module [metricbeat-module-couchbase]

This module periodically fetches metrics from Couchbase servers. The default metricsets are bucket, cluster, node.

Compatibility [_compatibility_14]

The Couchbase module is tested with Couchbase 6.5.1.

Dashboard [_dashboard_24]

The Couchbase module comes with a predefined dashboard for Couchbase cluster, node, bucket specific stats. For example:

Example configuration [_example_configuration]

The Couchbase module supports the standard configuration options that are described in Modules. Here is an example configuration:

yaml
metricbeat.modules:
- module: couchbase
  metricsets: ["bucket", "cluster", "node"]
  period: 10s
  hosts: ["localhost:8091"]
  enabled: true

This module supports TLS connections when using ssl config field, as described in SSL. It also supports the options described in Standard HTTP config options.

Metricsets [_metricsets]

The following metricsets are available: