Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.elementary-data.com/llms.txt

Use this file to discover all available pages before exploring further.

Most alert settings can be managed directly in the Elementary Cloud UI — no code changes needed. Code configuration is useful when you want settings version-controlled or need to apply them in bulk across many assets.
You can enrich and route alerts by adding properties to your models, sources, and tests in .yml files. Elementary prioritizes configuration in the following order: For models / sources:
  1. Model config block
  2. Model properties
  3. Model path configuration under models key in dbt_project.yml
For tests:
  1. Test properties
  2. Tests path configuration under tests key in dbt_project.yml
  3. Parent model configuration

​
Owners

An owner is the person responsible for the model or test. Owners are tagged in alerts and shown throughout the UI. Owners can also be added or edited directly in the Catalog. Elementary enriches alerts with owners for models or tests).
  • If you want the owner to be tagged on slack use ’@’ and the email prefix of the slack user (@jessica.jones to tag [email protected]).
  • You can configure a single owner or a list of owners (["@jessica.jones", "@joe.joseph"]).
models:
  - name: my_model_name
    config:
      meta:
        owner: "@jessica.jones"

​
Subscribers

Subscribers are additional users who should be notified on alerts for a model or test, beyond the owner. If you want additional users besides the owner to be tagged on an alert, add them as subscribers.
  • If you want the subscriber to be tagged on slack use ’@’ and the email prefix of the slack user (@jessica.jones to tag [email protected]).
  • You can configure a single subscriber or a list (["@jessica.jones", "@joe.joseph"]).
models:
  - name: my_model_name
    config:
      meta:
        subscribers: "@jessica.jones"

​
Description

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. 
data_tests:
  - not_null:
    config:
      meta:
        description: "This is the test description"

​
Tags

You can use tags to provide context to your alerts.
  • You can tag a group or a channel in a slack alert by adding #channel_name as a tag.
  • Tags are aggregated,so a test alert will include both the test and the parent model tags.
models:
  - name: my_model_name
    tags: ["#marketing", "#data_ops"]

​
Alert distribution

​
Custom channel

Route alerts for a specific model or test to a dedicated Slack channel. You must always configure a default fallback channel in your integration settings. 
models:
  - name: my_model_name
    config:
      meta:
        channel: data_ops

​
Suppression interval

Prevent repeated alerts for the same ongoing issue. Set a snooze period in hours — Elementary won’t send new alerts on the same issue within that window. 
models:
  - name: my_model_name
    config:
      meta:
        alert_suppression_interval: 24

​
Group alerts by table

By default, Elementary sends one alert per failure. You can instead group all failures for a table into a single notification. Grouped alerts include a union of owners, tags, and subscribers but contain less detail per issue. 
models:
  - name: my_model_name
    config:
      meta:
        slack_group_alerts_by: table

​
Alert fields

Currently supported for test alerts only.
Control which fields appear in the alert. All fields are included by default. Supported fields: table, column, description, owners, tags, subscribers, result_message, test_parameters, test_query, test_results_sample 
models:
  - name: my_model_name
    config:
      meta:
        alert_fields: ["description", "owners", "tags", "subscribers"]