-
Notifications
You must be signed in to change notification settings - Fork 942
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
## What are you changing in this pull request and why? Beta docs for model-level notifications - [x] New page - [x] Update sidebar so new page is below Job notifications page - [x] Add feature card to two landing pages ## Checklist - [x] I have reviewed the [Content style guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md) so my content adheres to these guidelines. - [x] The topic I'm writing about is for specific dbt version(s) and I have versioned it according to the [version a whole page](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version) and/or [version a block of content](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-blocks-of-content) guidelines. - [x] Needs PM review ADDING PAGE (if so, uncomment): - [x] Add/remove page in `website/sidebars.js` - [x] Provide a unique filename for new pages <!-- vercel-deployment-preview --> --- 🚀 Deployment available! Here are the direct links to the updated files: - https://docs-getdbt-com-git-ly-docs-beta-model-notifications-dbt-labs.vercel.app/docs/deploy/deployment-overview - https://docs-getdbt-com-git-ly-docs-beta-model-notifications-dbt-labs.vercel.app/docs/deploy/model-notifications - https://docs-getdbt-com-git-ly-docs-beta-model-notifications-dbt-labs.vercel.app/docs/deploy/monitor-jobs <!-- end-vercel-deployment-preview --> --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Leona B. Campbell <3880403+runleonarun@users.noreply.github.com>
- Loading branch information
1 parent
0604cd5
commit 26b663a
Showing
5 changed files
with
95 additions
and
0 deletions.
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 |
---|---|---|
@@ -0,0 +1,87 @@ | ||
--- | ||
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 support@getdbt.com 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. | ||
|
||
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 ["Versionless"](/docs/dbt-versions/versionless-cloud). | ||
|
||
|
||
## Configure groups | ||
|
||
Add your group configuration in either the `dbt_project.yml` or `groups.yml` file. For example: | ||
|
||
```yml | ||
version: 2 | ||
|
||
groups: | ||
- name: finance | ||
description: "Models related to the finance department" | ||
owner: | ||
# 'name' or 'email' is required | ||
name: "Finance Team" | ||
email: finance@dbtlabs.com | ||
slack: finance-data | ||
|
||
- name: marketing | ||
description: "Models related to the marketing department" | ||
owner: | ||
name: "Marketing Team" | ||
email: marketing@dbtlabs.com | ||
slack: marketing-data | ||
``` | ||
## Set up models | ||
Set up your model configuration in either the `dbt_project.yml` or `groups.yml` file; doing this automatically sets up notifications for tests, too. For example: | ||
|
||
```yml | ||
version: 2 | ||
models: | ||
- name: sales | ||
description: "Sales data model" | ||
config: | ||
group: finance | ||
- name: campaigns | ||
description: "Campaigns data model" | ||
config: | ||
group: marketing | ||
``` | ||
|
||
## Enable access to model notifications | ||
|
||
Provide dbt Cloud account members the ability to configure and receive alerts about issues with models or tests that are encountered during job runs. | ||
|
||
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). | ||
|
||
<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
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
Binary file added
BIN
+40.8 KB
website/static/img/docs/dbt-cloud/example-enable-model-notifications.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.