dbt Cloud

Supported OS Linux Windows Mac OS

Overview

The Datadog integration with dbt Cloud allows you to collect and visualize key metrics from your dbt runs, models, and tests. By integrating dbt Cloud with Datadog, you can:

  • Monitor the performance and health of your dbt runs.
  • Visualize execution times, compilation times, and status codes for runs, models, and tests.
  • Correlate dbt metrics with data from other services in your stack.

Setup

Prerequisites

  • A dbt Cloud account.
  • An API token with necessary permissions.

Step 1: Generate an API Token in dbt Cloud

  1. In dbt Cloud, go to User Profile > API Tokens > Service Tokens.
  2. Click on + Create Service Token.
  3. Provide a name for the token.
  4. Set the token permissions:
    • For Administrative API metrics: Ensure the token has access to runs and jobs.
    • For Discovery API metrics (optional): Ensure the token has Metadata API privileges, and you’ve enabled the discovery api for your project.
  5. Click Save and copy the generated API Token.

Step 2: Connect your dbt Cloud Account to Datadog

  1. In the Datadog platform, navigate to Integrations.
  2. Search for dbt Cloud and select the integration.
  3. Fill in the account domain, metadata domain (optional), and API token.
  4. Click the Save button to save your settings.

Data Collected

Metrics

dbt_cloud.runs.total
(count)
The total number of dbt runs executed.
Shown as run
dbt_cloud.runs.elapsed_time
(gauge)
The elapsed time of dbt runs in seconds.
Shown as second
dbt_cloud.runs.status_code
(gauge)
The status code of dbt runs.
dbt_cloud.models.execution_time
(gauge)
The execution time of dbt models in seconds.
Shown as second
dbt_cloud.models.compile_time
(gauge)
The compile time of dbt models in seconds.
Shown as second
dbt_cloud.tests.execution_time
(gauge)
The execution time of dbt tests in seconds.
Shown as second
dbt_cloud.tests.compile_time
(gauge)
The compile time of dbt tests in seconds.
Shown as second

Service Checks

The dbt Cloud integration does not include any service checks.

Events

The dbt Cloud integration does not include any events.

Further reading

Additional helpful documentation, links, and articles:

Troubleshooting

Need help? Contact Datadog support for assistance.