com.foreach.across.modules.logging.request

Class RequestLoggerFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

com.foreach.across.modules.logging.request.RequestLoggerFilter

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.web.context.ServletContextAware

public class RequestLoggerFilter
extends org.springframework.web.filter.OncePerRequestFilter

RequestLoggerFilter times http requests and logs the result in a tab separated fashion. Logs the following attributes if they are available:

• Remote address
• HTTP method
• URL
• Servlet path
• Best matching request mapping
• Handler name
• View name
• HTTP status code
• Duration (ms)

RequestLoggerFilter uses org.slf4j.MDC for storing a unique request id which can be referred to in logfiles. The unique id can be added to any logfile by adding the %X{requestId} parameter. The same id can found in the request header attribute "Request-Reference".

Version:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE_START_TIME
static String	ATTRIBUTE_UNIQUE_ID
static String	HEADER_REQUEST_ID
static String	LOG_INSTANCEID
static String	LOG_REQUESTID

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

ALREADY_FILTERED_SUFFIX

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

logger

Constructor Summary

Constructors

Constructor and Description
RequestLoggerFilter()

Method Summary

Modifier and Type	Method and Description
protected void	doFilterInternal(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.FilterChain chain)
Collection<String>	getExcludedPathPatterns()
Collection<String>	getIncludedPathPatterns()
void	setExcludedPathPatterns(@NonNull Collection<String> excludedPathPatterns)
void	setIncludedPathPatterns(@NonNull Collection<String> includedPathPatterns)
void	setInstanceId(String instanceId)
void	setLoggerLevelThreshold(LoggerLevelThreshold loggerLevelThreshold)

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

doFilter, doFilterNestedErrorDispatch, 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

Field Detail

HEADER_REQUEST_ID

public static final String HEADER_REQUEST_ID

See Also:

Constant Field Values

LOG_INSTANCEID

public static final String LOG_INSTANCEID

See Also:

Constant Field Values

LOG_REQUESTID

public static final String LOG_REQUESTID

See Also:

Constant Field Values

ATTRIBUTE_UNIQUE_ID

public static final String ATTRIBUTE_UNIQUE_ID

See Also:

Constant Field Values

ATTRIBUTE_START_TIME

public static final String ATTRIBUTE_START_TIME

See Also:

Constant Field Values

Constructor Detail

RequestLoggerFilter

public RequestLoggerFilter()

Method Detail

setInstanceId

public void setInstanceId(String instanceId)

doFilterInternal

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

Specified by:

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

Throws:

javax.servlet.ServletException

IOException

getIncludedPathPatterns

public Collection<String> getIncludedPathPatterns()

setIncludedPathPatterns

public void setIncludedPathPatterns(@NonNull
                                    @NonNull Collection<String> includedPathPatterns)

getExcludedPathPatterns

public Collection<String> getExcludedPathPatterns()

setExcludedPathPatterns

public void setExcludedPathPatterns(@NonNull
                                    @NonNull Collection<String> excludedPathPatterns)

setLoggerLevelThreshold

public void setLoggerLevelThreshold(LoggerLevelThreshold loggerLevelThreshold)