Fill out the template below. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
The pull request must only fix one issue at the time.
The pull request must update the test suite to demonstrate the changed functionality.
After you create the pull request, all status checks must be pass before a maintainer reviews your contribution. For more details, please see CONTRIBUTING.
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)
[ ] Feature or bug fix MUST have appropriate tests (unit, integration, etc...)
[ ] PR title must be written as a CHANGELOG entry (see why)
[ ] Files changes must correspond to the primary purpose of the PR as described in the title (small unrelated changes should have their own PR)
[ ] PR must have one changelog/ label attached. If applicable it should have the backward-incompatible label attached.
[ ] PR should not have do-not-merge/ label attached.
[ ] If Applicable, issue must have kind/ and severity/ labels attached at least.
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#severewas 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-incompatiblelabel attached.do-not-merge/label attached.kind/andseverity/labels attached at least.