Improve exception message to hint that you might need a '-spring' file

See gh-42405
spring-projects · Sep 23, 2024 · 86ce051 · 86ce051
1 parent 9b72e1f
commit 86ce051
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/...g-boot/src/main/java/org/springframework/boot/logging/log4j2/SpringEnvironmentLookup.java b/...g-boot/src/main/java/org/springframework/boot/logging/log4j2/SpringEnvironmentLookup.java
@@ -43,7 +43,10 @@ public String lookup(LogEvent event, String key) {
 
 	@Override
 	public String lookup(String key) {
-		Assert.state(this.environment != null, "Unable to obtain Spring Environment from LoggerContext");
+		Assert.state(this.environment != null,
+				"Unable to obtain Spring Environment from LoggerContext. "
+						+ "This can happen if your log4j2 configuration filename does not end with '-spring' "
+						+ "(for example using 'log4j2.xml' instead of 'log4j2-spring.xml')");
 		return this.environment.getProperty(key);
 	}
 

diff --git a/...t/src/test/java/org/springframework/boot/logging/log4j2/SpringEnvironmentLookupTests.java b/...t/src/test/java/org/springframework/boot/logging/log4j2/SpringEnvironmentLookupTests.java
@@ -69,7 +69,9 @@ void lookupWhenNoSpringEnvironmentThrowsException() {
 		this.loggerContext.removeObject(Log4J2LoggingSystem.ENVIRONMENT_KEY);
 		Interpolator lookup = createLookup(this.loggerContext);
 		assertThatIllegalStateException().isThrownBy(() -> lookup.lookup("spring:test"))
-			.withMessage("Unable to obtain Spring Environment from LoggerContext");
+			.withMessage("Unable to obtain Spring Environment from LoggerContext. "
+					+ "This can happen if your log4j2 configuration filename does not end with '-spring' "
+					+ "(for example using 'log4j2.xml' instead of 'log4j2-spring.xml')");
 	}
 
 	private Interpolator createLookup(LoggerContext context) {