log: Auto wrap baseplate.Error in logs #608
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
fishy
requested review from
kylelemons,
pacejackson and
ghirsch-reddit
and removed request for
a team
kylelemons
approved these changes
Mar 3, 2023
log/core_wrapper_test.go
Outdated
| if actual != expectedOrigin { | ||
| t.Errorf("Expected log line %s, got %s", expectedOrigin, actual) | ||
| if !strings.HasPrefix(actual, expectedOriginPrefix) { | ||
| t.Errorf("Expected log line to start with `%s`, got %s", expectedOriginPrefix, actual) |
There was a problem hiding this comment.
Suggested change
| t.Errorf("Expected log line to start with `%s`, got %s", expectedOriginPrefix, actual) | |
| t.Errorf("Expected log line to start with %q, got %q", expectedOriginPrefix, actual) |
fishy
force-pushed
the
zap-wrap-baseplate-error
branch
from
8443390
to
983f26a
Compare
ghirsch-reddit
approved these changes
Mar 3, 2023
There was a problem hiding this comment.
LGTM
Also a suggestion for future PRs like this where you move code, it can be convenient to make multiple commits where the first is literally just copy-pasting. That way it's quick for reviewers to first see that change, and to then look at the "actual changes" by filtering to just the other commits.
A pain point currently is that thrift generated baseplate.Error doesn't provide human readable message automatically since we are using optional fields, logging it will not produce human readable/meaningful info. Although we provided WrapBaseplateError helper function, it has its own limitations, for example it's usually only safe to be used unconditionally on the client side, which limited its usefulness on the server side. Add a wrapper to zapcore to auto wrap baseplate.Errors, so whenever they are logged via kv pairs they are always auto wrapped.
fishy
force-pushed
the
zap-wrap-baseplate-error
branch
from
983f26a
to
a43c3cf
Compare
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.
A pain point currently is that thrift generated baseplate.Error doesn't provide human readable message automatically since we are using optional fields, logging it will not produce human readable/meaningful info.
Although we provided WrapBaseplateError helper function, it has its own limitations, for example it's usually only safe to be used unconditionally on the client side, which limited its usefulness on the server side.
Add a wrapper to zapcore to auto wrap baseplate.Errors, so whenever they are logged via kv pairs they are always auto wrapped.