Allow skipping unavailable override configurations in Log4j2

Introduced support for the 'optional:' prefix in Log4j2 override file locations, ensuring missing files are ignored without throwing exceptions. See spring-projectsgh-44399 Signed-off-by: Dmytro Nosan <[email protected]>
nosan · Feb 27, 2025 · e4d2593 · e4d2593
1 parent f45a3d7
commit e4d2593
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 5 deletions.
diff --git a/...pring-boot/src/main/java/org/springframework/boot/logging/log4j2/Log4J2LoggingSystem.java b/...pring-boot/src/main/java/org/springframework/boot/logging/log4j2/Log4J2LoggingSystem.java
@@ -68,6 +68,7 @@
 import org.springframework.core.annotation.Order;
 import org.springframework.core.env.Environment;
 import org.springframework.core.io.Resource;
+import org.springframework.core.io.ResourceLoader;
 import org.springframework.util.Assert;
 import org.springframework.util.ClassUtils;
 import org.springframework.util.CollectionUtils;
@@ -85,6 +86,8 @@
  */
 public class Log4J2LoggingSystem extends AbstractLoggingSystem {
 
+	private static final String OPTIONAL_PREFIX = "optional:";
+
 	private static final String LOG4J_BRIDGE_HANDLER = "org.apache.logging.log4j.jul.Log4jBridgeHandler";
 
 	private static final String LOG4J_LOG_MANAGER = "org.apache.logging.log4j.jul.LogManager";
@@ -269,9 +272,13 @@ protected void loadConfiguration(String location, LogFile logFile, List<String>
 		try {
 			List<Configuration> configurations = new ArrayList<>();
 			LoggerContext context = getLoggerContext();
-			configurations.add(load(location, context));
+			ResourceLoader resourceLoader = ApplicationResourceLoader.get();
+			configurations.add(load(resourceLoader, location, context));
 			for (String override : overrides) {
-				configurations.add(load(override, context));
+				Configuration overrideConfiguration = loadOptional(resourceLoader, override, context);
+				if (overrideConfiguration != null) {
+					configurations.add(overrideConfiguration);
+				}
 			}
 			Configuration configuration = (configurations.size() > 1) ? createComposite(configurations)
 					: configurations.iterator().next();
@@ -282,8 +289,22 @@ protected void loadConfiguration(String location, LogFile logFile, List<String>
 		}
 	}
 
-	private Configuration load(String location, LoggerContext context) throws IOException {
-		Resource resource = ApplicationResourceLoader.get().getResource(location);
+	private Configuration load(ResourceLoader resourceLoader, String location, LoggerContext context)
+			throws IOException {
+		Resource resource = resourceLoader.getResource(location);
+		return load(resource, context);
+	}
+
+	private Configuration loadOptional(ResourceLoader resourceLoader, String location, LoggerContext context)
+			throws IOException {
+		if (location.startsWith(OPTIONAL_PREFIX)) {
+			Resource resource = resourceLoader.getResource(location.substring(OPTIONAL_PREFIX.length()));
+			return (resource.exists()) ? load(resource, context) : null;
+		}
+		return load(resourceLoader, location, context);
+	}
+
+	private Configuration load(Resource resource, LoggerContext context) throws IOException {
 		ConfigurationSource source = getConfigurationSource(resource);
 		return ConfigurationFactory.getInstance().getConfiguration(context, source);
 	}
@@ -323,9 +344,13 @@ private void reinitializeWithOverrides(List<String> overrides) {
 		Configuration base = context.getConfiguration();
 		List<AbstractConfiguration> configurations = new ArrayList<>();
 		configurations.add((AbstractConfiguration) base);
+		ResourceLoader resourceLoader = ApplicationResourceLoader.get();
 		for (String override : overrides) {
 			try {
-				configurations.add((AbstractConfiguration) load(override, context));
+				Configuration overrideConfiguration = loadOptional(resourceLoader, override, context);
+				if (overrideConfiguration != null) {
+					configurations.add((AbstractConfiguration) overrideConfiguration);
+				}
 			}
 			catch (IOException ex) {
 				throw new RuntimeException("Failed to load overriding configuration from '" + override + "'", ex);

diff --git a/...-boot/src/test/java/org/springframework/boot/logging/log4j2/Log4J2LoggingSystemTests.java b/...-boot/src/test/java/org/springframework/boot/logging/log4j2/Log4J2LoggingSystemTests.java
@@ -43,6 +43,7 @@
 import org.apache.logging.log4j.core.config.Reconfigurable;
 import org.apache.logging.log4j.core.config.composite.CompositeConfiguration;
 import org.apache.logging.log4j.core.config.plugins.util.PluginRegistry;
+import org.apache.logging.log4j.core.config.xml.XmlConfiguration;
 import org.apache.logging.log4j.core.util.ShutdownCallbackRegistry;
 import org.apache.logging.log4j.jul.Log4jBridgeHandler;
 import org.apache.logging.log4j.status.StatusListener;
@@ -453,6 +454,23 @@ void shutdownHookIsDisabled() {
 			.isFalse();
 	}
 
+	@Test
+	@WithNonDefaultXmlResource
+	void loadConfigurationOptionalOverrideConfigurationWhenDoesNotExist() {
+		this.environment.setProperty("logging.log4j2.config.override", "optional:classpath:override.xml");
+		this.loggingSystem.initialize(this.initializationContext, "classpath:nondefault.xml", null);
+		assertThat(this.loggingSystem.getConfiguration()).isInstanceOf(XmlConfiguration.class);
+	}
+
+	@Test
+	@WithNonDefaultXmlResource
+	@WithOverrideXmlResource
+	void loadConfigurationOptionalOverrideConfigurationWhenExists() {
+		this.environment.setProperty("logging.log4j2.config.override", "optional:classpath:override.xml");
+		this.loggingSystem.initialize(this.initializationContext, "classpath:nondefault.xml", null);
+		assertThat(this.loggingSystem.getConfiguration()).isInstanceOf(CompositeConfiguration.class);
+	}
+
 	@Test
 	@WithNonDefaultXmlResource
 	@WithOverrideXmlResource