Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Header predicate option in AbstractRequestLoggingFilter

Browse Source 
Closes gh-22244
This commit is contained in:
Rossen Stoyanchev
2019-03-12 17:05:40 -04:00
parent 19c024f91f
commit 57a67a3c06
2 changed files with 79 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
spring-web/src/main/java/org/springframework/web/filter/AbstractRequestLoggingFilter.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2018 the original author or authors.
* Copyright 2002-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.
@@ -18,12 +18,15 @@ package org.springframework.web.filter;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.util.Enumeration;
import java.util.function.Predicate;
import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import org.springframework.http.HttpHeaders;
import org.springframework.http.server.ServletServerHttpRequest;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
@@ -95,6 +98,9 @@ public abstract class AbstractRequestLoggingFilter extends OncePerRequestFilter
private boolean includePayload = false;
@Nullable
private Predicate<String> headerPredicate;
private int maxPayloadLength = DEFAULT_MAX_PAYLOAD_LENGTH;
private String beforeMessagePrefix = DEFAULT_BEFORE_MESSAGE_PREFIX;
@@ -176,6 +182,26 @@ public abstract class AbstractRequestLoggingFilter extends OncePerRequestFilter
return this.includePayload;
}
/**
* Configure a predicate for selecting which headers should be logged if
* {@link #setIncludeHeaders(boolean)} is set to {@code true}.
* <p>By default this is not set in which case all headers are logged.
* @param headerPredicate the predicate to use
* @since 5.2
*/
public void setHeaderPredicate(@Nullable Predicate<String> headerPredicate) {
this.headerPredicate = headerPredicate;
}
/**
* The configured {@link #setHeaderPredicate(Predicate) headerPredicate}.
* @since 5.2
*/
@Nullable
public Predicate<String> getHeaderPredicate() {
return this.headerPredicate;
}
/**
* Set the maximum length of the payload body to be included in the log message.
* Default is 50 characters.
@@ -320,7 +346,17 @@ public abstract class AbstractRequestLoggingFilter extends OncePerRequestFilter
}
if (isIncludeHeaders()) {
msg.append(";headers=").append(new ServletServerHttpRequest(request).getHeaders());
HttpHeaders headers = new ServletServerHttpRequest(request).getHeaders();
if (getHeaderPredicate() != null) {
Enumeration<String> names = request.getHeaderNames();
while (names.hasMoreElements()) {
String header = names.nextElement();
if (!getHeaderPredicate().test(header)) {
headers.set(header, "masked");
}
}
}
msg.append(";headers=").append(headers);
}
if (isIncludePayload()) {