Skip to content

Fix file descriptor leak in logger reinitialisation logic and print stack trace in severe logs#347

Merged
nikita-tkachenko-datadog merged 3 commits into
masterfrom
nikita-tkachenko/logger-fd-leak
Aug 29, 2023
Merged

Fix file descriptor leak in logger reinitialisation logic and print stack trace in severe logs#347
nikita-tkachenko-datadog merged 3 commits into
masterfrom
nikita-tkachenko/logger-fd-leak

Conversation

@nikita-tkachenko-datadog

Copy link
Copy Markdown
Collaborator

Requirements for Contributing to this repository

  • 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.

@nikita-tkachenko-datadog nikita-tkachenko-datadog added the changelog/Fixed Fixed features results into a bug fix version bump label Jun 28, 2023

@sarah-witt sarah-witt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

@sarah-witt sarah-witt changed the title Fix file descriptor leak in logger reinitialisation logic Fix file descriptor leak in logger reinitialisation logic and print stack trace in severe logs Aug 29, 2023
@nikita-tkachenko-datadog
nikita-tkachenko-datadog merged commit 48f9108 into master Aug 29, 2023
@nikita-tkachenko-datadog
nikita-tkachenko-datadog deleted the nikita-tkachenko/logger-fd-leak branch August 29, 2023 17:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog/Fixed Fixed features results into a bug fix version bump

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants