root
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Actions 12 Packages Projects Releases Wiki Activity

Polish "Expose Tomcat AccessLog Max days property" 

Closes gh-15954
This commit is contained in:
Stephane Nicoll 2019-02-14 15:54:51 +01:00
parent 596f0c28c0
commit 71df2f311b
4 changed files with 28 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ServerProperties.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2012-2018 the original author or authors.
* Copyright 2012-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -593,6 +593,11 @@ public class ServerProperties {
*/
private boolean renameOnRotate = false;
/**
* Number of days to retain the access log files before they are removed.
*/
private int maxDays = -1;
/**
* Date format to place in the log file name.
*/
@ -609,19 +614,6 @@ public class ServerProperties {
*/
private boolean buffered = true;
/**
* The number of days to retain the access log files before they are removed.
*/
private int maxDays = -1;
public int getMaxDays() {
return this.maxDays;
}
public void setMaxDays(int maxDays) {
this.maxDays = maxDays;
}
public boolean isEnabled() {
return this.enabled;
}
@ -678,6 +670,14 @@ public class ServerProperties {
this.renameOnRotate = renameOnRotate;
}
public int getMaxDays() {
return this.maxDays;
}
public void setMaxDays(int maxDays) {
this.maxDays = maxDays;
}
public String getFileDateFormat() {
return this.fileDateFormat;
}

4
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/embedded/TomcatWebServerFactoryCustomizer.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2012-2018 the original author or authors.
* Copyright 2012-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -258,12 +258,12 @@ public class TomcatWebServerFactoryCustomizer implements
valve.setPrefix(tomcatProperties.getAccesslog().getPrefix());
valve.setSuffix(tomcatProperties.getAccesslog().getSuffix());
valve.setRenameOnRotate(tomcatProperties.getAccesslog().isRenameOnRotate());
valve.setMaxDays(tomcatProperties.getAccesslog().getMaxDays());
valve.setFileDateFormat(tomcatProperties.getAccesslog().getFileDateFormat());
valve.setRequestAttributesEnabled(
tomcatProperties.getAccesslog().isRequestAttributesEnabled());
valve.setRotatable(tomcatProperties.getAccesslog().isRotate());
valve.setBuffered(tomcatProperties.getAccesslog().isBuffered());
valve.setMaxDays(tomcatProperties.getAccesslog().getMaxDays());
factory.addEngineValves(valve);
}

21
spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/web/embedded/TomcatWebServerFactoryCustomizerTests.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2012-2018 the original author or authors.
* Copyright 2012-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -326,7 +326,16 @@ public class TomcatWebServerFactoryCustomizerTests {
}
@Test
public void accessLogSetMaxDays() {
public void accessLogMaxDaysDefault() {
bind("server.tomcat.accesslog.enabled=true");
TomcatServletWebServerFactory factory = customizeAndGetFactory();
assertThat(((AccessLogValve) factory.getEngineValves().iterator().next())
.getMaxDays()).isEqualTo(
this.serverProperties.getTomcat().getAccesslog().getMaxDays());
}
@Test
public void accessLoMaxDaysCanBeRedefined() {
bind("server.tomcat.accesslog.enabled=true",
"server.tomcat.accesslog.max-days=20");
TomcatServletWebServerFactory factory = customizeAndGetFactory();
@ -334,14 +343,6 @@ public class TomcatWebServerFactoryCustomizerTests {
.getMaxDays()).isEqualTo(20);
}
@Test
public void accessLogDefaultMaxDays() {
bind("server.tomcat.accesslog.enabled=true");
TomcatServletWebServerFactory factory = customizeAndGetFactory();
assertThat(((AccessLogValve) factory.getEngineValves().iterator().next())
.getMaxDays()).isEqualTo(-1);
}
private void bind(String... inlinedProperties) {
TestPropertySourceUtils.addInlinedPropertiesToEnvironment(this.environment,
inlinedProperties);

2
spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/application-properties.adoc
View File

@ -255,7 +255,7 @@ content into your application. Rather, pick only the properties that you need.
server.tomcat.accesslog.directory=logs # Directory in which log files are created. Can be absolute or relative to the Tomcat base dir.
server.tomcat.accesslog.enabled=false # Enable access log.
server.tomcat.accesslog.file-date-format=.yyyy-MM-dd # Date format to place in the log file name.
server.tomcat.accesslog.max-days=-1#The number of days to retain the access log files before they are removed.
server.tomcat.accesslog.max-days=-1# Number of days to retain the access log files before they are removed.
server.tomcat.accesslog.pattern=common # Format pattern for access logs.
server.tomcat.accesslog.prefix=access_log # Log file name prefix.
server.tomcat.accesslog.rename-on-rotate=false # Whether to defer inclusion of the date stamp in the file name until rotate time.