Alerters

Alerters allow you to send messages to chat services (like Slack, Discord, Mattermost, etc.) from within your pipeline. This is useful for immediately getting notified when failures happen, for general monitoring/reporting, and also for building human-in-the-loop ML.
Before reading this chapter, make sure that you are familiar with the concept of stacks, stack components and their flavors.
Base Abstraction
The base abstraction for alerters is very simple, as it only defines two abstract methods that subclasses should implement:
post() takes a string, posts it to the desired chat service, and returns True if the operation succeeded, else False.
ask() does the same as post(), but after sending the message, it waits until someone approves or rejects the operation from within the chat service (e.g., by sending "approve" / "reject" to the bot as response). ask() then only returns True if the operation succeeded and was approved, else False.
Then base abstraction looks something like this:
1
class BaseAlerter(StackComponent, ABC):
2
    """Base class for all ZenML alerters."""
3
​
4
    def post(
5
        self, message: str, config: Optional[BaseAlerterStepConfig]
6
    ) -> bool:
7
        """Post a message to a chat service."""
8
        return True
9
​
10
    def ask(
11
        self, question: str, config: Optional[BaseAlerterStepConfig]
12
    ) -> bool:
13
        """Post a message to a chat service and wait for approval."""
14
        return True
Copied!
This is a slimmed-down version of the base implementation. To see the full docstrings and imports, please check the source code on GitHub.
List of available alerters
Currently, the only available alerter integration is Slack. The Slack alerter can be used to post/ask in a specified Slack channel via a dedicated bot account of a Slack app linked to the channel.
Text
Flavor
Integration
​SlackAlerter​
slack
slack
If you would like to see the available flavors for alerters, you can use the command:
1
zenml alerter flavor list
Copied!
Build your own custom alerter
Creating your own custom alerter can be done in three simple steps:
1.Create a class that inherits from the BaseAlerter.
2.Define the FLAVOR class variable in your class (e.g., FLAVOR="discord")
3.Implement the post() and ask() methods for your alerter.
Once you are done with the implementation, you can register it through the CLI as:
1
zenml alerter flavor register <THE-SOURCE-PATH-OF-YOUR-ALERTER>
Copied!

Extending ZenML - Previous

Feature Stores

Next - Collaborate

Collaborate with ZenML

Last modified 10d ago

Export as PDF

Copy link

Edit on GitHub

Contents

Base Abstraction

List of available alerters

Build your own custom alerter