chore: consolidate error/warning logging #2341
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
Various modules were "manually" implementing the `key=value` log format we use for Splunk searchability, and most errors or warnings were only being logged rather than reported to Sentry (where they are easier to organize and we can be proactively notified about them). This change consolidates all existing errors/warnings into a shared function that logs to both `Logger` and Sentry. * Sentry reports are also sent asynchronously, so they don't hold up returning a value to a client. * All errors/warnings are given a unique underscored identifier rather than a free-text message, which improves Splunk ergonomics. Existing logging at `info` level and below is not changed, but would be a logical next step.
PaulJKim
reviewed
Dec 11, 2024
digitalcora
temporarily deployed
to
dev-green
GitHub Actions
Inactive
PaulJKim
reviewed
Dec 12, 2024
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.
Various modules were "manually" implementing the
key=valuelog format we use for Splunk searchability, and most errors or warnings were only being logged rather than reported to Sentry (where they are easier to organize and we can be proactively notified about them). This change consolidates all existing errors/warnings into a shared function that logs to bothLoggerand Sentry.Sentry reports are also sent asynchronously, so they don't hold up returning a value to a client.
All errors/warnings are given a unique underscored identifier rather than a free-text message, which improves Splunk ergonomics.
Existing logging at
infolevel and below is not changed, but would be a logical next step.