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.

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

Create docs for the metrics tab #29414

Merged
merged 3 commits into from
Oct 20, 2022
Merged

Conversation

alanwguo
Copy link
Contributor

@alanwguo alanwguo commented Oct 17, 2022

Signed-off-by: Alan Guo [email protected]

Why are these changes needed?

Adds information about the new metrics tab in the ray dashboard. Links to instructions on how to set it up.

Related issue number

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

@rkooo567 rkooo567 self-assigned this Oct 17, 2022
@alanwguo alanwguo marked this pull request as ready for review October 19, 2022 00:37
@alanwguo alanwguo requested a review from a team as a code owner October 19, 2022 00:37
@rkooo567
Copy link
Contributor

Can you update the PR description?


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 launch grafana from the dashboard. The Grafana UI provides additional customizability of the charts.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should call it "open a Grafana dashboard" instead of "launch"?

@rkooo567
Copy link
Contributor

Is this based on the old commit? Seems like it is not the latest doc format https://ray--29414.org.readthedocs.build/en/29414/

@alanwguo
Copy link
Contributor Author

Is this based on the old commit? Seems like it is not the latest doc format https://ray--29414.org.readthedocs.build/en/29414/

merged with master

@ericl ericl merged commit 769eda9 into ray-project:master Oct 20, 2022
@ericl
Copy link
Contributor

ericl commented Oct 20, 2022

Merged, thanks!

rickyyx pushed a commit that referenced this pull request Oct 20, 2022
Adds information about the new metrics tab in the ray dashboard. Links to instructions on how to set it up.
WeichenXu123 pushed a commit to WeichenXu123/ray that referenced this pull request Dec 19, 2022
Adds information about the new metrics tab in the ray dashboard. Links to instructions on how to set it up.

Signed-off-by: Weichen Xu <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants