description |
---|
Sending automated alerts to chat services. |
{% hint style="warning" %} This is an older version of the ZenML documentation. To read and view the latest version please visit this up-to-date URL. {% endhint %}
Alerters allow you to send messages to chat services (like Slack, Discord, Mattermost, etc.) from within your pipelines. This is useful to immediately get notified when failures happen, for general monitoring/reporting, and also for building human-in-the-loop ML.
Currently, the SlackAlerter and DiscordAlerter are the available alerter integrations. However, it is straightforward to extend ZenML and build an alerter for other chat services.
Alerter | Flavor | Integration | Notes |
---|---|---|---|
Slack | slack |
slack |
Interacts with a Slack channel |
Discord | discord |
discord |
Interacts with a Discord channel |
Custom Implementation | custom | Extend the alerter abstraction and provide your own implementation |
{% hint style="info" %} If you would like to see the available flavors of alerters in your terminal, you can use the following command:
zenml alerter flavor list
{% endhint %}
Each alerter integration comes with specific standard steps that you can use out of the box.
However, you first need to register an alerter component in your terminal:
zenml alerter register <ALERTER_NAME> ...
Then you can add it to your stack using
zenml stack register ... -al <ALERTER_NAME>
Afterward, you can import the alerter standard steps provided by the respective integration and directly use them in your pipelines.