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

description	menu	tags	introduced	os_support	related
Telegraf plugin for collecting metrics from Hashicorp Vault	telegraf_v1_ref parent name identifier input_plugins_reference Hashicorp Vault input-vault	Hashicorp Vault 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/vault/README.md, Hashicorp Vault Plugin Source

Hashicorp Vault Input Plugin

This plugin collects metrics from every Vault agent of a cluster.

[!NOTE] This plugin requires Vault v1.8.5+

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 Vault API
[[inputs.vault]]
  ## URL for the Vault agent
  # url = "http://127.0.0.1:8200"

  ## Use Vault token for authorization.
  ## Vault token configuration is mandatory.
  ## If both are empty or both are set, an error is thrown.
  # token_file = "/path/to/auth/token"
  ## OR
  token = "s.CDDrgg5zPv5ssI0Z2P4qxJj2"

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

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

Metrics

For a more deep understanding of Vault monitoring, please have a look at the following Vault telemetry and monitoring documentation.

Example Output

vault.raft.replication.appendEntries.logs,peer_id=clustnode-02 count=130i,max=1i,mean=0.015384615384615385,min=0i,rate=0.2,stddev=0.12355304447984486,sum=2i 1638287340000000000
vault.core.unsealed,cluster=vault-cluster-23b671c7 value=1i 1638287340000000000
vault.token.lookup count=5135i,max=16.22449493408203,mean=0.1698389152269865,min=0.06690400093793869,rate=87.21228296905755,stddev=0.24637634000854705,sum=872.1228296905756 1638287340000000000