Update log.entry() To Not Use Global Logger #1524
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
Multiple log entries sharing a global logger can cause changes to the entries' loggers to escape to the global level. For example, if an entry is changed to output its log lines to a custom io.Writer, the global logger will also be changed to write logs the custom io.Writer. Also, when concurrent callers attempt to change the output target of their respective log entries, the global logger will end up with racey outputs. This change clones the global logger inside the log.entry() function and binds the clone logger to the entry instance. Signed-off-by: Ivan Sim <ivan.sim@kasten.io>
|
Thanks for submitting this pull request 🎉. The team will review it soon and get back to you. If you haven't already, please take a moment to review our project contributing guideline and Code of Conduct document. |
e-sumin
approved these changes
Jun 29, 2022
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.
Change Overview
This PR updates the
log.entry()function to not bind newlogrus.Entryinstances to the global logger, to ensure that changes made to the entries' loggers do not escape to the global level. It ensures that all new entries are bound to clones of the global logger.Without this change, if an entry is changed to output its log lines to a custom
io.Writer, the global logger will also be changed to write logs the customio.Writer. Also, when concurrent callers attempt to change the output target of their respective log entries, the global logger will end up with racey outputs.Fixes #1532.
Signed-off-by: Ivan Sim ivan.sim@kasten.io
Pull request type
Please check the type of change your PR introduces:
Issues
Test Plan