Sign inSign up

travix/vault-exporter

By travix

•Updated over 7 years ago

Vault Telemetry and Health Metrics Prometheus Exporter

Image
0

500K+

travix/vault-exporter repository overview

⁠Vault Exporter

Export Hashicorp Vault⁠ health and telemtry metrics to Prometheus⁠.

⁠Exported Health Metrics

MetricMeaningLabels
vault_upWas the last query of Vault successful,
vault_initializedIs the Vault initialised (according to this node).
vault_sealedIs the Vault node sealed.
vault_standbyIs this Vault node in standby.
vault_replication_dr_primaryIs this Vault node a primary disaster recovery replica.
vault_replication_dr_secondaryIs this Vault node a secondary disaster recovery replica.
vault_replication_performance_primaryIs this Vault node a primary performance replica.
vault_replication_performance_secondaryIs this Vault node a secondary performance replica.
vault_infoVarious info about the Vault node.version, cluster_name, cluster_id

Vault Health⁠

⁠Export Telemetry Metrics

Vault Telemetry Metrics⁠

⁠Environment variables

Note that environment variables can be overwritten by flags.

  • VAULT_ADDR – Sets the address of Vault in the client.
  • GCS_BUCKET_NAME – The Google Cloud Storage Bucket where the vault root token is stored.
  • KMS_KEY_ID - The Google Cloud KMS key ID used to encrypt and decrypt the vault root token.

⁠Run Docker Manually

You can download the code and compile the binary with Go. Alternatively, a Docker container is available via the Docker Hub:

  docker run \
  -e VAULT_ADDR="[Vault Address]" \
  -e VAULT_TOKEN="[Vault Token]" \
  -p 9101:9101 travix/vault-exporter
⁠IAM & Permissions

The vault-exporter service uses the official Google Cloud Golang SDK. This means it supports the common ways of [providing credentials to GCP][cloud-creds].

To use this service, the service account must have the following minimum scope(s):

https://www.googleapis.com/auth/cloudkms
https://www.googleapis.com/auth/devstorage.read_write

Additionally, the service account must have the following minimum role(s):

roles/cloudkms.cryptoKeyEncrypterDecrypter
roles/storage.objectAdmin OR roles/storage.legacyBucketWriter

Tag summary

Content type

Image

Digest

Size

111.9 MB

Last updated

over 7 years ago

docker pull travix/vault-exporter