Log expected api errors as warning instead of error #5285
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
Performance Report✔️ no performance regression detected Full benchmark results
|
maschad
suggested changes
Mar 20, 2023
regarding this, if there are non-500 error codes which are not considered a warning but something critical then the error code must be changed |
nflaig
commented
Mar 20, 2023
nflaig
added
the
scope-logging
nflaig
commented
Mar 21, 2023
| this.logger.error(`Req ${req.id} ${operationId} error`, {}, err); | ||
|
|
||
| if (err instanceof ApiError) { | ||
| this.logger.warn(`Req ${req.id} ${operationId} failed`, {reason: err.message}); |
There was a problem hiding this comment.
@wemeetagain I want to establish this pattern that for non-critical issues we use the terms "failed" and "reason" instead of "error" as based on my observations the term "error" scares a lot of users, especially less technical ones. What do you think?
There was a problem hiding this comment.
i think the stack trace is very useful, but we can move the log to debug will full trace, an additional warn log in this format is acceptable
There was a problem hiding this comment.
but we can move the log to debug will full trace, an additional warn log in this format is acceptable
that's also what I was considering, sounds like a reasonable compromise. Not sure if it makes sense here though in case of ApiError, if someone feels strongly about having a stack trace for those we should probably log it as well to debug
wemeetagain
approved these changes
Mar 21, 2023
|
🎉 This PR is included in v1.7.0 🎉 |
Merged
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.
Motivation
Expected API errors (
ApiError) should be logged as warnings instead of errors to not unnecessarily scare users. Printing out the stacktrace does not help here either, it just creates noise.Description
Check if error is
ApiErrorand just log it aswarnand only print out theerr.message.Unexpected errors (non
ApiError) will still be logged aserrorincluding the stacktrace.Closes #5265, related discussion