-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Guide for alerting with MS Teams. This page will get a little messy as we add more integrations, may be up for a rework
- Loading branch information
Showing
2 changed files
with
37 additions
and
2 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,6 +8,12 @@ title: "Setting up alerts in Dagster Cloud | Dagster Docs" | |
|
||
In this guide, we'll walk you through configuring alerts in Dagster Cloud. | ||
|
||
Dagster Cloud can send alerts to: | ||
|
||
- Slack | ||
- Microsoft Teams | ||
|
||
--- | ||
|
||
## Understanding alert policies | ||
|
@@ -22,8 +28,6 @@ Alert policies define which events will trigger an alert, the conditions under w | |
|
||
Alert policies are configured on a per-deployment basis. For example, asset alerts configured in a `prod` deployment are only applicable to assets in that deployment. | ||
|
||
Currently, Slack and email notifications are supported. | ||
|
||
--- | ||
|
||
## Managing alert policies in Dagster Cloud | ||
|
@@ -96,6 +100,17 @@ Currently, Slack and email notifications are supported. | |
height={514} | ||
/> | ||
|
||
- **Microsoft Teams** - Send alerts to Teams incoming webhooks. | ||
|
||
First, follow the instructions in the [Microsoft Teams documentation](https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook) to create an incoming webhook. Then, paste the url into the alert form. | ||
|
||
<Image | ||
alt="Microsoft Teams alert configured with a webhook url" | ||
src="/images/dagster-cloud/alerts/cloud-ms-teams-alert-creation.png" | ||
width={1571} | ||
height={514} | ||
/> | ||
|
||
7. When finished, click **Save policy**. | ||
|
||
### Editing alert policies | ||
|
@@ -216,6 +231,26 @@ alert_policies: | |
- "[email protected]" | ||
``` | ||
|
||
### Configuring a Microsoft Teams alert policy | ||
|
||
In this example, we'll configure a Teams alert for when a Hybrid Agent goes down. | ||
|
||
```yaml | ||
alert_policies: | ||
- name: "email-alert-policy" | ||
description: "An alert policy to email company executives during job failure." | ||
tags: | ||
- key: "level" | ||
value: "critical" | ||
event_types: | ||
- "AGENT_UNAVAILABLE" | ||
notification_service: | ||
microsoft_teams: | ||
webhook_url: "https://yourdomain.webhook.office.com/..." | ||
``` | ||
|
||
If the agent stops heartbeating, a message will be sent via the [incoming webhook URL](https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook). | ||
|
||
--- | ||
|
||
### Compatible event types | ||
|
Binary file added
BIN
+24.6 KB
docs/next/public/images/dagster-cloud/alerts/cloud-ms-teams-alert-creation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
845254a
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.
Deploy preview for dagster-docs ready!
✅ Preview
https://dagster-docs-l5pjkf5og-elementl.vercel.app
https://release-1-6-8.dagster.dagster-docs.io
Built with commit 845254a.
This pull request is being automatically deployed with vercel-action