-
Notifications
You must be signed in to change notification settings - Fork 40.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Disable Log4j2's shutdown hook by default
Previously, Log4j2's own shutdown hook was only disabled when Log4j2 detected javax.servlet.Servlet on the classpath and, therefore, determined that it was running in a web application. In an application without Servlet on the classpath, this could lead to both Log4j2's shut down hook and and logging system's shutdown handler both stopping Log4j2. This could result in a failure as the second attempt at stopping would result in reinitialization which would fail as the JVM is already shutting down. This commit introduces a new Log4j2 PropertySource implementation, registered via META-INF/services, that sets the log4j.shutdownHookEnabled property to false. This will ensure that Log4j2's own shutdown hook is disabled by default whenever Spring Boot is on the classpath and not just in Servlet-based web applications. Fixes gh-26953
- Loading branch information
1 parent
0a2fe35
commit cf940fd
Showing
5 changed files
with
67 additions
and
54 deletions.
There are no files selected for viewing
This file contains 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
54 changes: 54 additions & 0 deletions
54
...-boot/src/main/java/org/springframework/boot/logging/log4j2/SpringBootPropertySource.java
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
/* | ||
* Copyright 2012-2021 the original author or authors. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* https://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package org.springframework.boot.logging.log4j2; | ||
|
||
import java.util.Collections; | ||
import java.util.Map; | ||
|
||
import org.apache.logging.log4j.core.util.ShutdownCallbackRegistry; | ||
import org.apache.logging.log4j.util.BiConsumer; | ||
import org.apache.logging.log4j.util.PropertySource; | ||
|
||
/** | ||
* Spring Boot {@link PropertySource} that disables Log4j2's shutdown hook. | ||
* | ||
* @author Andy Wilkinson | ||
* @since 2.5.2 | ||
*/ | ||
public class SpringBootPropertySource implements PropertySource { | ||
|
||
private static final String PREFIX = "log4j."; | ||
|
||
private final Map<String, String> properties = Collections | ||
.singletonMap(ShutdownCallbackRegistry.SHUTDOWN_HOOK_ENABLED, "false"); | ||
|
||
@Override | ||
public void forEach(BiConsumer<String, String> action) { | ||
this.properties.forEach((key, value) -> action.accept(key, value)); | ||
} | ||
|
||
@Override | ||
public CharSequence getNormalForm(Iterable<? extends CharSequence> tokens) { | ||
return PREFIX + Util.joinAsCamelCase(tokens); | ||
} | ||
|
||
@Override | ||
public int getPriority() { | ||
return -200; | ||
} | ||
|
||
} |
1 change: 1 addition & 0 deletions
1
...ng-boot/src/main/resources/META-INF/services/org.apache.logging.log4j.util.PropertySource
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
org.springframework.boot.logging.log4j2.SpringBootPropertySource |
This file contains 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
42 changes: 0 additions & 42 deletions
42
...est/java/org/springframework/boot/logging/log4j2/SpringBootConfigurationFactoryTests.java
This file was deleted.
Oops, something went wrong.