Upgrade to Log4j2 2.25.1

snicoll · snicoll · commit 8cf0d17fbccf · 2025-08-21T16:54:01.000+02:00
Closes gh-46334
diff --git a/config/checkstyle/checkstyle-suppressions.xml b/config/checkstyle/checkstyle-suppressions.xml
@@ -75,4 +75,7 @@
 	<suppress files="ConditionMessage\.java" checks="NoWhitespaceBefore" message="'...' is preceded with whitespace"/>
 	<suppress files="EntityManagerFactoryBuilder\.java" checks="NoWhitespaceBefore" message="'...' is preceded with whitespace"/>
 	<suppress files="DockerApi\.java" checks="NoWhitespaceBefore" message="'...' is preceded with whitespace"/>
+	<!-- https://github.com/apache/logging-log4j2/issues/2769#issuecomment-3049020222 -->
+	<suppress files="SpringProfileArbiter\.java" checks="SpringMethodVisibility"/>
+	<suppress files="StructuredLogLayout\.java" checks="SpringMethodVisibility"/>
 </suppressions>
diff --git a/core/spring-boot/build.gradle b/core/spring-boot/build.gradle
@@ -87,6 +87,12 @@ tasks.named("checkFormatMain") {
 	source(fileTree("src/main/javaTemplates"))
 }
 
+tasks.named("compileJava") {
+	// Provide the project coordinates to the `GraalVmProcessor`:
+	options.compilerArgs << '-Alog4j.graalvm.groupId=org.springframework.boot'
+	options.compilerArgs << '-Alog4j.graalvm.artifactId=spring-boot-log4j'
+}
+
 plugins.withType(EclipsePlugin) {
 	eclipse {
 		synchronizationTasks syncJavaTemplates
diff --git a/core/spring-boot/src/main/java/org/springframework/boot/logging/log4j2/ElasticCommonSchemaStructuredLogFormatter.java b/core/spring-boot/src/main/java/org/springframework/boot/logging/log4j2/ElasticCommonSchemaStructuredLogFormatter.java
@@ -19,11 +19,11 @@
 import java.util.Objects;
 import java.util.Set;
 import java.util.TreeSet;
+import java.util.function.Function;
 
 import org.apache.logging.log4j.Level;
 import org.apache.logging.log4j.Marker;
 import org.apache.logging.log4j.core.LogEvent;
-import org.apache.logging.log4j.core.impl.ThrowableProxy;
 import org.apache.logging.log4j.core.time.Instant;
 import org.apache.logging.log4j.util.ReadOnlyStringMap;
 import org.jspecify.annotations.Nullable;
@@ -71,10 +71,10 @@ private static void jsonMembers(Environment environment, @Nullable StackTracePri
 		members.add("message", LogEvent::getMessage).as(StructuredMessage::get);
 		members.from(LogEvent::getContextData)
 			.usingPairs(contextPairs.nested(ElasticCommonSchemaStructuredLogFormatter::addContextDataPairs));
-		members.from(LogEvent::getThrownProxy).whenNotNull().usingMembers((thrownProxyMembers) -> {
+		members.from(LogEvent::getThrown).whenNotNull().usingMembers((thrownProxyMembers) -> {
 			thrownProxyMembers.add("error").usingMembers((error) -> {
-				error.add("type", ThrowableProxy::getThrowable).whenNotNull().as(ObjectUtils::nullSafeClassName);
-				error.add("message", ThrowableProxy::getMessage);
+				error.add("type", Function.identity()).whenNotNull().as(ObjectUtils::nullSafeClassName);
+				error.add("message", Throwable::getMessage);
 				error.add("stack_trace", extractor::stackTrace);
 			});
 		});
diff --git a/core/spring-boot/src/main/java/org/springframework/boot/logging/log4j2/ExtendedWhitespaceThrowablePatternConverter.java b/core/spring-boot/src/main/java/org/springframework/boot/logging/log4j2/ExtendedWhitespaceThrowablePatternConverter.java
@@ -39,7 +39,8 @@ public final class ExtendedWhitespaceThrowablePatternConverter extends Throwable
 
 	private final ExtendedThrowablePatternConverter delegate;
 
-	private ExtendedWhitespaceThrowablePatternConverter(Configuration configuration, String @Nullable [] options) {
+	@SuppressWarnings("deprecation") // https://github.com/apache/logging-log4j2/issues/3809
+	private ExtendedWhitespaceThrowablePatternConverter(Configuration configuration, @Nullable String[] options) {
 		super("WhitespaceExtendedThrowable", "throwable", options, configuration);
 		this.delegate = ExtendedThrowablePatternConverter.newInstance(configuration, options);
 	}
@@ -61,7 +62,7 @@ public void format(LogEvent event, StringBuilder buffer) {
 	 * @return a new {@code WhitespaceThrowablePatternConverter}
 	 */
 	public static ExtendedWhitespaceThrowablePatternConverter newInstance(Configuration configuration,
-			String @Nullable [] options) {
+			@Nullable String[] options) {
 		return new ExtendedWhitespaceThrowablePatternConverter(configuration, options);
 	}
 
diff --git a/core/spring-boot/src/main/java/org/springframework/boot/logging/log4j2/Extractor.java b/core/spring-boot/src/main/java/org/springframework/boot/logging/log4j2/Extractor.java
@@ -16,13 +16,14 @@
 
 package org.springframework.boot.logging.log4j2;
 
+import java.io.PrintWriter;
+import java.io.StringWriter;
+
 import org.apache.logging.log4j.core.LogEvent;
-import org.apache.logging.log4j.core.impl.ThrowableProxy;
 import org.jspecify.annotations.Nullable;
 import org.slf4j.event.LoggingEvent;
 
 import org.springframework.boot.logging.StackTracePrinter;
-import org.springframework.util.Assert;
 
 /**
  * Functions to extract items from {@link LoggingEvent}.
@@ -42,19 +43,23 @@ String messageAndStackTrace(LogEvent event) {
 	}
 
 	@Nullable String stackTrace(LogEvent event) {
-		return stackTrace(event.getThrownProxy());
+		return stackTrace(event.getThrown());
 	}
 
-	@Nullable String stackTrace(@Nullable ThrowableProxy throwableProxy) {
-		if (throwableProxy == null) {
+	@Nullable String stackTrace(@Nullable Throwable throwable) {
+		if (throwable == null) {
 			return null;
 		}
 		if (this.stackTracePrinter != null) {
-			Throwable throwable = throwableProxy.getThrowable();
-			Assert.state(throwable != null, "Proxy must return Throwable in order to print exception");
 			return this.stackTracePrinter.printStackTraceToString(throwable);
 		}
-		return throwableProxy.getExtendedStackTraceAsString();
+		return printStackTrace(throwable);
+	}
+
+	private static String printStackTrace(Throwable throwable) {
+		StringWriter stringWriter = new StringWriter();
+		throwable.printStackTrace(new PrintWriter(stringWriter));
+		return stringWriter.toString();
 	}
 
 }
diff --git a/core/spring-boot/src/main/java/org/springframework/boot/logging/log4j2/GraylogExtendedLogFormatStructuredLogFormatter.java b/core/spring-boot/src/main/java/org/springframework/boot/logging/log4j2/GraylogExtendedLogFormatStructuredLogFormatter.java
@@ -98,8 +98,8 @@ private static void jsonMembers(Environment environment, @Nullable StackTracePri
 			.usingPairs(contextPairs.flat(additionalFieldJoiner(),
 					GraylogExtendedLogFormatStructuredLogFormatter::addContextDataPairs));
 		members.add()
-			.whenNotNull(LogEvent::getThrownProxy)
-			.usingMembers((thrownProxyMembers) -> throwableMembers(thrownProxyMembers, extractor));
+			.whenNotNull(LogEvent::getThrown)
+			.usingMembers((thrownMembers) -> throwableMembers(thrownMembers, extractor));
 	}
 
 	private static String getMessageText(Message message) {
@@ -131,11 +131,9 @@ private static int convertLevel(LogEvent event) {
 
 	private static void throwableMembers(Members<LogEvent> members, Extractor extractor) {
 		members.add("full_message", extractor::messageAndStackTrace);
-		members.add("_error_type", (event) -> event.getThrownProxy().getThrowable())
-			.whenNotNull()
-			.as(ObjectUtils::nullSafeClassName);
+		members.add("_error_type", LogEvent::getThrown).whenNotNull().as(ObjectUtils::nullSafeClassName);
 		members.add("_error_stack_trace", extractor::stackTrace);
-		members.add("_error_message", (event) -> event.getThrownProxy().getMessage());
+		members.add("_error_message", (event) -> event.getThrown().getMessage());
 	}
 
 	private static void addContextDataPairs(ContextPairs.Pairs<ReadOnlyStringMap> contextPairs) {
diff --git a/core/spring-boot/src/main/java/org/springframework/boot/logging/log4j2/LogstashStructuredLogFormatter.java b/core/spring-boot/src/main/java/org/springframework/boot/logging/log4j2/LogstashStructuredLogFormatter.java
@@ -68,7 +68,7 @@ private static void jsonMembers(@Nullable StackTracePrinter stackTracePrinter, C
 			.whenNotNull()
 			.as(LogstashStructuredLogFormatter::getMarkers)
 			.whenNot(CollectionUtils::isEmpty);
-		members.add("stack_trace", LogEvent::getThrownProxy).whenNotNull().as(extractor::stackTrace);
+		members.add("stack_trace", LogEvent::getThrown).whenNotNull().as(extractor::stackTrace);
 	}
 
 	private static String asTimestamp(Instant instant) {
diff --git a/core/spring-boot/src/main/java/org/springframework/boot/logging/log4j2/SpringProfileArbiter.java b/core/spring-boot/src/main/java/org/springframework/boot/logging/log4j2/SpringProfileArbiter.java
@@ -90,7 +90,7 @@ private Builder() {
 		 * @return this
 		 * @see Profiles#of(String...)
 		 */
-		Builder setName(String name) {
+		public Builder setName(String name) {
 			this.name = name;
 			return this;
 		}
diff --git a/core/spring-boot/src/main/java/org/springframework/boot/logging/log4j2/StructuredLogLayout.java b/core/spring-boot/src/main/java/org/springframework/boot/logging/log4j2/StructuredLogLayout.java
@@ -87,12 +87,12 @@ static final class Builder implements org.apache.logging.log4j.core.util.Builder
 		@SuppressWarnings("NullAway.Init")
 		private String charset = StandardCharsets.UTF_8.name();
 
-		Builder setFormat(String format) {
+		public Builder setFormat(String format) {
 			this.format = format;
 			return this;
 		}
 
-		Builder setCharset(String charset) {
+		public Builder setCharset(String charset) {
 			this.charset = charset;
 			return this;
 		}
diff --git a/core/spring-boot/src/main/java/org/springframework/boot/logging/log4j2/WhitespaceThrowablePatternConverter.java b/core/spring-boot/src/main/java/org/springframework/boot/logging/log4j2/WhitespaceThrowablePatternConverter.java
@@ -35,7 +35,8 @@
 @ConverterKeys({ "wEx", "wThrowable", "wException" })
 public final class WhitespaceThrowablePatternConverter extends ThrowablePatternConverter {
 
-	private WhitespaceThrowablePatternConverter(Configuration configuration, String @Nullable [] options) {
+	@SuppressWarnings("deprecation") // https://github.com/apache/logging-log4j2/issues/3809
+	private WhitespaceThrowablePatternConverter(Configuration configuration, @Nullable String[] options) {
 		super("WhitespaceThrowable", "throwable", options, configuration);
 	}
 
@@ -56,7 +57,7 @@ public void format(LogEvent event, StringBuilder buffer) {
 	 * @return a new {@code WhitespaceThrowablePatternConverter}
 	 */
 	public static WhitespaceThrowablePatternConverter newInstance(Configuration configuration,
-			String @Nullable [] options) {
+			@Nullable String[] options) {
 		return new WhitespaceThrowablePatternConverter(configuration, options);
 	}
 
diff --git a/core/spring-boot/src/test/java/org/springframework/boot/logging/logback/ExtractorTests.java b/core/spring-boot/src/test/java/org/springframework/boot/logging/logback/ExtractorTests.java
@@ -46,7 +46,7 @@ void messageAndStackTraceWhenNoPrinterPrintsUsingPrinter() {
 	}
 
 	@Test
-	void stackTraceWhenNoPrinterPrintsUsingLoggingSystem() {
+	void stackTraceWhenNoPrinterPrintsUsingFallback() {
 		Extractor extractor = new Extractor(null, createConverter());
 		assertThat(extractor.stackTrace(createEvent())).contains("java.lang.RuntimeException: Boom!");
 	}
diff --git a/platform/spring-boot-dependencies/build.gradle b/platform/spring-boot-dependencies/build.gradle
@@ -1252,23 +1252,14 @@ bom {
 			releaseNotes("https://github.com/liquibase/liquibase/releases/tag/v{version}")
 		}
 	}
-	library("Log4j2", "2.24.3") {
+	library("Log4j2", "2.25.1") {
 		prohibit {
 			contains "-alpha"
 			contains "-beta"
 			because "we don't want alphas or betas"
 		}
 		group("org.apache.logging.log4j") {
-			bom("log4j-bom") {
-				permit("biz.aQute.bnd:biz.aQute.bnd.annotation")
-				permit("com.github.spotbugs:spotbugs-annotations")
-				permit("org.apache.logging:logging-parent")
-				permit("org.apache.maven.plugin-tools:maven-plugin-annotations")
-				permit("org.jspecify:jspecify")
-				permit("org.osgi:org.osgi.annotation.bundle")
-				permit("org.osgi:org.osgi.annotation.versioning")
-				permit("org.osgi:osgi.annotation")
-			}
+			bom("log4j-bom")
 		}
 		links {
 			site("https://logging.apache.org/log4j")
diff --git a/smoke-test/spring-boot-smoke-test-structured-logging-log4j2/src/main/java/smoketest/structuredlogging/log4j2/CustomStructuredLogFormatter.java b/smoke-test/spring-boot-smoke-test-structured-logging-log4j2/src/main/java/smoketest/structuredlogging/log4j2/CustomStructuredLogFormatter.java
@@ -16,8 +16,10 @@
 
 package smoketest.structuredlogging.log4j2;
 
+import java.io.PrintWriter;
+import java.io.StringWriter;
+
 import org.apache.logging.log4j.core.LogEvent;
-import org.apache.logging.log4j.core.impl.ThrowableProxy;
 import org.jspecify.annotations.Nullable;
 
 import org.springframework.boot.logging.structured.StructuredLogFormatter;
@@ -39,9 +41,11 @@ public String format(LogEvent event) {
 			result.append(" pid=").append(this.pid);
 		}
 		result.append(" msg=\"").append(event.getMessage().getFormattedMessage()).append('"');
-		ThrowableProxy throwable = event.getThrownProxy();
+		Throwable throwable = event.getThrown();
 		if (throwable != null) {
-			result.append(" error=\"").append(throwable.getExtendedStackTraceAsString()).append('"');
+			StringWriter stackTrace = new StringWriter();
+			throwable.printStackTrace(new PrintWriter(stackTrace));
+			result.append(" error=\"").append(stackTrace).append('"');
 		}
 		result.append('\n');
 		return result.toString();

Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ private static void jsonMembers(@Nullable StackTracePrinter stackTracePrinter, C`
`68`	`68`	`.whenNotNull()`
`69`	`69`	`.as(LogstashStructuredLogFormatter::getMarkers)`
`70`	`70`	`.whenNot(CollectionUtils::isEmpty);`
`71`		`- members.add("stack_trace", LogEvent::getThrownProxy).whenNotNull().as(extractor::stackTrace);`
	`71`	`+ members.add("stack_trace", LogEvent::getThrown).whenNotNull().as(extractor::stackTrace);`
`72`	`72`	`}`
`73`	`73`
`74`	`74`	`private static String asTimestamp(Instant instant) {`
Original file line number	Diff line number	Diff line change
`@@ -90,7 +90,7 @@ private Builder() {`
`90`	`90`	`* @return this`
`91`	`91`	`* @see Profiles#of(String...)`
`92`	`92`	`*/`
`93`		`- Builder setName(String name) {`
	`93`	`+ public Builder setName(String name) {`
`94`	`94`	`this.name = name;`
`95`	`95`	`return this;`
`96`	`96`	`}`
Original file line number	Diff line number	Diff line change
`@@ -87,12 +87,12 @@ static final class Builder implements org.apache.logging.log4j.core.util.Builder`
`87`	`87`	`@SuppressWarnings("NullAway.Init")`
`88`	`88`	`private String charset = StandardCharsets.UTF_8.name();`
`89`	`89`
`90`		`- Builder setFormat(String format) {`
	`90`	`+ public Builder setFormat(String format) {`
`91`	`91`	`this.format = format;`
`92`	`92`	`return this;`
`93`	`93`	`}`
`94`	`94`
`95`		`- Builder setCharset(String charset) {`
	`95`	`+ public Builder setCharset(String charset) {`
`96`	`96`	`this.charset = charset;`
`97`	`97`	`return this;`
`98`	`98`	`}`