Skip to content

Commit 269c761

Browse files
committed
Merge pull request #43434 from mpalourdio
* pr/43434: Polish "Add property to specify the management access log prefix" Add property to specify the management access log prefix Closes gh-43434
2 parents 0cd843c + bcf075b commit 269c761

File tree

3 files changed

+57
-10
lines changed

3 files changed

+57
-10
lines changed

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/web/server/ManagementServerProperties.java

+23
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,8 @@ public class ManagementServerProperties {
5757
@NestedConfigurationProperty
5858
private Ssl ssl;
5959

60+
private final Accesslog accesslog = new Accesslog();
61+
6062
/**
6163
* Returns the management port or {@code null} if the
6264
* {@link ServerProperties#getPort() server port} should be used.
@@ -117,4 +119,25 @@ private String cleanBasePath(String basePath) {
117119
return candidate;
118120
}
119121

122+
public Accesslog getAccesslog() {
123+
return this.accesslog;
124+
}
125+
126+
public static class Accesslog {
127+
128+
/**
129+
* Management log file name prefix.
130+
*/
131+
private String prefix = "management_";
132+
133+
public String getPrefix() {
134+
return this.prefix;
135+
}
136+
137+
public void setPrefix(String prefix) {
138+
this.prefix = prefix;
139+
}
140+
141+
}
142+
120143
}

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/web/servlet/ServletManagementChildContextConfiguration.java

+28-10
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2023 the original author or authors.
2+
* Copyright 2012-2025 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -47,6 +47,7 @@
4747
import org.springframework.boot.autoconfigure.web.servlet.ServletWebServerFactoryCustomizer;
4848
import org.springframework.boot.autoconfigure.web.servlet.TomcatServletWebServerFactoryCustomizer;
4949
import org.springframework.boot.autoconfigure.web.servlet.UndertowServletWebServerFactoryCustomizer;
50+
import org.springframework.boot.context.properties.EnableConfigurationProperties;
5051
import org.springframework.boot.web.embedded.jetty.JettyServletWebServerFactory;
5152
import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory;
5253
import org.springframework.boot.web.embedded.undertow.UndertowServletWebServerFactory;
@@ -73,6 +74,7 @@
7374
*/
7475
@ManagementContextConfiguration(value = ManagementContextType.CHILD, proxyBeanMethods = false)
7576
@ConditionalOnWebApplication(type = Type.SERVLET)
77+
@EnableConfigurationProperties(ManagementServerProperties.class)
7678
class ServletManagementChildContextConfiguration {
7779

7880
@Bean
@@ -83,20 +85,20 @@ ServletManagementWebServerFactoryCustomizer servletManagementWebServerFactoryCus
8385

8486
@Bean
8587
@ConditionalOnClass(name = "io.undertow.Undertow")
86-
UndertowAccessLogCustomizer undertowManagementAccessLogCustomizer() {
87-
return new UndertowAccessLogCustomizer();
88+
UndertowAccessLogCustomizer undertowManagementAccessLogCustomizer(ManagementServerProperties properties) {
89+
return new UndertowAccessLogCustomizer(properties);
8890
}
8991

9092
@Bean
9193
@ConditionalOnClass(name = "org.apache.catalina.valves.AccessLogValve")
92-
TomcatAccessLogCustomizer tomcatManagementAccessLogCustomizer() {
93-
return new TomcatAccessLogCustomizer();
94+
TomcatAccessLogCustomizer tomcatManagementAccessLogCustomizer(ManagementServerProperties properties) {
95+
return new TomcatAccessLogCustomizer(properties);
9496
}
9597

9698
@Bean
9799
@ConditionalOnClass(name = "org.eclipse.jetty.server.Server")
98-
JettyAccessLogCustomizer jettyManagementAccessLogCustomizer() {
99-
return new JettyAccessLogCustomizer();
100+
JettyAccessLogCustomizer jettyManagementAccessLogCustomizer(ManagementServerProperties properties) {
101+
return new JettyAccessLogCustomizer(properties);
100102
}
101103

102104
@Configuration(proxyBeanMethods = false)
@@ -145,14 +147,18 @@ private String getContextPath(ManagementServerProperties managementServerPropert
145147

146148
abstract static class AccessLogCustomizer implements Ordered {
147149

148-
private static final String MANAGEMENT_PREFIX = "management_";
150+
private final ManagementServerProperties properties;
151+
152+
AccessLogCustomizer(ManagementServerProperties properties) {
153+
this.properties = properties;
154+
}
149155

150156
protected String customizePrefix(String prefix) {
151157
prefix = (prefix != null) ? prefix : "";
152-
if (prefix.startsWith(MANAGEMENT_PREFIX)) {
158+
if (prefix.startsWith(this.properties.getAccesslog().getPrefix())) {
153159
return prefix;
154160
}
155-
return MANAGEMENT_PREFIX + prefix;
161+
return this.properties.getAccesslog().getPrefix() + prefix;
156162
}
157163

158164
@Override
@@ -165,6 +171,10 @@ public int getOrder() {
165171
static class TomcatAccessLogCustomizer extends AccessLogCustomizer
166172
implements WebServerFactoryCustomizer<TomcatServletWebServerFactory> {
167173

174+
TomcatAccessLogCustomizer(ManagementServerProperties properties) {
175+
super(properties);
176+
}
177+
168178
@Override
169179
public void customize(TomcatServletWebServerFactory factory) {
170180
AccessLogValve accessLogValve = findAccessLogValve(factory);
@@ -188,6 +198,10 @@ private AccessLogValve findAccessLogValve(TomcatServletWebServerFactory factory)
188198
static class UndertowAccessLogCustomizer extends AccessLogCustomizer
189199
implements WebServerFactoryCustomizer<UndertowServletWebServerFactory> {
190200

201+
UndertowAccessLogCustomizer(ManagementServerProperties properties) {
202+
super(properties);
203+
}
204+
191205
@Override
192206
public void customize(UndertowServletWebServerFactory factory) {
193207
factory.setAccessLogPrefix(customizePrefix(factory.getAccessLogPrefix()));
@@ -198,6 +212,10 @@ public void customize(UndertowServletWebServerFactory factory) {
198212
static class JettyAccessLogCustomizer extends AccessLogCustomizer
199213
implements WebServerFactoryCustomizer<JettyServletWebServerFactory> {
200214

215+
JettyAccessLogCustomizer(ManagementServerProperties properties) {
216+
super(properties);
217+
}
218+
201219
@Override
202220
public void customize(JettyServletWebServerFactory factory) {
203221
factory.addServerCustomizers(this::customizeServer);

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/web/server/ManagementServerPropertiesTests.java

+6
Original file line numberDiff line numberDiff line change
@@ -68,4 +68,10 @@ void slashOfBasePathIsDefaultValue() {
6868
assertThat(properties.getBasePath()).isEmpty();
6969
}
7070

71+
@Test
72+
void accessLogsArePrefixedByDefault() {
73+
ManagementServerProperties properties = new ManagementServerProperties();
74+
assertThat(properties.getAccesslog().getPrefix()).isEqualTo("management_");
75+
}
76+
7177
}

0 commit comments

Comments
 (0)