Skip to content

[train] Ray Train Metrics Doc Page#58235

Merged
matthewdeng merged 18 commits into
ray-project:masterfrom
JasonLi1909:add-oss-metrics-doc
Nov 6, 2025
Merged

[train] Ray Train Metrics Doc Page#58235
matthewdeng merged 18 commits into
ray-project:masterfrom
JasonLi1909:add-oss-metrics-doc

Conversation

@JasonLi1909

@JasonLi1909 JasonLi1909 commented Oct 28, 2025

Copy link
Copy Markdown
Contributor

This PR:

  • adds a new page to the Ray Train docs called "Monitor your Application" that lists and describes the Prometheus metrics emitted by Ray Train
  • Updates the Ray Core system metrics docs to include some missing metrics

Link to example build: https://anyscale-ray--58235.com.readthedocs.build/en/58235/train/user-guides/monitor-your-application.html

Preview Screenshot:

Screenshot 2025-10-29 at 2 46 07 PM
Signed-off-by: JasonLi1909 <jasli1909@gmail.com>
@JasonLi1909 JasonLi1909 requested review from a team as code owners October 28, 2025 02:32

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request intends to add a new documentation page for Ray Train metrics. However, the newly created file doc/source/train/monitoring-your-application is essentially empty, containing only a label. It lacks the documentation content described in the pull request description. Additionally, the new file is not referenced in any toctree, so it would not be rendered in the final documentation. The change appears to be incomplete.

Comment thread doc/source/train/monitoring-your-application Outdated
@ray-gardener ray-gardener Bot added the train Ray Train Related Issue label Oct 28, 2025
Signed-off-by: JasonLi1909 <jasli1909@gmail.com>
Signed-off-by: JasonLi1909 <jasli1909@gmail.com>
Signed-off-by: JasonLi1909 <jasli1909@gmail.com>
Signed-off-by: JasonLi1909 <jasli1909@gmail.com>
Signed-off-by: JasonLi1909 <jasli1909@gmail.com>
Signed-off-by: JasonLi1909 <jasli1909@gmail.com>
Comment thread doc/source/train/user-guides/monitor-your-application.rst Outdated
Comment thread doc/source/train/train.rst Outdated
Signed-off-by: JasonLi1909 <jasli1909@gmail.com>
Signed-off-by: JasonLi1909 <jasli1909@gmail.com>
Signed-off-by: JasonLi1909 <jasli1909@gmail.com>
Signed-off-by: JasonLi1909 <jasli1909@gmail.com>
Signed-off-by: JasonLi1909 <jasli1909@gmail.com>
… ray core metrics

Signed-off-by: JasonLi1909 <jasli1909@gmail.com>
Signed-off-by: JasonLi1909 <jasli1909@gmail.com>
Signed-off-by: JasonLi1909 <jasli1909@gmail.com>
Signed-off-by: JasonLi1909 <jasli1909@gmail.com>
Comment thread doc/source/ray-observability/reference/system-metrics.rst
Signed-off-by: JasonLi1909 <jasli1909@gmail.com>

@alanwguo alanwguo left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

thanks a lot!

Comment thread doc/source/train/user-guides.rst Outdated
Comment thread doc/source/train/user-guides/monitor-your-application.rst Outdated
Comment thread doc/source/train/user-guides/monitor-your-application.rst Outdated
Comment thread doc/source/train/user-guides/monitor-your-application.rst Outdated
Signed-off-by: JasonLi1909 <jasli1909@gmail.com>
@matthewdeng matthewdeng enabled auto-merge (squash) November 6, 2025 22:33
@github-actions github-actions Bot added the go add ONLY when ready to merge, run all tests label Nov 6, 2025
@matthewdeng matthewdeng merged commit 6076513 into ray-project:master Nov 6, 2025
8 checks passed
YoussefEssDS pushed a commit to YoussefEssDS/ray that referenced this pull request Nov 8, 2025
This PR: 
- adds a new page to the Ray Train docs called "Monitor your
Application" that lists and describes the Prometheus metrics emitted by
Ray Train
- Updates the Ray Core system metrics docs to include some missing
metrics

Link to example build:
https://anyscale-ray--58235.com.readthedocs.build/en/58235/train/user-guides/monitor-your-application.html

Preview Screenshot:

<img width="1630" height="662" alt="Screenshot 2025-10-29 at 2 46 07 PM"
src="https://github.com/user-attachments/assets/9ca7ea6d-522b-4033-909a-2ee626960e8a"
/>

---------

Signed-off-by: JasonLi1909 <jasli1909@gmail.com>
landscapepainter pushed a commit to landscapepainter/ray that referenced this pull request Nov 17, 2025
This PR: 
- adds a new page to the Ray Train docs called "Monitor your
Application" that lists and describes the Prometheus metrics emitted by
Ray Train
- Updates the Ray Core system metrics docs to include some missing
metrics

Link to example build:
https://anyscale-ray--58235.com.readthedocs.build/en/58235/train/user-guides/monitor-your-application.html

Preview Screenshot:

<img width="1630" height="662" alt="Screenshot 2025-10-29 at 2 46 07 PM"
src="https://github.com/user-attachments/assets/9ca7ea6d-522b-4033-909a-2ee626960e8a"
/>

---------

Signed-off-by: JasonLi1909 <jasli1909@gmail.com>
SheldonTsen pushed a commit to SheldonTsen/ray that referenced this pull request Dec 1, 2025
This PR: 
- adds a new page to the Ray Train docs called "Monitor your
Application" that lists and describes the Prometheus metrics emitted by
Ray Train
- Updates the Ray Core system metrics docs to include some missing
metrics

Link to example build:
https://anyscale-ray--58235.com.readthedocs.build/en/58235/train/user-guides/monitor-your-application.html

Preview Screenshot:

<img width="1630" height="662" alt="Screenshot 2025-10-29 at 2 46 07 PM"
src="https://github.com/user-attachments/assets/9ca7ea6d-522b-4033-909a-2ee626960e8a"
/>

---------

Signed-off-by: JasonLi1909 <jasli1909@gmail.com>
Future-Outlier pushed a commit to Future-Outlier/ray that referenced this pull request Dec 7, 2025
This PR:
- adds a new page to the Ray Train docs called "Monitor your
Application" that lists and describes the Prometheus metrics emitted by
Ray Train
- Updates the Ray Core system metrics docs to include some missing
metrics

Link to example build:
https://anyscale-ray--58235.com.readthedocs.build/en/58235/train/user-guides/monitor-your-application.html

Preview Screenshot:

<img width="1630" height="662" alt="Screenshot 2025-10-29 at 2 46 07 PM"
src="https://github.com/user-attachments/assets/9ca7ea6d-522b-4033-909a-2ee626960e8a"
/>

---------

Signed-off-by: JasonLi1909 <jasli1909@gmail.com>
Signed-off-by: Future-Outlier <eric901201@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

go add ONLY when ready to merge, run all tests train Ray Train Related Issue

3 participants