org.springframework.cloud.gcp.logging

Class TraceIdLoggingWebMvcInterceptor

java.lang.Object

org.springframework.web.servlet.handler.HandlerInterceptorAdapter

org.springframework.cloud.gcp.logging.TraceIdLoggingWebMvcInterceptor

All Implemented Interfaces:

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

Direct Known Subclasses:

TraceIdLoggingWebMvcInterceptor

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

HandlerInterceptor that extracts the request trace ID from the "x-cloud-trace-context" HTTP header and stores it in a thread-local using TraceIdLoggingEnhancer.setCurrentTraceId(java.lang.String).

The TraceIdLoggingEnhancer can then be used in a logging appender to add the trace ID metadata to log messages.

Author:

Mike Eltsufin, Chengyuan Zhao

Constructor Summary

Constructors

Constructor and Description
TraceIdLoggingWebMvcInterceptor(TraceIdExtractor extractor)

Method Summary

Modifier and Type	Method and Description
void	afterCompletion(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse, Object handler, Exception e)
TraceIdExtractor	getTraceIdExtractor()
boolean	preHandle(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, Object handler)

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

afterConcurrentHandlingStarted, postHandle

Methods inherited from class java.lang.Object

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

Constructor Detail

TraceIdLoggingWebMvcInterceptor

public TraceIdLoggingWebMvcInterceptor(TraceIdExtractor extractor)

Method Detail

getTraceIdExtractor

public TraceIdExtractor getTraceIdExtractor()

preHandle

public boolean preHandle(javax.servlet.http.HttpServletRequest req,
                         javax.servlet.http.HttpServletResponse resp,
                         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

afterCompletion

public void afterCompletion(javax.servlet.http.HttpServletRequest httpServletRequest,
                            javax.servlet.http.HttpServletResponse httpServletResponse,
                            Object handler,
                            Exception e)
                     throws Exception

Specified by:

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

Overrides:

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

Throws:

Exception