Skip to content

Commit d63d1cf

Browse files
[td] Add docs for email alerting
1 parent 102d181 commit d63d1cf

File tree

2 files changed

+50
-1
lines changed

2 files changed

+50
-1
lines changed

Diff for: docs/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,8 @@ Read more tech docs here. Got questions?
4343
- [Compute resource](production/compute_resource.md)
4444
- [Runtime variables](production/runtime_variables.md)
4545
- Monitoring and alerting
46-
- [Status updates in Slack](monitoring/alerting/slack.md)
46+
- [Status updates in Slack](monitoring/alerting/Slack.md)
47+
- [Status updates in Email](monitoring/alerting/Email.md)
4748

4849
### Integrations
4950
- Compute

Diff for: docs/monitoring/alerting/Email.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Email
2+
3+
Get status updates sent to your email inbox.
4+
5+
<img
6+
alt="Email"
7+
src="https://yourreclaimedlife.com/wp-content/uploads/2018/12/email-marketing-without-permission.jpg"
8+
/>
9+
10+
## Configure email settings
11+
12+
In the root of your project’s folder (e.g. `default_repo/`), open the file `metadata.yaml`.
13+
14+
> Project folder name
15+
>
16+
> If you initialized Mage using a different project name, then your root folder will be named
17+
differently. `default_repo` is the default project name if you didn’t customize it.
18+
19+
In the `default_repo/metadata.yaml` file, add a section with the following configuration:
20+
21+
```yaml
22+
notification_config:
23+
email_config:
24+
smtp_host: ...
25+
smtp_mail_from: ...
26+
smtp_user: ...
27+
smtp_password: ...
28+
to_emails:
29+
30+
31+
```
32+
33+
Change the values for each key under the `email_config` section.
34+
35+
<br />
36+
37+
## What next?
38+
39+
Whenever a pipeline run is successfully completed or fails,
40+
an email will be delivered to all the inboxes listed under `to_emails`.
41+
42+
Here is an example of what an email could look like:
43+
44+
| |
45+
| --- |
46+
| Successfully ran Pipeline `example_pipeline` with Trigger 79 `hourly_trigger` at execution time `2022-09-28 19:00:00`.<br />Open http://localhost:6789/pipelines/example_pipeline/triggers/79 to check pipeline run results and logs. |
47+
48+
<br />

0 commit comments

Comments
 (0)