-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[docs] - Split up Cloud alert docs (DOC-177) (#20541)
## Summary & Motivation This PR splits up the Dagster Cloud alerting documentation to move integration setup details to their own dedicated pages. - Renames `/dagster-cloud/managing-deployments/setting-up-alerts` to `/../../alerts` and adds redirects - Updates links to ^ - Adds dedicated pages for notification services: Email, MS Teams, and Slack - Moves setup instructions for alert policies to their own pages: one for the UI, the other for the CLI - Updates sidenav to match new pages - Adds an **Alerts** section to `/dagster-cloud` and `/dagster-cloud/managing-deployments` ## How I Tested These Changes Testing in Cloud, 👀
- Loading branch information
1 parent
d4618b0
commit 9cc20e5
Showing
26 changed files
with
972 additions
and
277 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
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
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
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
154 changes: 154 additions & 0 deletions
154
docs/content/dagster-cloud/managing-deployments/alerts.mdx
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,154 @@ | ||
| --- | ||
| title: "Dagster Cloud alerts | Dagster Docs" | ||
| description: "Create and configure alerts in Dagster Cloud." | ||
|
|
||
| platform_type: "cloud" | ||
| feature: "alerting" | ||
| --- | ||
|
|
||
| # Dagster Cloud alerts | ||
|
|
||
| <ApplicableDagsterProduct /> | ||
|
|
||
| Using Dagster Cloud's built-in alerting system, you can stay in the loop on the events occurring in your deployment. Dagster Cloud alerts integrate with several popular services, allowing you to deliver notifications when and where they're most needed. | ||
|
|
||
| --- | ||
|
|
||
| ## How it works | ||
|
|
||
| Alerts are created using **alert policies**. An alert policy defines [the conditions that will trigger an alert](#alert-policy-types) and [how the alert will be sent](#supported-notification-services). For example, you can create a policy that sends an alert to a Slack channel when any asset in a specific asset group fails to materialize. | ||
|
|
||
| Alert policies are configured on a **per-deployment basis**. This means, for example, that asset alerts configured in a `prod` deployment are only applicable to assets in that deployment. | ||
|
|
||
| ### Alert policy types | ||
|
|
||
| <table | ||
| className="table" | ||
| style={{ | ||
| width: "100%", | ||
| }} | ||
| > | ||
| <thead> | ||
| <tr> | ||
| <th | ||
| style={{ | ||
| width: "25%", | ||
| }} | ||
| > | ||
| Policy type | ||
| </th> | ||
| <th>How it works</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td> | ||
| <strong>Asset alert</strong> | ||
| </td> | ||
| <td> | ||
| Triggers on: | ||
| <ul> | ||
| <li> | ||
| <strong>Asset materializations</strong> - Failure or success | ||
| </li> | ||
| <li> | ||
| <strong>Asset checks</strong> - Error, warn, passed, or failure to | ||
| execute | ||
| </li> | ||
| <li> | ||
| <strong>Asset freshness</strong> - Overdue | ||
| </li> | ||
| </ul> | ||
| Alerts can be scoped to asset groups or specific asset keys. Asset check | ||
| alerts are sent for any checks on those assets. | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <strong>Run alert</strong> | ||
| </td> | ||
| <td> | ||
| Triggers on job run success or failure; may optionally include a set of | ||
| configured tags. If an alert policy has no configured tags, all jobs | ||
| will be eligible for that alert. Otherwise, only jobs that contain all | ||
| the tags for a given alert policy are eligible for that alert. | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <strong>Schedule/Sensor alert</strong> | ||
| </td> | ||
| <td> | ||
| Triggers when a schedule or sensor tick failure occurs for any schedule | ||
| or sensor in the deployment. <strong>Note</strong>: Alerts are sent only | ||
| when the schedule/sensor changes from <strong>success</strong> to{" "} | ||
| <strong>failure</strong>, so subsequent failures won't trigger new | ||
| alerts. | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <strong>Code location error alert</strong> | ||
| </td> | ||
| <td>Triggers when a code location fails to load due to an error.</td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <strong>Agent downtime alert</strong> | ||
| </td> | ||
| <td> | ||
| Triggers when a Hybrid agent hasn't heartbeated within the last five | ||
| minutes. Available for{" "} | ||
| <a href="/dagster-cloud/deployment/hybrid">Hybrid deployments</a> only. | ||
| </td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
|
|
||
| ### Supported notification services | ||
|
|
||
| Dagster Cloud can send notifications via: | ||
|
|
||
| - [Email](/dagster-cloud/managing-deployments/alerts/email) | ||
| - [Microsoft Teams](/dagster-cloud/managing-deployments/alerts/microsoft-teams) | ||
| - [Slack](/dagster-cloud/managing-deployments/alerts/slack) | ||
|
|
||
| --- | ||
|
|
||
| ## Managing alert policies | ||
|
|
||
| Managing alert policies can be accomplished by using: | ||
|
|
||
| - [The Dagster Cloud UI](/dagster-cloud/managing-deployments/alerts/managing-alerts-in-ui) | ||
| - [The `dagster-cloud` command-line interface (CLI)](/dagster-cloud/managing-deployments/alerts/managing-alerts-cli) | ||
|
|
||
| --- | ||
|
|
||
| ## Related | ||
|
|
||
| <ArticleList> | ||
| <ArticleListItem | ||
| title="Managing alerts in the Dagster UI" | ||
| href="/dagster-cloud/managing-deployments/alerts/managing-alerts-in-ui" | ||
| ></ArticleListItem> | ||
| <ArticleListItem | ||
| title="Managing alerts using the dagster-cloud CLI" | ||
| href="/dagster-cloud/managing-deployments/alerts/managing-alerts-cli" | ||
| ></ArticleListItem> | ||
| <ArticleListItem | ||
| title="Managing code locations" | ||
| href="/dagster-cloud/managing-deployments/code-locations" | ||
| ></ArticleListItem> | ||
| <ArticleListItem | ||
| title="Deployment settings" | ||
| href="/dagster-cloud/managing-deployments/deployment-settings-reference" | ||
| ></ArticleListItem> | ||
| <ArticleListItem | ||
| title="dagster-cloud CLI" | ||
| href="/dagster-cloud/managing-deployments/dagster-cloud-cli" | ||
| ></ArticleListItem> | ||
| <ArticleListItem | ||
| title="dagster_cloud.yaml" | ||
| href="/dagster-cloud/managing-deployments/dagster-cloud-yaml" | ||
| ></ArticleListItem> | ||
| </ArticleList> |
Oops, something went wrong.
9cc20e5There 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.
Deploy preview for dagster-docs ready!
✅ Preview
https://dagster-docs-mgeu46xfr-elementl.vercel.app
https://master.dagster.dagster-docs.io
Built with commit 9cc20e5.
This pull request is being automatically deployed with vercel-action