Skip to content

Commit

Permalink
[docs] Email asset owner alert notification policy (#20019)
Browse files Browse the repository at this point in the history
As the title.

Does some reorganizing (described in comments) and documents the new
asset alert notification type.
  • Loading branch information
clairelin135 authored Mar 4, 2024
1 parent e9e75b0 commit 765bfd2
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -65,17 +65,6 @@ Alert policies are configured on a per-deployment basis. For example, asset aler

- **Alert policy name** - Enter a name for the alert policy. For example, `slack_urgent_failure`
- **Description** - Enter a description for the alert policy

For asset-based alerts, fill out these additional options:

- **Asset group** - Select the asset group to monitor. You will have the option to select from all asset groups in the deployment.
- **Asset key** - Select the asset key to monitor. You will have the option to select from all asset keys in the deployment. **Note:** If you select an asset group, you will not be able to select an asset key.
- **Events** - Select whether the alert should trigger on asset materialization failure, asset materialization success, asset check error, asset check warn, asset check passed, or asset check failure to execute

For job-based alerts, fill out these additional options:

- **Tags** - Add tag(s) for the alert policy. Jobs with these tags will trigger the alert. For example: `level:critical` or `team:sales`
- **Events** - Select whether the alert should trigger on job success, failure, or both
- **Notification service** - Select the service for the alert policy:

- **Slack** - If you haven't connected Slack, click the **Connect to Slack** button to add the Dagster Cloud Slack app to your workspace. After the installation completes, invite the `@Dagster Cloud` bot user to the desired channel.
Expand Down Expand Up @@ -111,6 +100,23 @@ Alert policies are configured on a per-deployment basis. For example, asset aler
height={514}
/>

For asset-based alerts, fill out these additional options:

- **Asset group** - Select the asset group to monitor. You will have the option to select from all asset groups in the deployment.
- **Asset key** - Select the asset key to monitor. You will have the option to select from all asset keys in the deployment. **Note:** If you select an asset group, you will not be able to select an asset key.
- **Events** - Select whether the alert should trigger on asset materialization failure, asset materialization success, asset check error, asset check warn, asset check passed, or asset check failure to execute
- **Notification Service** - Asset alerts have an additional notification option to email asset owners (experimental). <Image
alt="Email alert configured to alert asset owners"
src="/images/dagster-cloud/alerts/email-owners-alert-creation.png"
width={1518}
height={330}
/>

For job-based alerts, fill out these additional options:

- **Tags** - Add tag(s) for the alert policy. Jobs with these tags will trigger the alert. For example: `level:critical` or `team:sales`
- **Events** - Select whether the alert should trigger on job success, failure, or both

7. When finished, click **Save policy**.

### Editing alert policies
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

1 comment on commit 765bfd2

@github-actions
Copy link

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-54wqxhfaf-elementl.vercel.app
https://master.dagster.dagster-docs.io

Built with commit 765bfd2.
This pull request is being automatically deployed with vercel-action

Please sign in to comment.