Skip to content

Add clean-history-on-start and total-size-cap rolling policy properties for Log4J2 #51153

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
elephant-y wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add clean-history-on-start and total-size-cap rolling policy properties for Log4J2 #51153

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
688f494
Add clean-history-on-start and total-size-cap rolling policy properti…
elephant-y Jul 29, 2026
e230c24
Add tests for new rolling policy properties in Log4J2LoggingSystemTests
elephant-y Jul 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .../src/main/java/org/springframework/boot/logging/log4j2/Log4j2LoggingSystemProperties.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,9 @@ protected void apply(@Nullable LogFile logFile, PropertyResolver resolver) {

private void applyRollingPolicyProperties(PropertyResolver resolver) {
applyRollingPolicy(RollingPolicySystemProperty.FILE_NAME_PATTERN, resolver);
applyRollingPolicy(RollingPolicySystemProperty.CLEAN_HISTORY_ON_START, resolver);
applyRollingPolicy(RollingPolicySystemProperty.MAX_FILE_SIZE, resolver, DataSize.class);
applyRollingPolicy(RollingPolicySystemProperty.TOTAL_SIZE_CAP, resolver, DataSize.class);
applyRollingPolicy(RollingPolicySystemProperty.MAX_HISTORY, resolver);
applyRollingPolicy(RollingPolicySystemProperty.STRATEGY, resolver);
applyRollingPolicy(RollingPolicySystemProperty.TIME_INTERVAL, resolver, Integer.class);
Expand Down
12 changes: 11 additions & 1 deletion ...ot/src/main/java/org/springframework/boot/logging/log4j2/RollingPolicySystemProperty.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,17 @@ public enum RollingPolicySystemProperty {
/**
* Logging system property for the cron based schedule.
*/
CRON("cron");
CRON("cron"),

/**
* Logging system property for the clean history on start flag.
*/
CLEAN_HISTORY_ON_START("clean-history-on-start"),

/**
* Logging system property for the file total size cap.
*/
TOTAL_SIZE_CAP("total-size-cap");

private final String environmentVariableName;

Expand Down
7 changes: 7 additions & 0 deletions ...-boot/src/test/java/org/springframework/boot/logging/log4j2/Log4J2LoggingSystemTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -817,6 +817,8 @@ void rollingPolicySystemPropertiesAreApplied() {
this.environment.setProperty("logging.log4j2.rollingpolicy.max-history", "30");
this.environment.setProperty("logging.log4j2.rollingpolicy.file-name-pattern",
"${LOG_FILE}.%d{yyyy-MM-dd}.%i.log");
this.environment.setProperty("logging.log4j2.rollingpolicy.clean-history-on-start", "true");
this.environment.setProperty("logging.log4j2.rollingpolicy.total-size-cap", "1GB");
File file = new File(tmpDir(), "log4j2-test.log");
LogFile logFile = getLogFile(file.getPath(), null);
this.loggingSystem.getSystemProperties(this.environment).apply(logFile);
Expand All @@ -825,9 +827,14 @@ void rollingPolicySystemPropertiesAreApplied() {
String maxFileSize = System.getProperty("LOG4J2_ROLLINGPOLICY_MAX_FILE_SIZE");
String maxHistory = System.getProperty("LOG4J2_ROLLINGPOLICY_MAX_HISTORY");
String fileNamePattern = System.getProperty("LOG4J2_ROLLINGPOLICY_FILE_NAME_PATTERN");
String cleanHistoryOnStart = System.getProperty("LOG4J2_ROLLINGPOLICY_CLEAN_HISTORY_ON_START");
String totalSizeCap = System.getProperty("LOG4J2_ROLLINGPOLICY_TOTAL_SIZE_CAP");
assertThat(maxFileSize).isEqualTo(String.valueOf(50 * 1024 * 1024));
assertThat(maxHistory).isEqualTo("30");
assertThat(fileNamePattern).isEqualTo("${LOG_FILE}.%d{yyyy-MM-dd}.%i.log");
assertThat(cleanHistoryOnStart).isEqualTo("true");
assertThat(totalSizeCap).isEqualTo(String.valueOf(DataSize.ofGigabytes(1).toBytes()));

}

@Test
Expand Down
6 changes: 5 additions & 1 deletion ...test/java/org/springframework/boot/logging/log4j2/Log4j2LoggingSystemPropertiesTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@ void appliesLog4j2RollingPolicyProperties() {
this.environment.setProperty("logging.log4j2.rollingpolicy.time-interval", "2");
this.environment.setProperty("logging.log4j2.rollingpolicy.time-modulate", "true");
this.environment.setProperty("logging.log4j2.rollingpolicy.cron", "0 0 1 * * ?");
this.environment.setProperty("logging.log4j2.rollingpolicy.clean-history-on-start", "true");
this.environment.setProperty("logging.log4j2.rollingpolicy.total-size-cap", "1GB");

new Log4j2LoggingSystemProperties(this.environment).apply(null);

Expand All @@ -78,7 +80,9 @@ void appliesLog4j2RollingPolicyProperties() {
.containsEntry("LOG4J2_ROLLINGPOLICY_STRATEGY", "time")
.containsEntry("LOG4J2_ROLLINGPOLICY_TIME_INTERVAL", "2")
.containsEntry("LOG4J2_ROLLINGPOLICY_TIME_MODULATE", "true")
.containsEntry("LOG4J2_ROLLINGPOLICY_CRON", "0 0 1 * * ?");
.containsEntry("LOG4J2_ROLLINGPOLICY_CRON", "0 0 1 * * ?")
.containsEntry("LOG4J2_ROLLINGPOLICY_CLEAN_HISTORY_ON_START", "true")
.containsEntry("LOG4J2_ROLLINGPOLICY_TOTAL_SIZE_CAP", String.valueOf(DataSize.ofGigabytes(1).toBytes()));
}

@Test
Expand Down