Intermediary Error logger implementation #9
Conversation
Seems like script source is not available if scripts are exported as binary tokens. This is the default in Godot 4.3, and it can be changed in export settings.
|
I've spun off a branch from this PR's - going to wait for the review/merge, and later rebase onto main. |
There was a problem hiding this comment.
you might want a review from @bitsandfoxes and/or @PlasmaDev5 before merging but I skimmed and lgtm.
Just still missing tests but I imagine this is coming then as thigns shape up a bit more
There was a problem hiding this comment.
This looks amazing! One thing just does not fully make sense to me:
The way I see this feature is that we're creating breadcrumbs out of logs and that errors that got logged to the logfile are automatically captured as events. After they have been captured they should get added as breadcrumbs as well.
I mean we can iterate on it for sure so this is not a blocker but I think the functionality is a tiny bit off.
| @@ -26,3 +30,4 @@ window/stretch/aspect="keep_height" | |||
|
|
|||
| config/dsn="https://3f1e095cf2e14598a0bd5b4ff324f712@o447951.ingest.us.sentry.io/6680910" | |||
| config/debug=true | |||
| config/error_logger/capture_type=1 | |||
There was a problem hiding this comment.
I take it this is the option that controls this feature? Why is it a type?
There was a problem hiding this comment.
You're right, it shouldn't be mutually exclusive.
| @@ -8,6 +8,12 @@ | |||
| #include <godot_cpp/variant/variant.hpp> | |||
|
|
|||
| class SentryOptions { | |||
| public: | |||
| enum CaptureType { | |||
There was a problem hiding this comment.
I'm not sure I understand the split between capture as breadcrumb and capture as event. Those are not mutually exclusive.
There was a problem hiding this comment.
Makes sense! Thanks for reviewing. I added an issue to track it: #10
While we are waiting for the Godot PRs (see #4), this is a logger implementation based on log file parsing. For practical usage, my performance measurements showed it as quite usable, and it's completely optional for game developers. It should be trivial to adapt it when the user-facing logger class is exposed in the Godot public API.
The current limitation is that we don't have access to a script stack trace, but we still have the line number, the function and the file in which the error has occurred (almost equivalent to the top frame of the stack trace).
Error logger section in Project Settings
Error captured as event
Note: the source code is automatically included with the event if the corresponding option is enabled. It is not available if project scripts are exported as binary tokens.