Skip to content

Commit

Permalink
Create docs for the metrics tab (#29414)
Browse files Browse the repository at this point in the history
Adds information about the new metrics tab in the ray dashboard. Links to instructions on how to set it up.
  • Loading branch information
alanwguo authored Oct 20, 2022
1 parent e93fa4b commit 769eda9
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion doc/source/ray-core/ray-dashboard.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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 <ray-metrics>`.

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
--------------

Expand Down

0 comments on commit 769eda9

Please sign in to comment.