Configure HCP Vault metric streaming to DataDog

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

Prerequisites

To configure metrics streaming to Datadog, you will need to have:

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

• A production grade HCP Vault cluster

• Your Datadog region and API key

  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 DataDog as the provider and click Next.

5. Under Datadog configuration, enter your API Key and select the Datadog site region that matches your existing Datadog environment.

6. Click Save.

   Note

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

7. Once the metrics have been enabled, navigate to Datadog, and enable the integration by clicking Install on the integration tile. This will install a sample HCP Vault dashboard, that comes with preset visualization widgets to help make the most of your HCP Vault telemetry. You can find the dashboard by searching for HCP Vault Overview from the dashboard list.

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 {
    datadog_api_key = "actual-api-key"
    datadog_region = "region"
  }
}

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.