55 lines
1.1 KiB
Text
55 lines
1.1 KiB
Text
|
////
|
||
|
|
This file is generated! See scripts/docs_collector.py
|
||
|
|
////
|
||
|
|
|
||
|
|
[[metricbeat-module-etcd]]
|
||
|
|
== Etcd module
|
||
|
|
|
||
|
|
beta[]
|
||
|
|
|
||
|
|
This is the Etcd Module. The Etcd module uses https://coreos.com/etcd/docs/latest/v2/api.html [Etcd v2 API] to collect metrics.
|
||
|
|
|
||
|
|
The default metricsets are `leader`, `self` and `store`.
|
||
|
|
|
||
|
|
[float]
|
||
|
|
=== Compatibility
|
||
|
|
|
||
|
|
The etcd module is tested with etcd 3.2.
|
||
|
|
|
||
|
|
|
||
|
|
[float]
|
||
|
|
=== Example configuration
|
||
|
|
|
||
|
|
The Etcd module supports the standard configuration options that are described
|
||
|
|
in <<configuration-metricbeat>>. Here is an example configuration:
|
||
|
|
|
||
|
|
[source,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 <<configuration-ssl>>.
|
||
|
|
It also supports the options described in <<module-http-config-options>>.
|
||
|
|
|
||
|
|
[float]
|
||
|
|
=== Metricsets
|
||
|
|
|
||
|
|
The following metricsets are available:
|
||
|
|
|
||
|
|
* <<metricbeat-metricset-etcd-leader,leader>>
|
||
|
|
|
||
|
|
* <<metricbeat-metricset-etcd-self,self>>
|
||
|
|
|
||
|
|
* <<metricbeat-metricset-etcd-store,store>>
|
||
|
|
|
||
|
|
include::etcd/leader.asciidoc[]
|
||
|
|
|
||
|
|
include::etcd/self.asciidoc[]
|
||
|
|
|
||
|
|
include::etcd/store.asciidoc[]
|
||
|
|
|