对于后端开发来说，排查问题是常有的事情。而排查问题时最常用的就是看日志，看一次调用中经过了哪些系统，是那个系统出问题了。这就需要业务日志中关联调用链的TraceId信息，从而在应用出现问题时，能够通过调用链的TraceId快速关联到业务日志，及时定位分析、解决问题。
之前从事的公司都有这种链路中间件，现在阿里集团的eagleeye 鹰眼系统也是的，接入使用就行了，但是原理完全不清楚。不了解TraceId怎么生成的，怎么在系统之间传递。所以今天先来实现一个最简单的TraceId
解决方案
- 自己生成 traceId 并 put 到 MDC 里面
MDC
MDC（Mapped Diagnostic Context）是一个映射，用于存储运行上下文的特定线程的上下文数据。因此，如果使用log4j进行日志记录，则每个线程都可以拥有自己的MDC，该MDC对整个线程是全局的。属于该线程的任何代码都可以轻松访问线程的MDC中存在的值。请求时，将TraceId放在header里，服务方从header里读取出来，并在日志上打印即可
如何将TraceId放到MDC中
1.日志文件logback-spring.xml配置
打印彩色日志，需要在日志格式中加上[%X{TRACE_ID}]，变量名TRACE_ID是自己定义的
<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds">
<contextName>logback
</contextName>
<!-- name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后，可以使“${}”来使用变量。 -->
<property name="log.path" value="log"/>
<!-- 彩色日志 -->
<!-- 彩色日志依赖的渲染类 -->
<conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter"/>
<conversionRule conversionWord="wex"
converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter"/>
<conversionRule conversionWord="wEx"
converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter"/>
<!-- 彩色日志格式，注意加上TRACE_ID -->
<property name="CONSOLE_LOG_PATTERN"
value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} [%X{TRACE_ID}] %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/> <!--输出到控制台-->
<appender name="CONSOLE"
class="ch.qos.logback.core.ConsoleAppender">
<!--此日志appender是为开发使用，只配置最底级别，控制台输出的日志级别是大于或等于此级别的日志信息-->
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>info</level>
</filter>
<encoder>
<Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
<charset>UTF-8</charset>
</encoder>
</appender>
<root level="info">
<appender-ref ref="CONSOLE"/>
</root>
</configuration>
2.新增拦截器
拦截所有请求，从header里取出traceId然后放到MDC中，这样该工程所有位置都能读取到。如果header里没有，则自己生成一个，生成规则可参考阿里云帮助文档: TraceId 和 SpanId 生成规则
import cn.hutool.core.util.StrUtil;
import lombok.extern.slf4j.Slf4j;
import org.slf4j.MDC;
import org.springframework.core.annotation.Order;
import org.springframework.web.servlet.HandlerInterceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.UUID;
/**
* 日志拦截器
*/
@Slf4j
@Order(-100)
public class LogInterceptor implements HandlerInterceptor {
/**
* 设置到 MDC 里的key（惯例使用小驼峰，为了统一这里也用大写）
*/
private static final String TRACE_ID = "traceId";
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
String traceId = request.getHeader(TRACE_ID);
if (StrUtil.isEmpty(traceId)) {
traceId = UUID.randomUUID().toString();
}
MDC.put(TRACE_ID, traceId);
return true;
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
MDC.clear();
}
}
3.注册拦截器
将上一步的日志拦截器注册，并拦截所有路径的HTTP请求，让其生效
import com.dataqin.authorize.api.web.interceptor.LogInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration
public class WebSecurityConfig implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new LogInterceptor()).addPathPatterns("/**");
}
}
4.测试效果
到这一步就可以试试日志打印TraceId的效果了，随便写一个接口，并打印日志。如下图已经成功打印出Traceid了
其他方案
上面演示的是最简陋的方式，公司内部一般都会再造一遍轮子，让各个应用接入使用的。后面再写几个开源的TraceId生成框架，更深入的去了解全链路治理
