mirror of
https://github.com/clearml/clearml-docs
synced 2025-03-20 12:08:28 +00:00
Add Monitor class information to Monitoring Project Progress
This commit is contained in:
commit
2d6895fbc2
@ -6,9 +6,22 @@ ClearML provides a comprehensive set of monitoring tools to help effectively tra
|
|||||||
These tools offer both high-level overviews and detailed insights into task execution, resource
|
These tools offer both high-level overviews and detailed insights into task execution, resource
|
||||||
utilization, and project performance.
|
utilization, and project performance.
|
||||||
|
|
||||||
## Offerings
|
|
||||||
|
|
||||||
### Project Dashboard
|
## Project Overview
|
||||||
|
|
||||||
|
A project's **OVERVIEW** tab in the UI presents a general picture of a project:
|
||||||
|
* Metric Snapshot – A graphical representation of selected metric values across project tasks, offering a quick assessment of progress.
|
||||||
|
* Task Status Tracking – When a single metric variant is selected for the snapshot, task status is color-coded (e.g.,
|
||||||
|
Completed, Aborted, Published, Failed) for better visibility.
|
||||||
|
|
||||||
|
Use the Metric Snapshot to track project progress and identify trends in task performance.
|
||||||
|
|
||||||
|
For more information, see [Project Overview](../webapp/webapp_project_overview.md).
|
||||||
|
|
||||||
|

|
||||||
|

|
||||||
|
|
||||||
|
## Project Dashboard
|
||||||
|
|
||||||
:::info Pro Plan Offering
|
:::info Pro Plan Offering
|
||||||
The Project Dashboard app is available under the ClearML Pro plan.
|
The Project Dashboard app is available under the ClearML Pro plan.
|
||||||
@ -28,16 +41,22 @@ For more information, see [Project Dashboard](../webapp/applications/apps_dashbo
|
|||||||

|

|
||||||

|

|
||||||
|
|
||||||
### Project Overview
|
## Task Monitoring
|
||||||
|
|
||||||
A project's **OVERVIEW** tab in the UI presents a general picture of a project:
|
ClearML provides task monitoring capabilities through the [`clearml.automation.Monitor`](https://github.com/clearml/clearml/blob/master/clearml/automation/monitor.py)
|
||||||
* Metric Snapshot – A graphical representation of selected metric values across project tasks, offering a quick assessment of progress.
|
class. With this class you can implement monitoring workflows such as:
|
||||||
* Task Status Tracking – When a single metric variant is selected for the snapshot, task status is color-coded (e.g.,
|
|
||||||
Completed, Aborted, Published, Failed) for better visibility.
|
|
||||||
|
|
||||||
Use the Metric Snapshot to track project progress and identify trends in task performance.
|
* Send notifications via Slack or other channels
|
||||||
|
* Trigger automated responses based on specific task conditions
|
||||||
|
|
||||||
For more information, see [Project Overview](../webapp/webapp_project_overview.md).
|
For a practical example, see the [Slack Alerts Example](../guides/services/slack_alerts.md), which demonstrates how to:
|
||||||
|
|
||||||
|
* Track task status (completion, failure, etc.)
|
||||||
|
* Send notifications to a specified Slack channel
|
||||||
|
* Retrieve task details such as status, console logs, and links to the ClearML Web UI
|
||||||
|
|
||||||
|
You can also configure filters for task types and projects to reduce unnecessary notifications.
|
||||||
|
|
||||||
|

|
||||||
|

|
||||||
|
|
||||||

|
|
||||||

|
|
||||||
|
@ -6,11 +6,12 @@ The [Slack alerts example](https://github.com/clearml/clearml/blob/master/exampl
|
|||||||
demonstrates how to use the `clearml.automation.monitor` class to implement a service that monitors the completion and
|
demonstrates how to use the `clearml.automation.monitor` class to implement a service that monitors the completion and
|
||||||
failure of tasks, and posts alert messages on a Slack channel.
|
failure of tasks, and posts alert messages on a Slack channel.
|
||||||
|
|
||||||

|

|
||||||
|

|
||||||
|
|
||||||
## Creating a Slack Bot
|
## Creating a Slackbot
|
||||||
|
|
||||||
Before configuring and running the Slack alert service, create a Slack Bot (**ClearML Bot**).
|
Before configuring and running the Slack alert service, create a Slackbot (**ClearML Bot**).
|
||||||
|
|
||||||
:::important
|
:::important
|
||||||
The Slack API token and channel you create are required to configure the Slack alert service.
|
The Slack API token and channel you create are required to configure the Slack alert service.
|
||||||
|
Binary file not shown.
Before Width: | Height: | Size: 231 KiB After Width: | Height: | Size: 459 KiB |
BIN
docs/img/examples_slack_alerts_dark.png
Normal file
BIN
docs/img/examples_slack_alerts_dark.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 458 KiB |
Loading…
Reference in New Issue
Block a user