Skip to content

[Docs] Add documentation for RAY_BACKEND_LOG_JSON environment variable#59962

Merged
edoakes merged 1 commit into
ray-project:masterfrom
richabanker:str-logs-docs
Mar 10, 2026
Merged

[Docs] Add documentation for RAY_BACKEND_LOG_JSON environment variable#59962
edoakes merged 1 commit into
ray-project:masterfrom
richabanker:str-logs-docs

Conversation

@richabanker

Copy link
Copy Markdown
Contributor

Description

Briefly describe what this PR accomplishes and why it's needed.

Document how to enable JSON format for Ray's backend system logs
(Python and C++) using the RAY_BACKEND_LOG_JSON=1 environment variable.

Also fix capitalization of "c++" to "C++" for consistency.

@richabanker richabanker requested a review from a team as a code owner January 8, 2026 05:39
@gemini-code-assist

Copy link
Copy Markdown
Contributor

Warning

You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again!

@ray-gardener ray-gardener Bot added docs An issue or change related to documentation core Issues that should be addressed in Ray Core community-contribution Contributed by the community labels Jan 8, 2026
@Yicheng-Lu-llll Yicheng-Lu-llll self-requested a review January 16, 2026 01:23
RAY_BACKEND_LOG_JSON=1 ray start --head
```

When enabled, Python system logs output in the following JSON format:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The C++ part looks good to me. For the Python part, I might be mistaken, but it seems only the Job Supervisor uses JSON format, while other components like the Dashboard do not. Would you mind confirming this and noting it in the document if needed? Thanks!

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I could also only find Job Supervisor supporting the RAY_BACKEND_LOG_JSON_ENV_VAR and JSONFormatter, made a note as suggested. Thanks

@Yicheng-Lu-llll

Copy link
Copy Markdown
Member

@richabanker Thank you! Could you also resolve the DCO issues? Otherwise, LGTM!

@github-actions

github-actions Bot commented Feb 9, 2026

Copy link
Copy Markdown

This pull request has been automatically marked as stale because it has not had
any activity for 14 days. It will be closed in another 14 days if no further activity occurs.
Thank you for your contributions.

You can always ask for help on our discussion forum or Ray's public slack channel.

If you'd like to keep this open, just leave any comment, and the stale label will be removed.

@github-actions github-actions Bot added the stale The issue is stale. It will be closed within 7 days unless there are further conversation label Feb 9, 2026
@Yicheng-Lu-llll Yicheng-Lu-llll removed the stale The issue is stale. It will be closed within 7 days unless there are further conversation label Feb 13, 2026
@Yicheng-Lu-llll

Copy link
Copy Markdown
Member

@richabanker Let me know once you fix the DCO issue.

@Yicheng-Lu-llll Yicheng-Lu-llll self-assigned this Feb 13, 2026
@github-actions

Copy link
Copy Markdown

This pull request has been automatically marked as stale because it has not had
any activity for 14 days. It will be closed in another 14 days if no further activity occurs.
Thank you for your contributions.

You can always ask for help on our discussion forum or Ray's public slack channel.

If you'd like to keep this open, just leave any comment, and the stale label will be removed.

@github-actions github-actions Bot added the stale The issue is stale. It will be closed within 7 days unless there are further conversation label Feb 27, 2026
Signed-off-by: Richa Banker <richabanker@google.com>
@richabanker

Copy link
Copy Markdown
Contributor Author

@Yicheng-Lu-llll I think its fixed now. Sorry about the super long delay on getting back to this!

@github-actions github-actions Bot added unstale A PR that has been marked unstale. It will not get marked stale again if this label is on it. and removed stale The issue is stale. It will be closed within 7 days unless there are further conversation labels Mar 6, 2026
@Yicheng-Lu-llll Yicheng-Lu-llll added the go add ONLY when ready to merge, run all tests label Mar 6, 2026
@Yicheng-Lu-llll

Copy link
Copy Markdown
Member

cc @edoakes @MengjinYan for review/merge.

@edoakes edoakes merged commit 59f9dc8 into ray-project:master Mar 10, 2026
6 checks passed
abrarsheikh pushed a commit that referenced this pull request Mar 11, 2026
#59962)

Document how to enable JSON format for Ray's backend system logs
(Python and C++) using the RAY_BACKEND_LOG_JSON=1 environment variable.

Also fix capitalization of "c++" to "C++" for consistency.

Signed-off-by: Richa Banker <richabanker@google.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

community-contribution Contributed by the community core Issues that should be addressed in Ray Core docs An issue or change related to documentation go add ONLY when ready to merge, run all tests unstale A PR that has been marked unstale. It will not get marked stale again if this label is on it.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants