org.springframework.cloud.sleuth.instrument.web

Class TraceHandlerInterceptor

java.lang.Object

org.springframework.web.servlet.handler.HandlerInterceptorAdapter

org.springframework.cloud.sleuth.instrument.web.TraceHandlerInterceptor

All Implemented Interfaces:

org.springframework.web.servlet.AsyncHandlerInterceptor, org.springframework.web.servlet.HandlerInterceptor

public class TraceHandlerInterceptor
extends org.springframework.web.servlet.handler.HandlerInterceptorAdapter

HandlerInterceptor that wraps handling of a request in a Span. Adds tags related to the class and method name. The interceptor will not create spans for error controller related paths. It's important to note that this implementation will set the request attribute TraceRequestAttributes.HANDLED_SPAN_REQUEST_ATTR when the request is processed. That way the TraceFilter will not create the "fallback" span.

Since:

1.0.3

Author:

Marcin Grzejszczak

Constructor Summary

Constructors

Constructor and Description
TraceHandlerInterceptor(org.springframework.beans.factory.BeanFactory beanFactory)

Method Summary

Modifier and Type	Method and Description
void	afterCompletion(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Object handler, Exception ex)
void	afterConcurrentHandlingStarted(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Object handler)
boolean	preHandle(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Object handler)

Methods inherited from class org.springframework.web.servlet.handler.HandlerInterceptorAdapter

postHandle

Methods inherited from class java.lang.Object

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

Constructor Detail

TraceHandlerInterceptor

public TraceHandlerInterceptor(org.springframework.beans.factory.BeanFactory beanFactory)

Method Detail

preHandle

public boolean preHandle(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response,
                         Object handler)
                  throws Exception

Specified by:

preHandle in interface org.springframework.web.servlet.HandlerInterceptor

Overrides:

preHandle in class org.springframework.web.servlet.handler.HandlerInterceptorAdapter

Throws:

Exception

afterConcurrentHandlingStarted

public void afterConcurrentHandlingStarted(javax.servlet.http.HttpServletRequest request,
                                           javax.servlet.http.HttpServletResponse response,
                                           Object handler)
                                    throws Exception

Specified by:

afterConcurrentHandlingStarted in interface org.springframework.web.servlet.AsyncHandlerInterceptor

Overrides:

afterConcurrentHandlingStarted in class org.springframework.web.servlet.handler.HandlerInterceptorAdapter

Throws:

Exception

afterCompletion

public void afterCompletion(javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response,
                            Object handler,
                            Exception ex)
                     throws Exception

Specified by:

afterCompletion in interface org.springframework.web.servlet.HandlerInterceptor

Overrides:

afterCompletion in class org.springframework.web.servlet.handler.HandlerInterceptorAdapter

Throws:

Exception