Configure HCP Vault metric streaming to Grafana Cloud

For details on metrics scope and interpretation, see the HCP Vault metrics documentation.

Prerequisites

To configure metrics streaming to Grafana Cloud, you will need to have:

• A HCP account with Admin or Contributor role assigned in HCP

• A production grade HCP Vault cluster

• Grafana Cloud account

  Note

  If you do not have a cluster running, refer to the Create a Vault Cluster on HCP or the Deploy HCP Vault with Terraform tutorial to create an HCP Vault cluster.

Enable metrics streaming

1. Log in to the HCP Portal and navigate to the Vault clusters page.

2. Click the Vault cluster you wish to enable streaming for and click Metrics.

3. Click Enable metric streaming.

4. From the Stream Vault metrics view, select Grafana Cloud as the provider and click Next.

5. Under Grafana Cloud configuration, enter your Grafana Cloud Endpoint, Grafana Cloud user, and Grafana Cloud password.

6. Click Save.

   Note

   At this time, HCP Vault only supports metrics streaming to one metrics endpoint at a time.

7. To expedite monitoring configuration, HashiCorp has created a sample HCP Vault Grafana dashboard template for metrics visualizations. If you prefer to use the sample dashboard template, follow the Grafana Cloud instructions for adding a Grafana dashboard template to your Grafana Cloud environment.

Example Terraform configuration (optional)

Refer to the Terraform Registry hcp_vault_cluster documentation for more information.

resource "hcp_vault_cluster" "example" {
  cluster_id = "vault-cluster"
  hvn_id     = hcp_hvn.example.hvn_id
  tier       = "standard_large"
  metrics_config {
    grafana_user = "actual-user"
    grafana_password = "actual-password"
    grafana_endpoint = "actual-url"
  }
}

Edit the metrics streaming configuration (optional)

To edit a metrics streaming integration, perform the following steps.

1. From the Metrics page, click on the Manage drop-down, then Edit configuration.

2. Edit the configuration, then click Save.

Disable metrics streaming (optional)

To disable a metrics streaming integration, from the Metrics page, click on the Manage drop-down, then Disable streaming.