You can enrich your alerts by adding properties to tests, models and sources in your .yml
files.
The supported attributes are: owner,
subscribers,
description,
tags.
You can configure and customize your alerts by configuring: custom channel, suppression interval, alert fields(for test alerts only), alert grouping, alert filters.
.yml
filesElementary prioritizes configuration in the following order:
For models / sources:
models
key in dbt_project.yml
.For tests:
tests
key in dbt_project.yml
.meta:
owner: "@jessica.jones"
subscribers: ["@jessica.jones", "@joe.joseph"]
description: "This is the test description"
tags: ["#marketing", "#data_ops"]
channel: data_ops
alert_suppression_interval: 24
slack_group_alerts_by: table
alert_fields: ["description", "owners", "tags", "subscribers", ...]
Elementary enriches alerts with owners for models or tests).
["@jessica.jones", "@joe.joseph"]
).If you want additional users besides the owner to be tagged on an alert, add them as subscribers.
["@jessica.jones", "@joe.joseph"]
).Elementary supports configuring description for tests that are included in alerts. It's recommended to add an explanation of what does it mean if this test fails, so alert will include this context.
You can use tags to provide context to your alerts.
#channel_name
as a tag.Elementary allows you to customize alerts to distribute the right information to the right people. This way you can ensure your alerts are valuable and avoid alert fatigue.
Elementary supports configuring custom Slack channels for models and tests.
By default, Elementary uses the Slack channel that was configured in the Slack integration. Even if
a custom channel is defined for every test, you must specify a default fallback channel, either using
the CLI or the config.yml
file.
Don’t want to get multiple alerts if the same test keeps failing?
You can now configure an alert_suppression_interval
, this is a “snooze” period for alerts on the same issue.
The accepted value is in hours, so 1 day snooze is alert_suppression_interval: 24
.
Elementary won't send new alerts on the same issue that are generated within suppression interval.
Note: if you configure a suppression interval using this method, it will override the value in the global configuration.
By default, Elementary sends a single alert to notify on each failure with extensive information for fast triage.
Elementary also supports grouping alerts by table. In this case, a single Slack notification will be generated containing all issues associated with this table. The created notification will contain a union of the relevant owners, tags and subscribers.
Due to their nature, grouped alerts will contain less information on each issue.
You can decide which fields to include in the alert, and create a format of alert that fits your use case and recipients.
By default, all the fields are included in the alert.
Supported alert fields:
You can choose to enable / disable alert types by adding a var to your dbt_project.yml
.
Vars will be deprecated soon! For OSS users, we recommend filtering the alerts using CLI selectors instead.
Below are the available vars and their default config:
You can enrich your alerts by adding properties to tests, models and sources in your .yml
files.
The supported attributes are: owner,
subscribers,
description,
tags.
You can configure and customize your alerts by configuring: custom channel, suppression interval, alert fields(for test alerts only), alert grouping, alert filters.
.yml
filesElementary prioritizes configuration in the following order:
For models / sources:
models
key in dbt_project.yml
.For tests:
tests
key in dbt_project.yml
.meta:
owner: "@jessica.jones"
subscribers: ["@jessica.jones", "@joe.joseph"]
description: "This is the test description"
tags: ["#marketing", "#data_ops"]
channel: data_ops
alert_suppression_interval: 24
slack_group_alerts_by: table
alert_fields: ["description", "owners", "tags", "subscribers", ...]
Elementary enriches alerts with owners for models or tests).
["@jessica.jones", "@joe.joseph"]
).If you want additional users besides the owner to be tagged on an alert, add them as subscribers.
["@jessica.jones", "@joe.joseph"]
).Elementary supports configuring description for tests that are included in alerts. It's recommended to add an explanation of what does it mean if this test fails, so alert will include this context.
You can use tags to provide context to your alerts.
#channel_name
as a tag.Elementary allows you to customize alerts to distribute the right information to the right people. This way you can ensure your alerts are valuable and avoid alert fatigue.
Elementary supports configuring custom Slack channels for models and tests.
By default, Elementary uses the Slack channel that was configured in the Slack integration. Even if
a custom channel is defined for every test, you must specify a default fallback channel, either using
the CLI or the config.yml
file.
Don’t want to get multiple alerts if the same test keeps failing?
You can now configure an alert_suppression_interval
, this is a “snooze” period for alerts on the same issue.
The accepted value is in hours, so 1 day snooze is alert_suppression_interval: 24
.
Elementary won't send new alerts on the same issue that are generated within suppression interval.
Note: if you configure a suppression interval using this method, it will override the value in the global configuration.
By default, Elementary sends a single alert to notify on each failure with extensive information for fast triage.
Elementary also supports grouping alerts by table. In this case, a single Slack notification will be generated containing all issues associated with this table. The created notification will contain a union of the relevant owners, tags and subscribers.
Due to their nature, grouped alerts will contain less information on each issue.
You can decide which fields to include in the alert, and create a format of alert that fits your use case and recipients.
By default, all the fields are included in the alert.
Supported alert fields:
You can choose to enable / disable alert types by adding a var to your dbt_project.yml
.
Vars will be deprecated soon! For OSS users, we recommend filtering the alerts using CLI selectors instead.
Below are the available vars and their default config: