ContextQMD
Back to Beats

Etcd module [metricbeat-module-etcd]

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

9.4.01.6 KB
Original Source

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

Etcd module [metricbeat-module-etcd]

This module targets Etcd V2 and V3.

When using V2, metrics are collected using Etcd v2 API. When using V3, metrics are retrieved from the /metrics endpoint as intended for Etcd v3

When using V3, metricsest are bundled into metrics When using V2, metricsets available are leader, self and store.

Compatibility [_compatibility_21]

The etcd module is tested with etcd 3.2 and 3.3.

Example configuration [_example_configuration]

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

yaml
metricbeat.modules:
- module: etcd
  metricsets: ["leader", "self", "store"]
  period: 10s
  hosts: ["localhost:2379"]

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: