feat(pubsub): clean up logging #875
Merged
+44
−15
Conversation
This file contains hidden or 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
Clean up our general approach to logging: * include an `exc_message` extra wherever an exception is relevant to the log, to allow for message-level aggregation (eg. grouping errors by raised exception) * avoid using string templates in exception messages, to make aggregation easier (`message` is always a constant string for any given error case, so it can be alerted on) * downgrade application callback exceptions to a warning, since that can be a normal part of user flows -- if users want it logged at the error level, they can always do that themselves, we shouldn't be enforcing it
TheKevJames
requested review from
eileensoong and
olidp
and removed request for
a team
eddiedialpad
approved these changes
Mar 19, 2025
Contributor
eddiedialpad
left a comment
eddiedialpad
left a comment
There was a problem hiding this comment.
✅ Approved: logging practices in pubsub
cphoward
approved these changes
Mar 19, 2025
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.
Summary
Clean up our general approach to logging:
exc_messageextra wherever an exception is relevant tothe log, to allow for message-level aggregation (eg. grouping errors
by raised exception)
aggregation easier (
messageis always a constant string for anygiven error case, so it can be alerted on)
be a normal part of user flows -- if users want it logged at the error
level, they can always do that themselves, we shouldn't be enforcing
it