1. Alerting
  2. Alerting status updates in Email
Email

Create notification_config

In the root of your project’s folder (e.g. default_repo/), open the file metadata.yaml.

Project folder name

If you initialized Mage using a different project name, then your root folder will be named differently. default_repo is the default project name if you didn’t customize it.

In the default_repo/metadata.yaml file, add a section with the following configuration or update the existing notification_config section:

notification_config:
  alert_on:
    - trigger_failure
    - trigger_passed_sla

If you omit the alert_on section it will default to trigger_failure and trigger_passed_sla.

Options:

  • trigger_failure: alert when a run of a trigger fails
  • trigger_success: alert when a run of a trigger succeeds
  • trigger_passed_sla: alert when a run of a trigger passes sla

Configure email settings

In the default_repo/metadata.yaml file, add a section with the following configuration or update the existing notification_config section:

notification_config:
  alert_on:
    ...
  email_config:
    smtp_host: ...
    smtp_mail_from: ...
    smtp_user: ...
    smtp_password: ...
    to_emails:
      - someone_lucky@mage.ai
      - eng@mage.ai

Change the values for each key under the email_config section.


What next?

Whenever a pipeline run is successfully completed or fails, an email will be delivered to all the inboxes listed under to_emails.

Here is an example of what an email could look like:

Successfully ran Pipeline example_pipeline with Trigger 79 hourly_trigger at execution time 2022-09-28 19:00:00.
Open http://localhost:6789/pipelines/example_pipeline/triggers/79 to check pipeline run results and logs.