From 769eda9723c605dca97b69cfa30e2d70a4072158 Mon Sep 17 00:00:00 2001 From: Alan Guo Date: Wed, 19 Oct 2022 18:29:14 -0700 Subject: [PATCH] Create docs for the metrics tab (#29414) Adds information about the new metrics tab in the ray dashboard. Links to instructions on how to set it up. --- doc/source/ray-core/ray-dashboard.rst | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/doc/source/ray-core/ray-dashboard.rst b/doc/source/ray-core/ray-dashboard.rst index a500870c33c4..16f534c79a45 100644 --- a/doc/source/ray-core/ray-dashboard.rst +++ b/doc/source/ray-core/ray-dashboard.rst @@ -7,7 +7,7 @@ Ray users to understand Ray clusters and libraries. The dashboard lets you: -- View cluster metrics. +- View cluster metrics including time-series visualizations. - See errors and exceptions at a glance. - View logs across many machines. - See all your ray jobs and the logs for those jobs. @@ -103,6 +103,18 @@ The log viewer provides various search functionality to help find the log messag .. image:: https://raw.githubusercontent.com/ray-project/Images/master/docs/new-dashboard/logs-content.png :align: center +Metrics View +~~~~~~~~~~~~~ +The metrics view lets you view visualizations of the time series metrics emitted by Ray. It requires that prometheus and grafana is running for your cluster. +Instructions about that can be found :ref:`here `. + +You can select the time range of the metrics in the top right corner. The graphs refresh automatically every 15 seconds. + +There is also a convenient button to open the grafana UI from the dashboard. The Grafana UI provides additional customizability of the charts. + +.. image:: https://raw.githubusercontent.com/ray-project/Images/master/docs/new-dashboard/metrics.png + :align: center + Advanced Usage --------------