[Data] Reduce internal Ray Data stack trace output by default #43251
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Scott Lee <sjl@anyscale.com>
8 tasks
Signed-off-by: Scott Lee <sjl@anyscale.com>
Signed-off-by: Scott Lee <sjl@anyscale.com>
scottjlee
requested review from
ericl,
scv119,
c21,
amogkam,
bveeramani,
raulchen,
stephanie-wang and
omatthew98
as code owners
stephanie-wang
approved these changes
Feb 21, 2024
| By default, the stack trace for these exceptions is omitted from | ||
| stdout, but will still be emitted to the Ray Data specific log file. | ||
| To emit all stack frames to stdout, set | ||
| `DataContext.internal_stack_trace_stdout` to True.""" |
There was a problem hiding this comment.
Suggested change
| `DataContext.internal_stack_trace_stdout` to True.""" | |
| `DataContext.log_internal_stack_trace_to_stdout` to True.""" |
| "is omitted from stdout, and only written to the Ray Data log " | ||
| f"file at {data_exception_logger._log_path}. To output the " | ||
| "full stack trace to stdout, set " | ||
| "`DataContext.internal_stack_trace_stdout` to True`." |
There was a problem hiding this comment.
Suggested change
| "`DataContext.internal_stack_trace_stdout` to True`." | |
| "`DataContext.log_internal_stack_trace_to_stdout` to True`." |
python/ray/data/tests/test_logger.py
Outdated
Comment on lines
64
to
68
| if not found_exception_call: | ||
| raise Exception( | ||
| f"Searched logs for the following text, but did not find: `{text}` " | ||
| f"All calls: {mock_calls}" | ||
| ) |
Signed-off-by: Scott Lee <sjl@anyscale.com>
raulchen
reviewed
Feb 21, 2024
| """Represents an Exception originating from user code, e.g. | ||
| user-specified UDF used in a Ray Data transformation. | ||
|
|
||
| By default, the stack trace for these exceptions is omitted from |
There was a problem hiding this comment.
this is a bit misleading. sounds like the entire stack trace is omitted.
| from ray.util.annotations import DeveloperAPI | ||
|
|
||
|
|
||
| @DeveloperAPI |
There was a problem hiding this comment.
not a huge deal. but I slightly prefer to put these 2 exceptions and the util function in a new ray/data/exceptions.py file.
Because they are more related to exceptions, instead of logging. And we will no longer need UserCodeException.__module__ = __name__ as well
| log_to_stdout = DataContext.get_current().log_internal_stack_trace_to_stdout | ||
| # data_exception_logger.get_logger(log_to_stdout=log_to_stdout).exception(e) | ||
|
|
||
| is_user_code_exception = isinstance(e, ray.exceptions.RayTaskError) |
There was a problem hiding this comment.
ray.exceptions.RayTaskError doesn't always mean user code exception. it could be because of other ray internal exceptions from the tasks.
To accurately detect user code exception. we should add a try-catch wrap to the UDF.
| ) | ||
|
|
||
| if is_user_code_exception: | ||
| raise e.with_traceback(None) from UserCodeException() |
There was a problem hiding this comment.
this should be raise UserCodeException() from e.with_traceback(None) right?
Because e was the original exception, and the new UserCodeException was caused by e.
But I think it's okay to just raise e.with_traceback(None) as well.
We can use UserCodeException to wrap the UDF, as I mentioned in the above comment.
Signed-off-by: Scott Lee <sjl@anyscale.com>
Signed-off-by: Scott Lee <sjl@anyscale.com>
Signed-off-by: Scott Lee <sjl@anyscale.com>
Signed-off-by: Scott Lee <sjl@anyscale.com>
Signed-off-by: Scott Lee <sjl@anyscale.com>
Signed-off-by: Scott Lee <sjl@anyscale.com>
Signed-off-by: Scott Lee <sjl@anyscale.com>
Signed-off-by: Scott Lee <sjl@anyscale.com>
|
Remaining premerge failure is unrelated to this PR ( |
c21
approved these changes
Feb 29, 2024
raulchen
approved these changes
Feb 29, 2024
|
Might be breaking som macos/windows tests, i'm validating 
|
can-anyscale
added a commit
that referenced
this pull request
Mar 4, 2024
raulchen
pushed a commit
that referenced
this pull request
Mar 6, 2024
… default"" (#43735) Reverts #43638, adding changes from original PR #43251 with fix for breaking osx / windows tests. Closes #40802 Postmerge test run: https://buildkite.com/ray-project/postmerge/builds/3306 --------- Signed-off-by: Scott Lee <sjl@anyscale.com>
hebiao064
pushed a commit
to hebiao064/ray
that referenced
this pull request
Mar 12, 2024
…oject#43251) Whenever there is any error when using Ray Data, the full stack trace is currently printed to stdout. If the exception originates from the user code, the internal stack trace is usually not needed, and obfuscates the relevant user code with the actual error. This PR reduces the stack trace output to omit internal Ray Data or Ray Core code in the stdout output, and only logs the full stack trace to the Ray Data ray-data.log file. Users can enable the full stack trace outputted to stdout by setting DataContext.log_internal_stack_trace_to_stdout = True. Signed-off-by: Scott Lee <sjl@anyscale.com>
ryanaoleary
pushed a commit
to ryanaoleary/ray
that referenced
this pull request
Jun 7, 2024
…oject#43251) Whenever there is any error when using Ray Data, the full stack trace is currently printed to stdout. If the exception originates from the user code, the internal stack trace is usually not needed, and obfuscates the relevant user code with the actual error. This PR reduces the stack trace output to omit internal Ray Data or Ray Core code in the stdout output, and only logs the full stack trace to the Ray Data ray-data.log file. Users can enable the full stack trace outputted to stdout by setting DataContext.log_internal_stack_trace_to_stdout = True. Signed-off-by: Scott Lee <sjl@anyscale.com>
ryanaoleary
pushed a commit
to ryanaoleary/ray
that referenced
this pull request
Jun 7, 2024
…ray-project#43251)" (ray-project#43638) This reverts commit 8eea8d8. Confirmed that this broke darwin://python/ray/tests:test_actor_retry (go/flaky)
ryanaoleary
pushed a commit
to ryanaoleary/ray
that referenced
this pull request
Jun 7, 2024
… default"" (ray-project#43735) Reverts ray-project#43638, adding changes from original PR ray-project#43251 with fix for breaking osx / windows tests. Closes ray-project#40802 Postmerge test run: https://buildkite.com/ray-project/postmerge/builds/3306 --------- Signed-off-by: Scott Lee <sjl@anyscale.com>
8 tasks
8 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why are these changes needed?
Whenever there is any error when using Ray Data, the full stack trace is currently printed to stdout. If the exception originates from the user code, the internal stack trace is usually not needed, and obfuscates the relevant user code with the actual error. This PR reduces the stack trace output to omit internal Ray Data or Ray Core code in the stdout output, and only logs the full stack trace to the Ray Data ray-data.log file. Users can enable the full stack trace outputted to stdout by setting DataContext.log_internal_stack_trace_to_stdout = True.
For the sample user code with an error, we compare the stack trace output for several Ray Data usages before and after this PR:
The output is as follows:
Before (stdout):
After (stdout):
After (ray-data.log):
Before (stdout):
After (stdout):
After (ray-data.log):
Before (stdout):
After (stdout):
After (ray-data.log):
Finally, here is a comparison of the log output in the case of an internal Ray Data code error (I added a
1/0in the Ray Data code to trigger an exception):Before:
After (stdout):
After (ray-data.log):
Related issue number
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/under thecorresponding
.rstfile.