Repository navigation
Clarify web application shutdown listener configuration - #4408
Open
Shekharrajak wants to merge 2 commits into
Open
Shekharrajak wants to merge 2 commits into
Shekharrajak wants to merge 2 commits into
Conversation
Member
|
I am not sure if our doc says it anywhere but log4j-web is not required for apps using Spring Boot. |
Comment on lines
+107
to
+112
|
|
||
| Context listeners are destroyed in reverse initialization order. | ||
| Registering the Log4j listener first allows other listeners to log during their `contextDestroyed()` callbacks before Log4j shuts down. | ||
|
|
||
| Since Log4j 2.21.0, this works alongside automatic listener registration; | ||
| you do not need to set `isLog4jAutoShutdownDisabled` to `true`. |
Contributor
There was a problem hiding this comment.
The WARNING block just above already says to register Log4jServletContextListener first so it runs last at shutdown.
Suggested change
| Context listeners are destroyed in reverse initialization order. | |
| Registering the Log4j listener first allows other listeners to log during their `contextDestroyed()` callbacks before Log4j shuts down. | |
| Since Log4j 2.21.0, this works alongside automatic listener registration; | |
| you do not need to set `isLog4jAutoShutdownDisabled` to `true`. |
Comment on lines
+161
to
+164
|
|
||
| If you only need logging during other listeners' `contextDestroyed()` callbacks, | ||
| leave this parameter at its default value and follow the | ||
| <<log4j-jakarta-web-installation,listener-ordering guidance>>. |
Contributor
There was a problem hiding this comment.
This points back to the same WARNING block. The paragraph above already covers what to do when the parameter is true.
Suggested change
| If you only need logging during other listeners' `contextDestroyed()` callbacks, | |
| leave this parameter at its default value and follow the | |
| <<log4j-jakarta-web-installation,listener-ordering guidance>>. |
Contributor
|
The |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes: #2689
This how it will be rendered in UI:
Checklist
2.xbranch if you are targeting Log4j 2; usemainotherwise./mvnw verifysucceeds (the build instructions)src/changelog/.2.x.xdirectory