org.springframework.boot.actuate.trace

Class WebRequestTraceFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

org.springframework.boot.actuate.trace.WebRequestTraceFilter

All Implemented Interfaces:

javax.servlet.Filter, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.EnvironmentAware, org.springframework.core.env.EnvironmentCapable, org.springframework.core.Ordered, org.springframework.web.context.ServletContextAware

public class WebRequestTraceFilter
extends org.springframework.web.filter.OncePerRequestFilter
implements org.springframework.core.Ordered

Servlet Filter that logs all requests to a TraceRepository.

Since:

1.0.0

Author:

Dave Syer, Wallace Wadge, Andy Wilkinson, Venil Noronha, Madhura Bhave

Field Summary

Fields inherited from class org.springframework.web.filter.OncePerRequestFilter

ALREADY_FILTERED_SUFFIX

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
WebRequestTraceFilter(TraceRepository repository, TraceProperties properties) Create a new WebRequestTraceFilter instance.

Method Summary

Modifier and Type	Method and Description
protected void	doFilterInternal(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.FilterChain filterChain)
protected void	enhanceTrace(Map<String,Object> trace, javax.servlet.http.HttpServletResponse response)
int	getOrder()
protected Map<String,Object>	getTrace(javax.servlet.http.HttpServletRequest request)
protected void	postProcessRequestHeaders(Map<String,Object> headers) Post process request headers before they are added to the trace.
void	setDumpRequests(boolean dumpRequests) Debugging feature.
void	setErrorAttributes(ErrorAttributes errorAttributes)
void	setOrder(int order)

Methods inherited from class org.springframework.web.filter.OncePerRequestFilter

doFilter, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted, shouldNotFilter, shouldNotFilterAsyncDispatch, shouldNotFilterErrorDispatch

Methods inherited from class org.springframework.web.filter.GenericFilterBean

addRequiredProperty, afterPropertiesSet, createEnvironment, destroy, getEnvironment, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebRequestTraceFilter

public WebRequestTraceFilter(TraceRepository repository,
                             TraceProperties properties)

Create a new WebRequestTraceFilter instance.

Parameters:

repository - the trace repository

properties - the trace properties

Method Detail

setDumpRequests

public void setDumpRequests(boolean dumpRequests)

Debugging feature. If enabled, and trace logging is enabled then web request headers will be logged.

Parameters:

dumpRequests - if requests should be logged

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

setOrder

public void setOrder(int order)

doFilterInternal

protected void doFilterInternal(javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response,
                                javax.servlet.FilterChain filterChain)
                         throws javax.servlet.ServletException,
                                IOException

Specified by:

doFilterInternal in class org.springframework.web.filter.OncePerRequestFilter

Throws:

javax.servlet.ServletException

IOException

getTrace

protected Map<String,Object> getTrace(javax.servlet.http.HttpServletRequest request)

postProcessRequestHeaders

protected void postProcessRequestHeaders(Map<String,Object> headers)

Post process request headers before they are added to the trace.

Parameters:

headers - a mutable map containing the request headers to trace

Since:

1.4.0

enhanceTrace

protected void enhanceTrace(Map<String,Object> trace,
                            javax.servlet.http.HttpServletResponse response)

setErrorAttributes

public void setErrorAttributes(ErrorAttributes errorAttributes)