handle panics in logr.Marshaler.MarshalLog #52
Merged
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
pohly
commented
Feb 15, 2022
zapr_test.go
Outdated
| { | ||
| msg: "nil marshaler", | ||
| // Handled by our code: it just formats the error. | ||
| format: `{"ts":%f,"caller":"zapr/zapr_test.go:%d","msg":"nil marshaler","v":0,"obj":"<panic: runtime error: invalid memory address or nil pointer dereference>"} |
There was a problem hiding this comment.
I'm on the fence whether this should be consistent with funcr or with zap (see below).
There was a problem hiding this comment.
I would make it consistent with the underlying library, I think. I don't like the pattern, but I can see the argument. IMO the user chose to use zap, they should experience zap's design decisions (for better or worse)
There was a problem hiding this comment.
Okay. I've updated the handling accordingly.
The function might panic. The conclusion in go-logr/logr#130 was that the logger should record that. zapr only needs to do that when it calls MarshalLog. Strings and errors are handled by zap. For the sake of simplicity no attempt is made to detect the reason for the panic. In case of a panic, the key is replaced by "<key>Error" and the value with "PANIC=<panic reason>". This is consistent with how zap handles panics.
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.
The function might panic. The conclusion in
go-logr/logr#130 was that the logger should
record that.
zapr only needs to do that when it calls MarshalLog. Strings and errors are
handled by zap.
For the sake of simplicity no attempt is made to detect the reason for the
panic. As zapr cannot replace the key, it uses the same replacement value as
funcr because that stands out a bit more compared to the value used by zap.
/assign @thockin