Collect organization metrics

HCP Terraform provides an API endpoint that you can use to gather metrics related to your HCP Terraform organization.

Introduction

When you create a metrics service token, HCP Terraform automatically begins gathering metrics from your organization and makes them available in a Prometheus-compatible format. If your organization has no valid metrics service tokens, HCP Terraform stops gathering metrics until you create a new valid token.

Workflow

To gather metrics from your HCP Terraform organization, complete the following steps:

1. Create a metrics service API token. Refer to Create a metrics service token for more information.
2. Configure your metrics collection software to gather metrics from HCP Terraform. Refer to Gather metrics for more information.

Requirements

To manage your organization's metrics service API token, you must be a member of your organization's owners team. Refer to the Organization owners documentation for more information on the owners team.

Create a metrics service token

To gather metrics from HCP Terraform, you must provide a metrics service token for your organization. Complete the follow steps to generate a metrics service API token:

1. Sign in to HCP Terraform and navigate to your organization.
2. Choose Settings from the sidebar, then API tokens.
3. Choose the Metrics Service Tokens tab.
4. Click Generate a token.
5. Give the token a Name and Expiration.
6. Click Generate.

Save this token in a safe place since HCP Terraform only displays it once. You must present the token to authenticate your metrics collection software.

You can also manage your metrics service API tokens with the HCP Terraform API. Refer to the Metrics service tokens API reference for more information.

Gather metrics

To read metrics from HCP Terraform, configure your metrics collection software to send a GET request with your organization ID and metrics service token to the /metrics endpoint. You must present the metrics service token you generated in Generate metrics service token to call the endpoint.

For example:

global:
  scrape_interval: 15s

scrape_configs:
  - job_name: 'hcp_telemetry'
    scheme: https
    metrics_path: '/telemetry/hcpt/org-XXXXXXXXXXXXX/metrics'

    authorization:
      type: 'Bearer'
      credentials: 'hcpt_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'

    static_configs:
      - targets:
        - 'api.cloud.hashicorp.com:443

Metrics reference

HCP Terraform collects the following metrics: