From 8dbb316ea743de50931b3286adaa870cf740468b Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Wed, 27 Nov 2024 16:58:25 +0000 Subject: [PATCH 1/6] remove beta --- website/docs/docs/dbt-versions/release-notes.md | 3 +++ website/docs/docs/deploy/model-notifications.md | 8 -------- website/docs/docs/deploy/monitor-jobs.md | 2 +- 3 files changed, 4 insertions(+), 9 deletions(-) diff --git a/website/docs/docs/dbt-versions/release-notes.md b/website/docs/docs/dbt-versions/release-notes.md index 55116db68ba..17fd3add960 100644 --- a/website/docs/docs/dbt-versions/release-notes.md +++ b/website/docs/docs/dbt-versions/release-notes.md @@ -18,6 +18,9 @@ Release notes are grouped by month for both multi-tenant and virtual private clo \* The official release date for this new format of release notes is May 15th, 2024. Historical release notes for prior dates may not reflect all available features released earlier this year or their tenancy availability. +## December 2024 +- **New**: [Model notifications](/docs/deploy/model-notifications) is now generally available in dbt Cloud. These notifications alert model owners through email about any issues encountered by models and tests as soon as they occur while running a job. + ## November 2024 - **Fix**: Job environment variable overrides in credentials are now respected for Exports. Previously, they were ignored. - **Behavior change**: If you use a custom microbatch macro, set a [`require_batched_execution_for_custom_microbatch_strategy` behavior flag](/reference/global-configs/behavior-changes#custom-microbatch-strategy) in your `dbt_project.yml` to enable batched execution. If you don't have a custom microbatch macro, you don't need to set this flag as dbt will handle microbatching automatically for any model using the [microbatch strategy](/docs/build/incremental-microbatch#how-microbatch-compares-to-other-incremental-strategies). diff --git a/website/docs/docs/deploy/model-notifications.md b/website/docs/docs/deploy/model-notifications.md index a6d4c467f0b..f444f258120 100644 --- a/website/docs/docs/deploy/model-notifications.md +++ b/website/docs/docs/deploy/model-notifications.md @@ -3,8 +3,6 @@ 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 - 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 @@ -12,12 +10,6 @@ Set up dbt to notify the appropriate model owners through email about issues as 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. diff --git a/website/docs/docs/deploy/monitor-jobs.md b/website/docs/docs/deploy/monitor-jobs.md index 1cbba23161e..40298f0cdbe 100644 --- a/website/docs/docs/deploy/monitor-jobs.md +++ b/website/docs/docs/deploy/monitor-jobs.md @@ -13,7 +13,7 @@ This portion of our documentation will go over dbt Cloud's various capabilities - [Run visibility](/docs/deploy/run-visibility) — View your run history to help identify where improvements can be made to scheduled jobs. - [Retry jobs](/docs/deploy/retry-jobs) — Rerun your errored jobs from start or the failure point. - [Job notifications](/docs/deploy/job-notifications) — Receive email or Slack notifications when a job run succeeds, encounters warnings, fails, or is canceled. -- [Model notifications](/docs/deploy/model-notifications) — Receive email notifications about any issues encountered by your models and tests as soon as they occur while running a job. +- [Model notifications](/docs/deploy/model-notifications) — Receive email notifications about any issues encountered by your models and tests as soon as they occur while running a job. - [Webhooks](/docs/deploy/webhooks) — Use webhooks to send events about your dbt jobs' statuses to other systems. - [Leverage artifacts](/docs/deploy/artifacts) — dbt Cloud generates and saves artifacts for your project, which it uses to power features like creating docs for your project and reporting freshness of your sources. - [Source freshness](/docs/deploy/source-freshness) — Monitor data governance by enabling snapshots to capture the freshness of your data sources. From 94308115f74b5bb972bf6a6f19b7df1e903a0481 Mon Sep 17 00:00:00 2001 From: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> Date: Wed, 4 Dec 2024 09:43:53 +0000 Subject: [PATCH 2/6] Update website/docs/docs/dbt-versions/release-notes.md Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> --- website/docs/docs/dbt-versions/release-notes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/dbt-versions/release-notes.md b/website/docs/docs/dbt-versions/release-notes.md index 91f0655cffd..06f77320cd2 100644 --- a/website/docs/docs/dbt-versions/release-notes.md +++ b/website/docs/docs/dbt-versions/release-notes.md @@ -19,7 +19,7 @@ Release notes are grouped by month for both multi-tenant and virtual private clo \* The official release date for this new format of release notes is May 15th, 2024. Historical release notes for prior dates may not reflect all available features released earlier this year or their tenancy availability. ## December 2024 -- **New**: [Model notifications](/docs/deploy/model-notifications) is now generally available in dbt Cloud. These notifications alert model owners through email about any issues encountered by models and tests as soon as they occur while running a job. +- **New**: [Model notifications](/docs/deploy/model-notifications) are now generally available in dbt Cloud. These notifications alert model owners through email about any issues encountered by models and tests as soon as they occur while running a job. ## November 2024 - **Bug**: Identified and fixed an error with Semantic Layer queries that take longer than 10 minutes to complete. From 1a341d0f3e232a9d1a0a834a84dbf71e781b966e Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Fri, 6 Dec 2024 11:36:45 +0000 Subject: [PATCH 3/6] multiple emails not supported --- website/docs/docs/deploy/model-notifications.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/website/docs/docs/deploy/model-notifications.md b/website/docs/docs/deploy/model-notifications.md index 9f96237d995..8b290130d1b 100644 --- a/website/docs/docs/deploy/model-notifications.md +++ b/website/docs/docs/deploy/model-notifications.md @@ -22,10 +22,11 @@ Create configuration YAML files in your project for dbt to send notifications ab - 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. @@ -108,6 +109,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). From 44dbdb9a36fb789ee03e1078c4c92bef66cf3752 Mon Sep 17 00:00:00 2001 From: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> Date: Fri, 6 Dec 2024 17:42:34 +0000 Subject: [PATCH 4/6] Update model-notifications.md rephrase and clarify per Rakesh's feedback --- website/docs/docs/deploy/model-notifications.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/website/docs/docs/deploy/model-notifications.md b/website/docs/docs/deploy/model-notifications.md index 8b290130d1b..e07722dd029 100644 --- a/website/docs/docs/deploy/model-notifications.md +++ b/website/docs/docs/deploy/model-notifications.md @@ -12,9 +12,9 @@ With model-level notifications, model owners can be the first ones to know about 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. +- Notifications about subsequent models or tests aren't sent while a dbt job is still running. Users are only notified once the job has fully completed. Create configuration YAML files in your project for dbt to send notifications about the status of your models and tests. From 91b7ab669fa801cf6af27d432917449a0e8f220b Mon Sep 17 00:00:00 2001 From: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> Date: Fri, 6 Dec 2024 18:23:14 +0000 Subject: [PATCH 5/6] Update model-notifications.md --- website/docs/docs/deploy/model-notifications.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/website/docs/docs/deploy/model-notifications.md b/website/docs/docs/deploy/model-notifications.md index e07722dd029..9eb9751be3f 100644 --- a/website/docs/docs/deploy/model-notifications.md +++ b/website/docs/docs/deploy/model-notifications.md @@ -12,9 +12,10 @@ With model-level notifications, model owners can be the first ones to know about 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. - 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. -- Notifications about subsequent models or tests aren't sent while a dbt job is still running. Users are only notified once the job has fully completed. Create configuration YAML files in your project for dbt to send notifications about the status of your models and tests. From e8e71fc182b3fe5171c5c95167f236741d0bb476 Mon Sep 17 00:00:00 2001 From: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> Date: Tue, 10 Dec 2024 09:24:55 +0000 Subject: [PATCH 6/6] Update model-notifications.md --- website/docs/docs/deploy/model-notifications.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/deploy/model-notifications.md b/website/docs/docs/deploy/model-notifications.md index 9eb9751be3f..24bbc2295c6 100644 --- a/website/docs/docs/deploy/model-notifications.md +++ b/website/docs/docs/deploy/model-notifications.md @@ -13,7 +13,7 @@ With model-level notifications, model owners can be the first ones to know about 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. +- No notifications sent about subsequent models or tests while a dbt job is still running. - 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.