Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create docs for the metrics tab #29414

Merged
merged 3 commits into from
Oct 20, 2022
Merged

Create docs for the metrics tab #29414

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
868634d
Create docs for the metrics tab
alanwguo Oct 12, 2022
ef6d2b6
Merge branch 'master' into aguo/metrics-docs
alanwguo Oct 19, 2022
9cb646d
fixup
alanwguo Oct 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion doc/source/ray-core/ray-dashboard.rst
View file
Open in desktop
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