Skip to content

Complete Jetty Access Log configuration properties support #16080

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

Closed
wants to merge 4 commits into from
Closed

Complete Jetty Access Log configuration properties support #16080

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7f78b89
enable configuration of jetty's ncsa request log ignorePaths
nhomble Mar 4, 2019
8a09b5f
enable configuration of jetty's ncsa request log ignorePaths
nhomble Mar 4, 2019
e9ed562
revert some auto formatting from IDE
nhomble Mar 4, 2019
f907fb5
add prefer proxied for address
nhomble Mar 19, 2019
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
25 changes: 25 additions & 0 deletions ...oconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ServerProperties.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -846,6 +846,16 @@ public static class Accesslog {
*/
private boolean logLatency;

/**
* Set request paths that will not be logged.
*/
private List<String> ignorePaths;

/**
* true - IP address from header will be logged, false - IP address from the connection will be logged
*/
private boolean preferProxiedForAddress = false;

public boolean isEnabled() {
return this.enabled;
}
Expand Down Expand Up @@ -942,6 +952,21 @@ public void setLogLatency(boolean logLatency) {
this.logLatency = logLatency;
}

public List<String> getIgnorePaths() {
return ignorePaths;
}

public void setIgnorePaths(List<String> ignorePaths) {
this.ignorePaths = ignorePaths;
}

public boolean getPreferProxiedForAddress(){
return preferProxiedForAddress;
}

public void setPreferProxiedForAddress(boolean preferProxiedForAddress){
this.preferProxiedForAddress = preferProxiedForAddress;
}
}

}
Expand Down
4 changes: 4 additions & 0 deletions .../org/springframework/boot/autoconfigure/web/embedded/JettyWebServerFactoryCustomizer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,9 +167,13 @@ private void customizeAccessLog(ConfigurableJettyWebServerFactory factory,
if (properties.getTimeZone() != null) {
log.setLogTimeZone(properties.getTimeZone().getID());
}
if (properties.getIgnorePaths() != null) {
log.setIgnorePaths(properties.getIgnorePaths().toArray(new String[0]));
}
log.setLogCookies(properties.isLogCookies());
log.setLogServer(properties.isLogServer());
log.setLogLatency(properties.isLogLatency());
log.setPreferProxiedForAddress(properties.getPreferProxiedForAddress());
server.setRequestLog(log);
});
}
Expand Down
5 changes: 5 additions & 0 deletions ...igure/src/test/java/org/springframework/boot/autoconfigure/web/ServerPropertiesTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,13 +190,18 @@ public void testCustomizeJettyAccessLog() {
map.put("server.jetty.accesslog.file-date-format", "yyyymmdd");
map.put("server.jetty.accesslog.retention-period", "4");
map.put("server.jetty.accesslog.append", "true");
map.put("server.jetty.accesslog.ignore-paths[0]", "/a/path");
map.put("server.jetty.accesslog.ignore-paths[1]", "/b/path");
bind(map);
ServerProperties.Jetty jetty = this.properties.getJetty();
assertThat(jetty.getAccesslog().isEnabled()).isTrue();
assertThat(jetty.getAccesslog().getFilename()).isEqualTo("foo.txt");
assertThat(jetty.getAccesslog().getFileDateFormat()).isEqualTo("yyyymmdd");
assertThat(jetty.getAccesslog().getRetentionPeriod()).isEqualTo(4);
assertThat(jetty.getAccesslog().isAppend()).isTrue();
assertThat(jetty.getAccesslog().getIgnorePaths().size()).isEqualTo(2);
assertThat(jetty.getAccesslog().getIgnorePaths().get(0)).isEqualTo("/a/path");
assertThat(jetty.getAccesslog().getIgnorePaths().get(1)).isEqualTo("/b/path");
}

@Test
Expand Down
21 changes: 14 additions & 7 deletions ...springframework/boot/autoconfigure/web/embedded/JettyWebServerFactoryCustomizerTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,23 @@

package org.springframework.boot.autoconfigure.web.embedded;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;

import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
import java.util.TimeZone;

import org.eclipse.jetty.server.Connector;
import org.eclipse.jetty.server.HttpConfiguration;
import org.eclipse.jetty.server.HttpConfiguration.ConnectionFactory;
import org.eclipse.jetty.server.NCSARequestLog;
import org.eclipse.jetty.server.RequestLog;
import org.junit.Before;
import org.junit.Test;

import org.springframework.boot.autoconfigure.web.ServerProperties;
import org.springframework.boot.context.properties.bind.Bindable;
import org.springframework.boot.context.properties.bind.Binder;
Expand All @@ -41,10 +43,6 @@
import org.springframework.mock.env.MockEnvironment;
import org.springframework.test.context.support.TestPropertySourceUtils;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;

/**
* Tests for {@link JettyWebServerFactoryCustomizer}.
*
Expand Down Expand Up @@ -101,7 +99,10 @@ public void accessLogCanBeCustomized() throws IOException {
"server.jetty.accesslog.time-zone=" + timezone,
"server.jetty.accesslog.log-cookies=true",
"server.jetty.accesslog.log-server=true",
"server.jetty.accesslog.log-latency=true");
"server.jetty.accesslog.log-latency=true",
"server.jetty.accesslog.prefer-proxied-for-address=true",
"server.jetty.accesslog.ignore-paths[0]=/a/path",
"server.jetty.accesslog.ignore-paths[1]=/b/path");
JettyWebServer server = customizeAndGetServer();
NCSARequestLog requestLog = getNCSARequestLog(server);
assertThat(requestLog.getFilename()).isEqualTo(logFile.getAbsolutePath());
Expand All @@ -115,6 +116,10 @@ public void accessLogCanBeCustomized() throws IOException {
assertThat(requestLog.getLogCookies()).isTrue();
assertThat(requestLog.getLogServer()).isTrue();
assertThat(requestLog.getLogLatency()).isTrue();
assertThat(requestLog.getPreferProxiedForAddress()).isTrue();
assertThat(requestLog.getIgnorePaths().length).isEqualTo(2);
assertThat(requestLog.getIgnorePaths()[0]).isEqualTo("/a/path");
assertThat(requestLog.getIgnorePaths()[1]).isEqualTo("/b/path");
}

@Test
Expand All @@ -128,6 +133,8 @@ public void accessLogCanBeEnabled() {
assertThat(requestLog.getLogCookies()).isFalse();
assertThat(requestLog.getLogServer()).isFalse();
assertThat(requestLog.getLogLatency()).isFalse();
assertThat(requestLog.getIgnorePaths().length).isZero();
assertThat(requestLog.getPreferProxiedForAddress()).isFalse();
}

private NCSARequestLog getNCSARequestLog(JettyWebServer server) {
Expand Down