Datadog alerts

circle-info

Paradime integrates natively with Elementary CLI to enable you to generate report and/or send alerts using the Bolt scheduler out of the box. No additional installation required.

Elementary sends alerts to Datadog by creating incidents with detailed information about data quality issues, test failures, and model errors. Each alert becomes a structured incident in your Datadog dashboard with appropriate severity levels and metadata.

1. Get Datadog API Credentials

To send incidents to Datadog, you'll need both an API key and an Application key.

Get your API Key

  1. Log in to your Datadog account

  2. Navigate to Organization SettingsAPI Keys

  3. Click + New Key to create a new API key

  4. Give it a descriptive name like "Elementary Integration"

  5. Copy the API key — you'll need this later

Get your Application Key

  1. In Organization Settings, go to Application Keys

  2. Click + New Key to create a new application key

  3. Give it a descriptive name like "Elementary Integration"

  4. Copy the application key — you'll need this later

Ensure Application Key has the below permissions

  1. incident_notification_settings_read

  2. incident_read

  3. incident_write

  4. teams_read

  5. user_access_read

Identify your Datadog Site

Your Datadog site depends on your region. You can check your site by looking at your Datadog URL when logged in.

Region
Site

US1 (default)

datadoghq.com

US3

us3.datadoghq.com

US5

us5.datadoghq.com

EU1

datadoghq.eu

AP1

ap1.datadoghq.com

GOV

ddog-gov.com


2. Configure the Integration

Pass your credentials directly when running edr monitor. You should use environment variables in the Bolt command, as describe here for secrets.

Available CLI options:

Option
Short flag
Description

--datadog-api-key

-dak

Your Datadog API key

--datadog-application-key

-dapp

Your Datadog Application key

--datadog-site

-ds

Your Datadog site (e.g., datadoghq.com)

--datadog-default-severity

-dsev

Default incident severity (SEV-1 to SEV-5)


3. Test your Integration

Run the following command to create a test incident in your Datadog account and verify the integration is configured correctly:

If successful, you'll see a test incident created in your Datadog dashboard under Incidents, including sample error details, metadata, and all configured notification settings.


4. Execute the CLI

Once configured, run the following command after your dbt runs and tests:


Alert on Source Freshness Failures

Not supported in dbt Cloud.

To alert on source freshness failures, run edr run-operation upload-source-freshness immediately after each execution of dbt source freshness. This operation uploads the results to a table, and the subsequent edr monitor execution will send the alert as a Datadog incident.

Keep the following in mind:

  • dbt source freshness and upload-source-freshness must run from the same machine.

  • upload-source-freshness requires the --project-dir argument to be passed.


Continuous Alerting

To monitor continuously, use your orchestrator to run edr monitor on a regular schedule. We recommend running it right after your dbt job ends to catch the latest data updates as quickly as possible.

Last updated

Was this helpful?