Skip to content
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

Allow specifying a different management access log prefix #43434

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Allow specifying a different management access log prefix #43434

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 24 additions & 0 deletions ...org/springframework/boot/actuate/autoconfigure/web/server/ManagementServerProperties.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@ public class ManagementServerProperties {
@NestedConfigurationProperty
private Ssl ssl;

private final Accesslog accesslog = new Accesslog();

/**
* Returns the management port or {@code null} if the
* {@link ServerProperties#getPort() server port} should be used.
Expand Down Expand Up @@ -117,4 +119,26 @@ private String cleanBasePath(String basePath) {
return candidate;
}

public Accesslog getAccesslog() {
return this.accesslog;
}

public static class Accesslog {

/**
* Enable management access logs prefix customization
* management.server.accesslog.prefix.
*/
private String prefix = "management_";

public String getPrefix() {
return this.prefix;
}

public void setPrefix(String prefix) {
this.prefix = prefix;
}

}

}
39 changes: 30 additions & 9 deletions ...rk/boot/actuate/autoconfigure/web/servlet/ServletManagementChildContextConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
import org.springframework.boot.autoconfigure.web.servlet.ServletWebServerFactoryCustomizer;
import org.springframework.boot.autoconfigure.web.servlet.TomcatServletWebServerFactoryCustomizer;
import org.springframework.boot.autoconfigure.web.servlet.UndertowServletWebServerFactoryCustomizer;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.boot.web.embedded.jetty.JettyServletWebServerFactory;
import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory;
import org.springframework.boot.web.embedded.undertow.UndertowServletWebServerFactory;
Expand All @@ -73,6 +74,7 @@
*/
@ManagementContextConfiguration(value = ManagementContextType.CHILD, proxyBeanMethods = false)
@ConditionalOnWebApplication(type = Type.SERVLET)
@EnableConfigurationProperties(ManagementServerProperties.class)
class ServletManagementChildContextConfiguration {

@Bean
Expand All @@ -83,20 +85,22 @@ ServletManagementWebServerFactoryCustomizer servletManagementWebServerFactoryCus

@Bean
@ConditionalOnClass(name = "io.undertow.Undertow")
UndertowAccessLogCustomizer undertowManagementAccessLogCustomizer() {
return new UndertowAccessLogCustomizer();
UndertowAccessLogCustomizer undertowManagementAccessLogCustomizer(
mpalourdio marked this conversation as resolved.
Show resolved Hide resolved
ManagementServerProperties managementServerProperties) {
return new UndertowAccessLogCustomizer(managementServerProperties);
}

@Bean
@ConditionalOnClass(name = "org.apache.catalina.valves.AccessLogValve")
TomcatAccessLogCustomizer tomcatManagementAccessLogCustomizer() {
return new TomcatAccessLogCustomizer();
TomcatAccessLogCustomizer tomcatManagementAccessLogCustomizer(
ManagementServerProperties managementServerProperties) {
return new TomcatAccessLogCustomizer(managementServerProperties);
}

@Bean
@ConditionalOnClass(name = "org.eclipse.jetty.server.Server")
JettyAccessLogCustomizer jettyManagementAccessLogCustomizer() {
return new JettyAccessLogCustomizer();
JettyAccessLogCustomizer jettyManagementAccessLogCustomizer(ManagementServerProperties managementServerProperties) {
return new JettyAccessLogCustomizer(managementServerProperties);
}

@Configuration(proxyBeanMethods = false)
Expand Down Expand Up @@ -145,14 +149,18 @@ private String getContextPath(ManagementServerProperties managementServerPropert

abstract static class AccessLogCustomizer implements Ordered {

private static final String MANAGEMENT_PREFIX = "management_";
protected final ManagementServerProperties managementServerProperties;

AccessLogCustomizer(ManagementServerProperties managementServerProperties) {
this.managementServerProperties = managementServerProperties;
}

protected String customizePrefix(String prefix) {
prefix = (prefix != null) ? prefix : "";
if (prefix.startsWith(MANAGEMENT_PREFIX)) {
if (prefix.startsWith(this.managementServerProperties.getAccesslog().getPrefix())) {
return prefix;
}
return MANAGEMENT_PREFIX + prefix;
return this.managementServerProperties.getAccesslog().getPrefix() + prefix;
}

@Override
Expand All @@ -165,12 +173,17 @@ public int getOrder() {
static class TomcatAccessLogCustomizer extends AccessLogCustomizer
implements WebServerFactoryCustomizer<TomcatServletWebServerFactory> {

TomcatAccessLogCustomizer(ManagementServerProperties managementServerProperties) {
mpalourdio marked this conversation as resolved.
Show resolved Hide resolved
super(managementServerProperties);
}

@Override
public void customize(TomcatServletWebServerFactory factory) {
AccessLogValve accessLogValve = findAccessLogValve(factory);
if (accessLogValve == null) {
return;
}

accessLogValve.setPrefix(customizePrefix(accessLogValve.getPrefix()));
}

Expand All @@ -188,6 +201,10 @@ private AccessLogValve findAccessLogValve(TomcatServletWebServerFactory factory)
static class UndertowAccessLogCustomizer extends AccessLogCustomizer
implements WebServerFactoryCustomizer<UndertowServletWebServerFactory> {

UndertowAccessLogCustomizer(ManagementServerProperties managementServerProperties) {
super(managementServerProperties);
}

@Override
public void customize(UndertowServletWebServerFactory factory) {
factory.setAccessLogPrefix(customizePrefix(factory.getAccessLogPrefix()));
Expand All @@ -198,6 +215,10 @@ public void customize(UndertowServletWebServerFactory factory) {
static class JettyAccessLogCustomizer extends AccessLogCustomizer
implements WebServerFactoryCustomizer<JettyServletWebServerFactory> {

JettyAccessLogCustomizer(ManagementServerProperties managementServerProperties) {
super(managementServerProperties);
}

@Override
public void customize(JettyServletWebServerFactory factory) {
factory.addServerCustomizers(this::customizeServer);
Expand Down
6 changes: 6 additions & 0 deletions ...pringframework/boot/actuate/autoconfigure/web/server/ManagementServerPropertiesTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,10 @@ void slashOfBasePathIsDefaultValue() {
assertThat(properties.getBasePath()).isEmpty();
}

@Test
void accessLogsArePrefixedByDefault() {
ManagementServerProperties properties = new ManagementServerProperties();
assertThat(properties.getAccesslog().getPrefix()).isEqualTo("management_");
}

}
Loading