Remove support for deprecated logback properties

This commit removes support for the following properties that are
deprecated since Spring Boot 2.4:

- logging.pattern.rolling-file-name
- logging.file.clean-history-on-start
- logging.file.max-size
- logging.file.total-size-cap
- logging.file.max-history

Closes gh-48489

Author: snicoll

core/spring-boot/src/main/java/org/springframework/boot/logging/logback/LogbackLoggingSystemProperties.java

@@ -106,7 +106,6 @@ private void applyRollingPolicy(RollingPolicySystemProperty property, PropertyRe
 	private <T> void applyRollingPolicy(RollingPolicySystemProperty property, PropertyResolver resolver,
 			Class<T> type) {
 		T value = getProperty(resolver, property.getApplicationPropertyName(), type);
-		value = (value != null) ? value : getProperty(resolver, property.getDeprecatedApplicationPropertyName(), type);
 		if (value != null) {
 			String stringValue = String.valueOf((value instanceof DataSize dataSize) ? dataSize.toBytes() : value);
 			setSystemProperty(property.getEnvironmentVariableName(), stringValue);

core/spring-boot/src/main/java/org/springframework/boot/logging/logback/RollingPolicySystemProperty.java

@@ -29,38 +29,35 @@ public enum RollingPolicySystemProperty {
 	/**
 	 * Logging system property for the rolled-over log file name pattern.
 	 */
-	FILE_NAME_PATTERN("file-name-pattern", "logging.pattern.rolling-file-name"),
+	FILE_NAME_PATTERN("file-name-pattern"),
 
 	/**
 	 * Logging system property for the clean history on start flag.
 	 */
-	CLEAN_HISTORY_ON_START("clean-history-on-start", "logging.file.clean-history-on-start"),
+	CLEAN_HISTORY_ON_START("clean-history-on-start"),
 
 	/**
 	 * Logging system property for the file log max size.
 	 */
-	MAX_FILE_SIZE("max-file-size", "logging.file.max-size"),
+	MAX_FILE_SIZE("max-file-size"),
 
 	/**
 	 * Logging system property for the file total size cap.
 	 */
-	TOTAL_SIZE_CAP("total-size-cap", "logging.file.total-size-cap"),
+	TOTAL_SIZE_CAP("total-size-cap"),
 
 	/**
 	 * Logging system property for the file log max history.
 	 */
-	MAX_HISTORY("max-history", "logging.file.max-history");
+	MAX_HISTORY("max-history");
 
 	private final String environmentVariableName;
 
 	private final String applicationPropertyName;
 
-	private final String deprecatedApplicationPropertyName;
-
-	RollingPolicySystemProperty(String applicationPropertyName, String deprecatedApplicationPropertyName) {
+	RollingPolicySystemProperty(String applicationPropertyName) {
 		this.environmentVariableName = "LOGBACK_ROLLINGPOLICY_" + name();
 		this.applicationPropertyName = "logging.logback.rollingpolicy." + applicationPropertyName;
-		this.deprecatedApplicationPropertyName = deprecatedApplicationPropertyName;
 	}
 
 	/**
@@ -75,8 +72,4 @@ String getApplicationPropertyName() {
 		return this.applicationPropertyName;
 	}
 
-	String getDeprecatedApplicationPropertyName() {
-		return this.deprecatedApplicationPropertyName;
-	}
-
 }

core/spring-boot/src/main/resources/META-INF/additional-spring-configuration-metadata.json

@@ -55,32 +55,26 @@
     {
       "name": "logging.file.clean-history-on-start",
       "type": "java.lang.Boolean",
-      "description": "Whether to clean the archive log files on startup. Only supported with the default logback setup.",
-      "sourceType": "org.springframework.boot.context.logging.LoggingApplicationListener",
-      "defaultValue": false,
       "deprecation": {
+        "level": "error",
         "replacement": "logging.logback.rollingpolicy.clean-history-on-start",
         "since": "2.4.0"
       }
     },
     {
       "name": "logging.file.max-history",
       "type": "java.lang.Integer",
-      "description": "Maximum number of archive log files to keep. Only supported with the default logback setup.",
-      "sourceType": "org.springframework.boot.context.logging.LoggingApplicationListener",
-      "defaultValue": 7,
       "deprecation": {
+        "level": "error",
         "replacement": "logging.logback.rollingpolicy.max-history",
         "since": "2.4.0"
       }
     },
     {
       "name": "logging.file.max-size",
       "type": "org.springframework.util.unit.DataSize",
-      "description": "Maximum log file size. Only supported with the default logback setup.",
-      "sourceType": "org.springframework.boot.context.logging.LoggingApplicationListener",
-      "defaultValue": "10MB",
       "deprecation": {
+        "level": "error",
         "replacement": "logging.logback.rollingpolicy.max-file-size",
         "since": "2.4.0"
       }
@@ -100,10 +94,8 @@
     {
       "name": "logging.file.total-size-cap",
       "type": "org.springframework.util.unit.DataSize",
-      "description": "Total size of log backups to be kept. Only supported with the default logback setup.",
-      "sourceType": "org.springframework.boot.context.logging.LoggingApplicationListener",
-      "defaultValue": "0B",
       "deprecation": {
+        "level": "error",
         "replacement": "logging.logback.rollingpolicy.total-size-cap",
         "since": "2.4.0"
       }
@@ -219,10 +211,8 @@
     {
       "name": "logging.pattern.rolling-file-name",
       "type": "java.lang.String",
-      "description": "Pattern for rolled-over log file names. Supported only with the default Logback setup.",
-      "sourceType": "org.springframework.boot.context.logging.LoggingApplicationListener",
-      "defaultValue": "${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz",
       "deprecation": {
+        "level": "error",
         "replacement": "logging.logback.rollingpolicy.file-name-pattern",
         "since": "2.4.0"
       }

core/spring-boot/src/test/java/org/springframework/boot/logging/logback/LogbackLoggingSystemPropertiesTests.java

@@ -89,22 +89,6 @@ void applySetsLogbackSystemProperties() {
 			.containsEntry(RollingPolicySystemProperty.MAX_HISTORY.getEnvironmentVariableName(), "mh");
 	}
 
-	@Test
-	void applySetsLogbackSystemPropertiesFromDeprecated() {
-		this.environment.setProperty("logging.pattern.rolling-file-name", "fnp");
-		this.environment.setProperty("logging.file.clean-history-on-start", "chos");
-		this.environment.setProperty("logging.file.max-size", "1KB");
-		this.environment.setProperty("logging.file.total-size-cap", "2KB");
-		this.environment.setProperty("logging.file.max-history", "mh");
-		new LogbackLoggingSystemProperties(this.environment).apply();
-		assertThat(System.getProperties())
-			.containsEntry(RollingPolicySystemProperty.FILE_NAME_PATTERN.getEnvironmentVariableName(), "fnp")
-			.containsEntry(RollingPolicySystemProperty.CLEAN_HISTORY_ON_START.getEnvironmentVariableName(), "chos")
-			.containsEntry(RollingPolicySystemProperty.MAX_FILE_SIZE.getEnvironmentVariableName(), "1024")
-			.containsEntry(RollingPolicySystemProperty.TOTAL_SIZE_CAP.getEnvironmentVariableName(), "2048")
-			.containsEntry(RollingPolicySystemProperty.MAX_HISTORY.getEnvironmentVariableName(), "mh");
-	}
-
 	@Test
 	void consoleCharsetWhenNoPropertyUsesDefault() {
 		LogbackLoggingSystemProperties logbackLoggingSystemProperties = spy(

core/spring-boot/src/test/java/org/springframework/boot/logging/logback/LogbackLoggingSystemTests.java

@@ -398,7 +398,7 @@ void testFilePatternProperty(CapturedOutput output) {
 
 	@Test
 	void testCleanHistoryOnStartProperty() {
-		this.environment.setProperty("logging.file.clean-history-on-start", "true");
+		this.environment.setProperty("logging.logback.rollingpolicy.clean-history-on-start", "true");
 		LoggingInitializationContext loggingInitializationContext = new LoggingInitializationContext(this.environment);
 		File file = new File(tmpDir(), "logback-test.log");
 		LogFile logFile = getLogFile(file.getPath(), null);
@@ -411,7 +411,7 @@ void testCleanHistoryOnStartProperty() {
 	@Test
 	@WithIncludeBaseXmlResource
 	void testCleanHistoryOnStartPropertyWithXmlConfiguration() {
-		this.environment.setProperty("logging.file.clean-history-on-start", "true");
+		this.environment.setProperty("logging.logback.rollingpolicy.clean-history-on-start", "true");
 		LoggingInitializationContext loggingInitializationContext = new LoggingInitializationContext(this.environment);
 		File file = new File(tmpDir(), "logback-test.log");
 		LogFile logFile = getLogFile(file.getPath(), null);
@@ -437,7 +437,7 @@ void testMaxFileSizePropertyWithBytesValue() {
 	}
 
 	private void testMaxFileSizeProperty(String sizeValue, String expectedFileSize) {
-		this.environment.setProperty("logging.file.max-size", sizeValue);
+		this.environment.setProperty("logging.logback.rollingpolicy.max-file-size", sizeValue);
 		LoggingInitializationContext loggingInitializationContext = new LoggingInitializationContext(this.environment);
 		File file = new File(tmpDir(), "logback-test.log");
 		LogFile logFile = getLogFile(file.getPath(), null);
@@ -450,7 +450,7 @@ private void testMaxFileSizeProperty(String sizeValue, String expectedFileSize)
 	@Test
 	@WithIncludeBaseXmlResource
 	void testMaxFileSizePropertyWithXmlConfiguration() {
-		this.environment.setProperty("logging.file.max-size", "100MB");
+		this.environment.setProperty("logging.logback.rollingpolicy.max-file-size", "100MB");
 		LoggingInitializationContext loggingInitializationContext = new LoggingInitializationContext(this.environment);
 		File file = new File(tmpDir(), "logback-test.log");
 		LogFile logFile = getLogFile(file.getPath(), null);
@@ -462,7 +462,7 @@ void testMaxFileSizePropertyWithXmlConfiguration() {
 
 	@Test
 	void testMaxHistoryProperty() {
-		this.environment.setProperty("logging.file.max-history", "30");
+		this.environment.setProperty("logging.logback.rollingpolicy.max-history", "30");
 		LoggingInitializationContext loggingInitializationContext = new LoggingInitializationContext(this.environment);
 		File file = new File(tmpDir(), "logback-test.log");
 		LogFile logFile = getLogFile(file.getPath(), null);
@@ -475,7 +475,7 @@ void testMaxHistoryProperty() {
 	@Test
 	@WithIncludeBaseXmlResource
 	void testMaxHistoryPropertyWithXmlConfiguration() {
-		this.environment.setProperty("logging.file.max-history", "30");
+		this.environment.setProperty("logging.logback.rollingpolicy.max-history", "30");
 		LoggingInitializationContext loggingInitializationContext = new LoggingInitializationContext(this.environment);
 		File file = new File(tmpDir(), "logback-test.log");
 		LogFile logFile = getLogFile(file.getPath(), null);
@@ -501,7 +501,7 @@ void testTotalSizeCapPropertyWithBytesValue() {
 	}
 
 	private void testTotalSizeCapProperty(String sizeValue, String expectedFileSize) {
-		this.environment.setProperty("logging.file.total-size-cap", sizeValue);
+		this.environment.setProperty("logging.logback.rollingpolicy.total-size-cap", sizeValue);
 		LoggingInitializationContext loggingInitializationContext = new LoggingInitializationContext(this.environment);
 		File file = new File(tmpDir(), "logback-test.log");
 		LogFile logFile = getLogFile(file.getPath(), null);
@@ -515,7 +515,7 @@ private void testTotalSizeCapProperty(String sizeValue, String expectedFileSize)
 	@WithIncludeBaseXmlResource
 	void testTotalSizeCapPropertyWithXmlConfiguration() {
 		String expectedSize = "101 MB";
-		this.environment.setProperty("logging.file.total-size-cap", expectedSize);
+		this.environment.setProperty("logging.logback.rollingpolicy.total-size-cap", expectedSize);
 		LoggingInitializationContext loggingInitializationContext = new LoggingInitializationContext(this.environment);
 		File file = new File(tmpDir(), "logback-test.log");
 		LogFile logFile = getLogFile(file.getPath(), null);
@@ -773,9 +773,9 @@ void logbackSystemStatusListenerShouldBeRegisteredWhenUsingCustomLogbackXml(Capt
 	}
 
 	@Test
-	void testRollingFileNameProperty() {
+	void testRollingFileNamePatternProperty() {
 		String rollingFile = "my.log.%d{yyyyMMdd}.%i.gz";
-		this.environment.setProperty("logging.pattern.rolling-file-name", rollingFile);
+		this.environment.setProperty("logging.logback.rollingpolicy.file-name-pattern", rollingFile);
 		LoggingInitializationContext loggingInitializationContext = new LoggingInitializationContext(this.environment);
 		File file = new File(tmpDir(), "my.log");
 		LogFile logFile = getLogFile(file.getPath(), null);