Collect Terraform Enterprise metrics with Prometheus and Grafana

15min
|
Enterprise
Terraform

Terraform Enterprise is critical infrastructure for many businesses. You can proactively monitor your Terraform Enterprise instance's performance by enabling its built-in metrics endpoint and connecting it to your monitoring system. These steps will help you prevent issues and outages, which can be disruptive and costly.

The metrics provided by Terraform Enterprise let you identify which worker containers exist at any given time, monitor their performance in order to troubleshoot and prevent run issues, and make informed run concurrency and capacity constraint decisions.

In this tutorial you will enable usage-metric collection in Terraform Enterprise and provision an instance running Prometheus and Grafana. Then you will configure Prometheus to scrape metrics from your Terraform Enterprise deployment and visualize them on a Grafana dashboard.

Note

You will send Terraform Enterprise metrics including run_type, run_id, workspace_name, and organization_name to a demo Prometheus and Grafana instance. If your organization treats this data as sensitive, check with your security team before running the tutorial.

Prerequisites

This tutorial assumes that you are familiar with Terraform Enterprise and the standard Terraform workflow. If you are new to Terraform, complete the Get Started tutorials first. If you are new to Terraform Enterprise, read the Terraform Enterprise documentation first.

For this tutorial, you will need:

An existing Terraform Enterprise deployment in standalone mode in AWS, running version 202207-1 or newer, with ports 9090 and 9091 available. You will also need administrator access to your Terraform Enterprise dashboard.
The Terraform CLI (1.1.0+) installed.
An AWS account with credentials set as local environment variables.

Note

This tutorial will provision resources that qualify under the AWS free-tier. If your account does not qualify under the AWS free-tier, we are not responsible for any charges that you may incur.

Enable TFE metrics endpoint

Open the Settings page, and click on Metrics.