docs-v2/content/telegraf/v1/input-plugins/consul_agent/_index.md

2.1 KiB

description menu tags introduced os_support related
Telegraf plugin for collecting metrics from Hashicorp Consul Agent
telegraf_v1_ref
parent name identifier
input_plugins_reference Hashicorp Consul Agent input-consul_agent
Hashicorp Consul Agent
input-plugins
configuration
server
v1.22.0 freebsd, linux, macos, solaris, windows
/telegraf/v1/configure_plugins/
https://github.com/influxdata/telegraf/tree/v1.36.1/plugins/inputs/consul_agent/README.md, Hashicorp Consul Agent Plugin Source

Hashicorp Consul Agent Input Plugin

This plugin collects metrics from a Consul agent. Telegraf may be present in every node and connect to the agent locally. Tested on Consul v1.10.

Introduced in: Telegraf v1.22.0 Tags: server OS support: all

Global configuration options

In addition to the plugin-specific configuration settings, plugins support additional global and plugin configuration settings. These settings are used to modify metrics, tags, and field or create aliases and configure ordering, etc. See the CONFIGURATION.md for more details.

Configuration

# Read metrics from the Consul Agent API
[[inputs.consul_agent]]
  ## URL for the Consul agent
  # url = "http://127.0.0.1:8500"

  ## Use auth token for authorization.
  ## If both are set, an error is thrown.
  ## If both are empty, no token will be used.
  # token_file = "/path/to/auth/token"
  ## OR
  # token = "a1234567-40c7-9048-7bae-378687048181"

  ## Set timeout (default 5 seconds)
  # timeout = "5s"

  ## Optional TLS Config
  # tls_ca = /path/to/cafile
  # tls_cert = /path/to/certfile
  # tls_key = /path/to/keyfile

Metrics

Consul collects various metrics. For every details, please have a look at Consul's documentation.

Example Output