fix: Restore Backward Compatibility with Spring Boot Reconfiguration #3773
+131
−14
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
Add test verifying expected behavior of `LoggerContext.start(Configuration)` to ensure backward compatibility: - The configuration must always be replaced, even if the context has already started. - Only the first configuration should register the shutdown hook.
Although Spring Boot never directly starts a `LoggerContext`, its logging system — including our `Log4j2SpringBootLoggingSystem` and equivalents in Spring Boot 2.x and 3.x — has consistently used `LoggerContext.start(Configuration)` for reconfiguration. To maintain backward compatibility with these usages, `start(Configuration)` now falls back to `reconfigure(Configuration)` if the context is already started. Closes #3770
vy
reviewed
Jun 27, 2025
log4j-core-test/src/test/java/org/apache/logging/log4j/core/ShutdownDisabledTest.java
Outdated
Show resolved
Hide resolved
vy
reviewed
Jun 27, 2025
log4j-core-test/src/test/java/org/apache/logging/log4j/core/LoggerContextTest.java
Show resolved
Hide resolved
vy
approved these changes
Jun 27, 2025
There was a problem hiding this comment.
@ppkarwasz, thanks for taking care of this. 🙏
Is #2614 where we removed the old behaviour? If so, would you mind referring to it in the ticket description, please?
ppkarwasz
added a commit
that referenced
this pull request
Jul 5, 2025
…3773) ### feat: add tests for `LoggerContext.start` behavior Add test verifying expected behavior of `LoggerContext.start(Configuration)` to ensure backward compatibility: - The configuration must always be replaced, even if the context has already started. - Only the first configuration should register the shutdown hook. ### fix: Restore Backward Compatibility with Spring Boot Reconfiguration Although Spring Boot never directly starts a `LoggerContext`, its logging system — including our `Log4j2SpringBootLoggingSystem` and equivalents in Spring Boot 2.x and 3.x — has consistently used `LoggerContext.start(Configuration)` for reconfiguration. This use case was not taken into consideration in #2614, causing a regression for Spring Boot users. To maintain backward compatibility with these usages, `start(Configuration)` now falls back to `reconfigure(Configuration)` if the context is already started. Closes #3770
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Although Spring Boot never directly starts a
LoggerContext, its logging system — including ourLog4j2SpringBootLoggingSystemand equivalents in Spring Boot 2.x and 3.x — has consistently usedLoggerContext.start(Configuration)for reconfiguration.This use case was not taken into consideration in #2614, causing a regression for Spring Boot users.
To maintain backward compatibility with these usages,
start(Configuration)now falls back toreconfigure(Configuration)if the context is already started.Closes #3770