Fix file descriptor leak in logger reinitialisation logic and print stack trace in severe logs #347
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.
Requirements for Contributing to this repository
What does this PR do?
Fixes a file descriptor leak in logger reinitialisation logic.
Whenever there is problem with the logger, it is reinitialized.
Reinitialisation entails creating a new logger instance.
The problem is that the old instance is not being closed.
The logger uses a
SocketHandler
, which opens a socket.This handler needs to be closed, otherwise file descriptor that corresponds to the opened socket "leaks".
If the logger is reinitialised many times the process runs out of available file descriptors.
Description of the Change
Whenever the logger is reinitialised, previously existing instance (if any) is properly closed.
Alternate Designs
Possible Drawbacks
Verification Process
Tested manually using a dockerized Jenkins instance.
Additional Notes
DatadogUtilities#severe
was changed to log exception stack trace: the stack trace is the most valuable and useful piece of info, and it is rather troublesome to ask customers to tweak their log levels and reproduce their problem all over again because the exception was not logged the first time.Release Notes
Review checklist (to be filled by reviewers)
changelog/
label attached. If applicable it should have thebackward-incompatible
label attached.do-not-merge/
label attached.kind/
andseverity/
labels attached at least.