-
Notifications
You must be signed in to change notification settings - Fork 975
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
update model level to ga #6581
Merged
Merged
update model level to ga #6581
Changes from 14 commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
8dbb316
remove beta
mirnawong1 f2f1ff7
Merge branch 'current' into mwong-model-level-ga
mirnawong1 a8c0aaa
Merge branch 'current' into mwong-model-level-ga
mirnawong1 9430811
Update website/docs/docs/dbt-versions/release-notes.md
mirnawong1 45b381c
Merge branch 'current' into mwong-model-level-ga
mirnawong1 6e4d947
Merge branch 'current' into mwong-model-level-ga
mirnawong1 4105c12
Merge branch 'current' into mwong-model-level-ga
mirnawong1 1a341d0
multiple emails not supported
mirnawong1 ff47c1a
Merge branch 'current' into mwong-model-level-ga
mirnawong1 0bd1929
Merge branch 'current' into mwong-model-level-ga
mirnawong1 44dbdb9
Update model-notifications.md
mirnawong1 7f1c640
Merge branch 'current' into mwong-model-level-ga
mirnawong1 91b7ab6
Update model-notifications.md
mirnawong1 6c88224
Merge branch 'current' into mwong-model-level-ga
mirnawong1 e8e71fc
Update model-notifications.md
mirnawong1 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,37 +3,31 @@ title: "Model notifications" | |
description: "While a job is running, receive email notifications in real time about any issues with your models and tests. " | ||
--- | ||
|
||
# Model notifications <Lifecycle status="beta" /> | ||
|
||
Set up dbt to notify the appropriate model owners through email about issues as soon as they occur, while the job is still running. Model owners can specify which statuses to receive notifications about: | ||
|
||
- `Success` and `Fails` for models | ||
- `Warning`, `Success`, and `Fails` for tests | ||
|
||
With model-level notifications, model owners can be the first ones to know about issues before anyone else (like the stakeholders). | ||
|
||
:::info Beta feature | ||
|
||
This feature is currently available in [beta](/docs/dbt-versions/product-lifecycles#dbt-cloud) to a limited group of users and is gradually being rolled out. If you're in the beta, please contact the Support team at [email protected] for assistance or questions. | ||
|
||
::: | ||
|
||
To be timely and keep the number of notifications to a reasonable amount when multiple models or tests trigger them, dbt observes the following guidelines when notifying the owners: | ||
|
||
- Send a notification to each unique owner/email during a job run about any models (with status of failure/success) or tests (with status of warning/failure/success). Each owner receives only one notification, the initial one. | ||
- Don't send any notifications about subsequent models or tests while a dbt job is still running. | ||
- At the end of a job run, each owner receives a notification, for each of the statuses they specified to be notified about, with a list of models and tests that have that status. | ||
- Each owner/user who subscribes to notifications for one or more statuses (like failure, success, warning) will receive only _one_ email notification at the end of the job run. | ||
- The email includes a consolidated list of all models or tests that match the statuses the user subscribed to, instead of sending separate emails for each status. | ||
|
||
Create configuration YAML files in your project for dbt to send notifications about the status of your models and tests. | ||
|
||
## Prerequisites | ||
- Your dbt Cloud administrator has [enabled the appropriate account setting](#enable-access-to-model-notifications) for you. | ||
- Your environment(s) must be on a [release track](/docs/dbt-versions/cloud-release-tracks) instead of a legacy dbt Core version. | ||
|
||
|
||
## Configure groups | ||
|
||
Define your groups in any .yml file in your [models directory](/reference/project-configs/model-paths). For example: | ||
Define your groups in any `.yml` file in your [models directory](/reference/project-configs/model-paths). Each group must have a single email address specified — multiple email fields or lists aren't supported. | ||
|
||
The following example shows how to define groups in a `groups.yml` file. | ||
|
||
<File name='models/groups.yml'> | ||
|
||
|
@@ -116,6 +110,6 @@ Provide dbt Cloud account members the ability to configure and receive alerts ab | |
To use model-level notifications, your dbt Cloud account must have access to the feature. Ask your dbt Cloud administrator to enable this feature for account members by following these steps: | ||
|
||
1. Navigate to **Notification settings** from your profile name in the sidebar (lower left-hand side). | ||
1. From **Email notications**, enable the setting **Enable group/owner notifications on models** under the **Model notifications** section. Then, specify which statuses to receive notifications about (Success, Warning, and/or Fails). | ||
1. From **Email notifications**, enable the setting **Enable group/owner notifications on models** under the **Model notifications** section. Then, specify which statuses to receive notifications about (Success, Warning, and/or Fails). | ||
|
||
<Lightbox src="/img/docs/dbt-cloud/example-enable-model-notifications.png" title="Example of the setting Enable group/owner notifications on models" /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@rviswanathan-dbt added the line about multiple emails here