fix: Prevent LogBuilder memory leak in Log4j API to Logback bridge
#3824
Conversation
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
This change fixes a potential memory leak in the `log4j-to-slf4j` module (Log4j API to Logback bridge) caused by the use of a thread-local `LogBuilder` pool. The leak occurred because the thread-local field was accessed, even when `log4j2.enableThreadlocals` was set to `false`. In servlet environments, this could lead to classloader leaks due to the persistence of thread-local references. With this fix, all access to the `ThreadLocal` is now **properly** gated by the `log4j2.enableThreadlocals` system property—matching how similar pooling behavior is handled in Log4j Core. This preserves the GC-free option for advanced users who explicitly opt in via `log4j2.enableThreadlocals = true`, while avoiding memory leaks for others. Fixes #3819
The `--add-opens` JVM option is now included in a dedicated Maven profile to avoid applying it during CI builds on JRE 8, where it is unsupported and unnecessary.
gmiscione
approved these changes
Jul 14, 2025
vy
approved these changes
Jul 20, 2025
vy
pushed a commit
to ashr123/logging-log4j2
that referenced
this pull request
Jul 20, 2025
vy
pushed a commit
that referenced
this pull request
Sep 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This change fixes a potential memory leak in the
log4j-to-slf4jmodule (Logback Log4j API binding) caused by the use of a thread-localLogBuilderpool.The leak occurred because the thread-local field was accidentally accessed, even when
log4j2.enableThreadlocalswas set tofalse. In servlet environments, this could lead to classloader leaks due to the persistence of thread-local references.With this fix, all access to the
ThreadLocalis now properly gated by thelog4j2.enableThreadlocalssystem property—matching how similar pooling behavior is handled in Log4j Core.This preserves the GC-free option for advanced users who explicitly opt in via
log4j2.enableThreadlocals = true, while avoiding memory leaks for others.Fixes #3819