To find out if this integration is available in your organization, see your Datadog Integrations page or ask your organization administrator.
To initiate an exception request to enable this integration for your organization, email support@ddog-gov.com.
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
- In dbt Cloud, go to User Profile > API Tokens > Service Tokens.
- Click on + Create Service Token.
- Provide a name for the token.
- Set the token permissions:
- For Administrative API metrics (Job run metrics): Ensure the token has access to runs and jobs.
- For Discovery API metrics (Models and Tests metrics): Ensure the token has Metadata API privileges, and you’ve enabled the Discovery API for your project.
- Click Save and copy the generated API Token.
Step 2: Connect your dbt Cloud Account to Datadog
- Add your account ID, account URL, and API token.
- Optional: For Discovery API metrics, add your metadata URL.
- Click the Save button to save your settings.
Once enabled, data from your current and recent dbt runs and model executions should be available within ten minutes.
Data Observability
To monitor your account using the Data Observability product, see Configure webhooks.
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.runs.failures
(count) | Count of failed dbt job 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.
Troubleshooting
Need help? Contact Datadog support for assistance.
Further Reading
Additional helpful documentation, links, and articles:
