-
Notifications
You must be signed in to change notification settings - Fork 6k
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
[Core] Enable JSON Structured Logging Format in Ray #50471
Conversation
…tructured logging feature Signed-off-by: Mengjin Yan <mengjinyan3@gmail.com>
Signed-off-by: Mengjin Yan <mengjinyan3@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
just docs review, recommend setting up vale https://docs.ray.io/en/latest/ray-contribute/docs.html#vale and looking into active vs. passive voice https://developers.google.com/style/voice, that's usually a majority of the docs comments
In both `TEXT` and `JSON` encoding formats, the logs include Ray-specific fields such as `job_id`, `worker_id`, `node_id`, `actor_id`, and `task_id`, if available. | ||
|
||
* `log_level`: The log level for the driver process. The default is `INFO`. | ||
Available log levels are defined in the [Python logging library](https://docs.python.org/3/library/logging.html#logging-levels). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Available log levels are defined in the [Python logging library](https://docs.python.org/3/library/logging.html#logging-levels). | |
Python defines available log levels in the [Python logging library](https://docs.python.org/3/library/logging.html#logging-levels). |
active vs. passive
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think here it falls into the following exception scenarios of the active vs. passive:
To emphasize an object over an action.
It is to emphasize the available log levels the users can set.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we still want to prefer active voice most times, but ya i see what you're saying. Very minor though I don't think it makes much of a diff here either way
Co-authored-by: Dhyey Shah <dhyey2019@gmail.com> Signed-off-by: Mengjin Yan <mengjinyan3@gmail.com>
Co-authored-by: Dhyey Shah <dhyey2019@gmail.com> Signed-off-by: Mengjin Yan <mengjinyan3@gmail.com>
Co-authored-by: Dhyey Shah <dhyey2019@gmail.com> Signed-off-by: Mengjin Yan <mengjinyan3@gmail.com>
Co-authored-by: Dhyey Shah <dhyey2019@gmail.com> Signed-off-by: Mengjin Yan <mengjinyan3@gmail.com>
Co-authored-by: Dhyey Shah <dhyey2019@gmail.com> Signed-off-by: Mengjin Yan <mengjinyan3@gmail.com>
Co-authored-by: Dhyey Shah <dhyey2019@gmail.com> Signed-off-by: Mengjin Yan <mengjinyan3@gmail.com>
Co-authored-by: Dhyey Shah <dhyey2019@gmail.com> Signed-off-by: Mengjin Yan <mengjinyan3@gmail.com>
Co-authored-by: Dhyey Shah <dhyey2019@gmail.com> Signed-off-by: Mengjin Yan <mengjinyan3@gmail.com>
Co-authored-by: Dhyey Shah <dhyey2019@gmail.com> Signed-off-by: Mengjin Yan <mengjinyan3@gmail.com>
@@ -221,7 +221,7 @@ All Ray loggers are automatically configured in ``ray._private.ray_logging``. To | |||
import logging |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@angelinalg can you help review this file pls?
Signed-off-by: Mengjin Yan <mengjinyan3@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm from docs perspective
Why are these changes needed?
JSON
logging format option in RayRelated issue number
Checks
git commit -s
) in this PR.scripts/format.sh
to lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/
under thecorresponding
.rst
file.