telegraf/plugins/inputs/consul_agent
Sven Rebhan 97d10a5ee9
fix(internal): Fix time parsing for abbreviated timezones (#13363)
2023-06-02 10:05:55 -06:00
..
testdata fix: rename consul_metrics -> consul_agent (#10876) 2022-03-23 09:27:37 -06:00
README.md docs: Update all readme to pass linter (#12615) 2023-02-09 11:04:41 +01:00
consul_agent.go fix(internal): Fix time parsing for abbreviated timezones (#13363) 2023-06-02 10:05:55 -06:00
consul_agent_test.go chore: remove deprecated io/ioutils (#11678) 2022-09-20 09:37:14 -06:00
consul_structs.go fix: rename consul_metrics -> consul_agent (#10876) 2022-03-23 09:27:37 -06:00
sample.conf chore(inputs_a-l): migrate sample configs into separate files (#11132) 2022-05-18 11:31:52 -05:00

README.md

Hashicorp Consul Agent Metrics Input Plugin

This plugin grabs metrics from a Consul agent. Telegraf may be present in every node and connect to the agent locally. In this case should be something like http://127.0.0.1:8500.

Tested on Consul 1.10.4 .

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 following documentation:

Example Output