Get status updates sent to your email inbox.
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:
alert_on
section it will default to trigger_failure
and trigger_passed_sla
.
Options:
trigger_failure
: alert when a run of a trigger failstrigger_success
: alert when a run of a trigger succeedstrigger_passed_sla
: alert when a run of a trigger passes sladefault_repo/metadata.yaml
file, add a section with the following
configuration or update the existing notification_config
section:
email_config
section.
notification_config
. Here is an example config:
success
, failure
, passed_sla
scenarios. For each message template,
you can specify title
and either summary
or details
.
title
is used in email subjectsummary
, the email body will be your summary
+ the url of the pipeline run pagedetails
, the details
will be used as your email body{variable_name}
syntax.
Here are the supported variables:
execution_time
pipeline_run_url
pipeline_schedule_id
pipeline_schedule_name
pipeline_schedule_description
pipeline_uuid
error
failure
message templatestacktrace
failure
message templateNote: Forpipeline_run_url
, the default host ishttp://localhost:6789
. You can specifyMAGE_PUBLIC_HOST
to be the host url you want to use in the notification messages.
execution_time
, pipeline_uuid
, etc), you can also use the
following in your message templates in Mage Pro:
start_time
end_time
duration
(in seconds)env
(this gets the value stored in the ENV
environment variable)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. |