chore: clean up logging#572
Merged
Merged
Conversation
Winston handles .error(message, err) okay, but not .error(err) by itself. For reability we also want to make sure the provided message ends with a space so that the concatenated message from the error is separate. Due to a winston regression introduced in 3.x, we cannot pass other meta information after the error without passing error.message and error.stack explicitly. This means we may lose additional error properties. We cannot destructure the error either (non-iterable properties). A better fix would be to write a custom log formatter that is error-aware. There are a few examples on GitHub, but none that looked straightforward. We don't want to break JSON logging and parsing.
bchrobot
force-pushed
the
chore/clean-up-logging
branch
from
b19c7cb to
5c003e4
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Winston handles .error(message, err) okay, but not .error(err) by itself. For reability we also
want to make sure the provided message ends with a space so that the concatenated message from the
error is separate.
Due to a winston regression introduced in 3.x, we cannot pass other meta information after the error
without passing error.message and error.stack explicitly. This means we may lose additional error
properties. We cannot destructure the error either (non-iterable properties).
A better fix would be to write a custom log formatter that is error-aware. There are a few examples
on GitHub, but none that looked straightforward. We don't want to break JSON logging and parsing.
https://medium.com/@stieg/winston-3-and-logging-error-stacks-cf70b2111289
winstonjs/winston#1351
winstonjs/winston#1498
winstonjs/winston#1338
winstonjs/winston#1562