Develop a Custom Alerter
How to develop a custom alerter
This is an older version of the ZenML documentation. To read and view the latest version please visit this up-to-date URL.
Base Abstraction
The base abstraction for alerters is very basic, as it only defines two abstract methods that subclasses should implement:
post()
takes a string, posts it to the desired chat service, and returnsTrue
if the operation succeeded, elseFalse
.ask()
does the same aspost()
, 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 returnsTrue
if the operation succeeded and was approved, elseFalse
.
Then base abstraction looks something like this:
This is a slimmed-down version of the base implementation. To see the full docstrings and imports, please check the source code on GitHub.
Building your own custom alerter
Creating your own custom alerter can be done in three steps:
Create a class that inherits from the
BaseAlerter
.Define the
FLAVOR
class variable in your class (e.g.,FLAVOR="discord"
)Implement the
post()
andask()
methods for your alerter.
Once you are done with the implementation, you can register it through the CLI as:
Last updated