ref: Use the global LogHandler to capture unhandled Exceptions #731
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
Turns out the Unity Runtime actually "handles" uncaught Exceptions from scripts and hands them of to its global LogHandler. This is presumably the reason why AppDomain.UnhandledException is never being invoked for them. We can capture these Exceptions (and in the future enhance them with native instruction addrs) by shimming the global LogHandler.
This was referenced May 17, 2022
Swatinem
changed the title
Swatinem
requested review from
bruno-garcia,
bitsandfoxes and
vaind
as code owners
| _unityLogHandler.LogException(exception, context); | ||
| } | ||
|
|
||
| internal void CaptureException(Exception exception, UnityEngine.Object? context) |
There was a problem hiding this comment.
what's in context? Anything useful to add to the event or crumb?
There was a problem hiding this comment.
That's the crazy awesome part: When you're calling Debug.Log("My log message", this); you can actually pass "whatever" in there as context (the MonoBehaviour in this case). Inside the editor this lets you click the log in the console and highlights the GameObject in the hierarchy. What that means for us is that we could grab all kinds of useful stuff from there.
- The name of the GameObject
- Other components on that GameObject
- Child Count
- e.t.c.
I'm just not sure what to grab. Probably the name.
…unity into ref/loghandler
Co-authored-by: Bruno Garcia <bruno@brunogarcia.com>
vaind
approved these changes
May 23, 2022
mattjohnsonpint
suggested changes
May 25, 2022
|
Looks mostly good, except the changes I suggested. But also, why is the Build - 2020 task failing? |
mattjohnsonpint
approved these changes
May 31, 2022
This was referenced May 31, 2022
Merged
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.
Turns out the Unity Runtime actually "handles" uncaught Exceptions from scripts and hands them off to its global LogHandler. This is presumably the reason why AppDomain.UnhandledException is never being invoked for them.
We can capture these Exceptions (and in the future enhance them with native instruction addrs) by shimming the global LogHandler.
This completely replaces and removes the Application.OnLogMessageReceived integration and the need to parse exceptions from string.
Resolves #579
Resolves #599