vaultbeat

README

vaultbeat

vaultbeat is a beat based on metricbeat, which collects performance metrics and statistics from Hashicorp's Vault.

Getting started

Gathering metrics from vault is as easy as running one command:

./vaultbeat -e -c vaultbeat.yml

For all available configuration options, see the example vaultbeat.yml file.

Running vaultbeat in Docker

An official docker container is provided on dockerhub. You can run the container by mounting a custom configuration like this:

docker run -d --rm --net=host --name vaultbeat -v /root/vaultbeat.yml:/root/vaultbeat.yml  msvechla/vaultbeat -e -d "*"

Get the latest release

In addition to the Docker Image, there are automated builds for all major platforms. You can find all releases in the tags section. Simply click on downloads and select "artifacts" to get the desired version. Alternatively feel free to build the latest release from master yourself.

Available Metricsets

Vaultbeat currently supports two metricsets: statsd and sys_health.

Statsd MetricSet

The statsd metricset utilizes vaults telemetry endpoint to gather performance data.

The following configuration options are available:

Configuratio Option	Description
statsd_address	Specifies the address of the statsd endpoint specified in vault.
vault_hostname	Hostname of the vault instance, used for formatting statsd events correctly.

Sys_health MetricSet

The sys_health metricset connects to vaults /sys/health API, to check vaults health status and exports them in an easy to visualize format.

General Configuration Options

See the official vault environment variables for all available configuration options. Simply specify them in the vaultbeat.yml as usual. Be sure to write them in all lowercase, e.g. vault_cacert. For examples see here.

Bundled Kibana Dashboard