org.springframework.cloud.sleuth.instrument.web

Class TraceFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.cloud.sleuth.instrument.web.TraceFilter

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

@Order(value=-2147483643)
public class TraceFilter
extends org.springframework.web.filter.GenericFilterBean

Filter that takes the value of the Span.SPAN_ID_NAME and Span.TRACE_ID_NAME header from either request or response and uses them to create a new span.

In order to keep the size of spans manageable, this only add tags defined in TraceKeys. If you need to add additional tags, such as headers subtype this and override addRequestTags(org.springframework.cloud.sleuth.Span, javax.servlet.http.HttpServletRequest) or addResponseTags(javax.servlet.http.HttpServletResponse, java.lang.Throwable).

Since:

1.0.0

Author:

Jakub Nabrdalik, 4financeIT, Tomasz Nurkiewicz, 4financeIT, Marcin Grzejszczak, Spencer Gibb, Dave Syer

See Also:

Tracer, TraceKeys, TraceWebAutoConfiguration.traceFilter(org.springframework.cloud.sleuth.Tracer, org.springframework.cloud.sleuth.TraceKeys, org.springframework.cloud.sleuth.instrument.web.TraceWebAutoConfiguration.SkipPatternProvider, org.springframework.cloud.sleuth.SpanReporter, org.springframework.cloud.sleuth.instrument.web.HttpSpanExtractor, org.springframework.cloud.sleuth.instrument.web.HttpTraceKeysInjector)

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SKIP_PATTERN Deprecated. please use SleuthWebProperties.DEFAULT_SKIP_PATTERN
protected static int	ORDER
protected static String	TRACE_ERROR_HANDLED_REQUEST_ATTR
protected static String	TRACE_REQUEST_ATTR

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

logger

Constructor Summary

Constructors

Constructor and Description
TraceFilter(Tracer tracer, TraceKeys traceKeys, Pattern skipPattern, SpanReporter spanReporter, HttpSpanExtractor spanExtractor, HttpTraceKeysInjector httpTraceKeysInjector)
TraceFilter(Tracer tracer, TraceKeys traceKeys, SpanReporter spanReporter, HttpSpanExtractor spanExtractor, HttpTraceKeysInjector httpTraceKeysInjector)

Method Summary

Modifier and Type	Method and Description
protected void	addRequestTags(Span span, javax.servlet.http.HttpServletRequest request) Override to add annotations not defined in TraceKeys.
protected void	addResponseTags(javax.servlet.http.HttpServletResponse response, Throwable e) Override to add annotations not defined in TraceKeys.
void	doFilter(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse, javax.servlet.FilterChain filterChain)
protected boolean	isAsyncStarted(javax.servlet.http.HttpServletRequest request)

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

addRequiredProperty, afterPropertiesSet, destroy, 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

ORDER

protected static final int ORDER

See Also:

Constant Field Values

TRACE_REQUEST_ATTR

protected static final String TRACE_REQUEST_ATTR

TRACE_ERROR_HANDLED_REQUEST_ATTR

protected static final String TRACE_ERROR_HANDLED_REQUEST_ATTR

DEFAULT_SKIP_PATTERN

@Deprecated
public static final String DEFAULT_SKIP_PATTERN

Deprecated. please use SleuthWebProperties.DEFAULT_SKIP_PATTERN

See Also:

Constant Field Values

Constructor Detail

TraceFilter

public TraceFilter(Tracer tracer,
                   TraceKeys traceKeys,
                   SpanReporter spanReporter,
                   HttpSpanExtractor spanExtractor,
                   HttpTraceKeysInjector httpTraceKeysInjector)

TraceFilter

public TraceFilter(Tracer tracer,
                   TraceKeys traceKeys,
                   Pattern skipPattern,
                   SpanReporter spanReporter,
                   HttpSpanExtractor spanExtractor,
                   HttpTraceKeysInjector httpTraceKeysInjector)

Method Detail

doFilter

public void doFilter(javax.servlet.ServletRequest servletRequest,
                     javax.servlet.ServletResponse servletResponse,
                     javax.servlet.FilterChain filterChain)
              throws IOException,
                     javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

addRequestTags

protected void addRequestTags(Span span,
                              javax.servlet.http.HttpServletRequest request)

Override to add annotations not defined in TraceKeys.

addResponseTags

protected void addResponseTags(javax.servlet.http.HttpServletResponse response,
                               Throwable e)

Override to add annotations not defined in TraceKeys.

isAsyncStarted

protected boolean isAsyncStarted(javax.servlet.http.HttpServletRequest request)