-
Notifications
You must be signed in to change notification settings - Fork 310
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add README on GCP workload monitoring feature
- Loading branch information
Showing
2 changed files
with
21 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# Enable GCP Workload Monitoring | ||
This guide provides an overview on how to enable GCP workload monitoring for your MaxText workload. | ||
|
||
## Overview | ||
Google offers a monitoring and alerting feature that is well suited for critical MaxText workloads sensitive to infrastructure changes. | ||
Once enabled, metrics will be automatically sent to [Cloud Monarch](https://research.google/pubs/monarch-googles-planet-scale-in-memory-time-series-database/) for monitoring. | ||
If a metric hits its pre-defined threshold, the Google Cloud on-call team will be alerted to see if any action is needed. | ||
|
||
The feature currently supports heartbeat and performance (training step time in seconds) metrics. In the near future, support for the goodput metric will also be added. | ||
Users should work with their Customer Engineer (CE) and the Google team to define appropriate thresholds for the performance metrics. | ||
|
||
This guide layouts how to enable the feature for your MaxText workload. | ||
|
||
## Enabling GCP Workload Monitoring | ||
User can control which metric they want to report via config: | ||
- To report the heartbeat metric, set `report_heartbeat_metric_for_gcp_monitoring` to `True` | ||
- To report the performance metric (training step time in seconds), set `report_performance_metric_for_gcp_monitoring` to `True` | ||
|
||
For an example, please refer to [base.yml](../MaxText/configs/base.yml). |