docs/reference/metricbeat/metricbeat-module-consul.md
% This file is generated! See metricbeat/scripts/mage/docs_collector.go
::::{warning} This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features. ::::
This is the Hashicorp’s Consul Metricbeat module. It is still in beta and under active development to add new Metricsets and introduce enhancements.
The module is being tested with 1.4.2 and 1.9.3 versions of Consul.
The Consul module comes with a predefined dashboard:
The Consul module supports the standard configuration options that are described in Modules. Here is an example configuration:
metricbeat.modules:
- module: consul
metricsets:
- agent
enabled: true
period: 10s
hosts: ["localhost:8500"]
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.
The following metricsets are available:
stack: beta