mirror of
https://github.com/clearml/clearml-docs
synced 2025-04-05 05:40:54 +00:00
48 lines
2.4 KiB
Markdown
48 lines
2.4 KiB
Markdown
---
|
|
title: Building Bots
|
|
---
|
|
|
|
Using a Slack Bot for ClearML Task Monitoring
|
|
|
|
Overview
|
|
|
|
Integrating a Slack bot with ClearML allows teams to stay informed about task statuses in real time. This is especially
|
|
useful for monitoring machine learning experiments and automation workflows. By leveraging the ClearML automation
|
|
monitor, you can receive Slack notifications for completed or failed tasks, helping teams react quickly and maintain
|
|
smooth operations.
|
|
|
|
$$$$$$$By using a ClearML Slack bot, teams can streamline their workflow, stay informed, and quickly address critical task updates without manually checking logs or dashboards.
|
|
|
|
|
|
Use Cases and Benefits
|
|
|
|
2. Real-Time Monitoring - Get instant Slack notifications for completed or failed ClearML tasks. Reduce the need for manual log-checking by receiving automated updates.
|
|
3. Customizable Alerts - Configure alerts to report only failed tasks, completed tasks, or both.
|
|
|
|
Set filters for specific projects, users, or iteration thresholds to avoid unnecessary notifications.
|
|
|
|
## ClearML Integration
|
|
|
|
This integration is powered by `clearml.automation.monitor`, which allows for efficient task tracking. The `SlackMonitor`
|
|
class extends the Monitor class from ClearML and enables customized Slack notifications based on task events. The bot
|
|
retrieves task details such as:
|
|
|
|
* Task status (completed or failed)
|
|
* Console output logs
|
|
* ClearML Web UI links
|
|
|
|
The ClearML monitor is a highly flexible object that allows deep visibility into the ClearML ecosystem. It can provide
|
|
insights into task completions, failures, and various other ClearML-generated events. One powerful use case is leveraging
|
|
this monitor to create a Slack bot that keeps users informed about task progress. The Slack bot is built using a set of
|
|
Slack APIs around the monitor, providing real-time notifications about task statuses.
|
|
|
|
The Slack bot is fully equipped with numerous configurable arguments, making it versatile for different workflows. While
|
|
the provided example can be used as a command-line tool, users can also customize it to fit their specific needs. The
|
|
bot can be added to a Slack workspace and configured to report only specific types of tasks, such as failed tasks,
|
|
completed tasks, or those from designated projects. This eliminates the need for manual monitoring and allows users to
|
|
stay informed effortlessly.
|
|
|
|
For a full example and detailed setup, refer to the Slack Alerts Example.
|
|
|
|
|