背景
随着业务需求的快速变化和技术的演进,当一个用户请求需要跨越多个线程时,形成了复杂的调用链路。当出现性能问题、错误或故障时,导致故障排查、性能优化和业务逻辑理解变得困难。
本文主要论述链路追踪的原理。
原理分析
在日志的输入中,附带当前一次请求的唯一ID,即可实现整个链路的追踪。
主要日志内容,其中TRACE_ID就是链路跟踪的标识符。
<!--控制台日志, 控制台输出 -->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度,%msg:日志消息,%n是换行符-->
<pattern>[%X{TRACE_ID}] %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
</encoder>
</appender>
主要实现原理,通过拦截请求在MDC(日志上下文信息)中存入TRACE_ID,这样在日志中就可以取出。
public class LinkInterceptor implements HandlerInterceptor {
/**
* 跟踪ID的请求头的Key。
*/
private final static String TRACE_IDS = "TRACE_IDS";
/**
* 在处理请求之前执行的拦截器方法。
* 主要用于生成或获取请求的跟踪ID,并将其记录在MDC(Mapped Diagnostic Context)中,以便于日志跟踪。
*
* @param request HttpServletRequest对象,代表客户端的HTTP请求。
* @param response HttpServletResponse对象,代表服务器对客户端的HTTP响应。
* @param handler 将要处理请求的处理器对象。
* @return boolean 返回值总是true,表示请求应该继续被处理。
* @throws Exception 如果处理过程中发生异常,则抛出Exception。
*/
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
// 生成一个唯一的跟踪ID,或从请求头中获取已存在的跟踪ID。
String traceId = "traceId:" + UUID.randomUUID();
if (Objects.nonNull(request.getHeader(TRACE_IDS))) {
traceId = request.getHeader(TRACE_IDS);
}
// 将跟踪ID放入MDC,以便于在日志中记录。
MDC.put(TRACE_IDS, traceId);
return true;
}
/**
* 在处理完成后执行的回调方法。
* 该方法用于在请求处理完成后进行一些清理工作,例如移除日志跟踪ID等。
*
* @param request 本次请求的HttpServletRequest对象
* @param response 本次请求的HttpServletResponse对象
* @param handler 处理本次请求的处理器对象
* @param ex 在处理过程中发生的异常,如果处理过程中没有异常发生,则为null
* @throws Exception 如果在清理过程中发生异常,则抛出Exception
*/
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
// 移除请求跟踪ID,确保每次请求的跟踪信息不混淆
MDC.remove(TRACE_IDS);
}
}
添加自定义拦截器。
@Configuration
public class WebConfigurationAdapter implements WebMvcConfigurer {
@Bean
public LinkInterceptor linkConfiguration() {
return new LinkInterceptor();
}
/**
* 向拦截器注册表中添加拦截器和对应的路径模式。
* 这个方法会将定义的链接配置作为拦截器添加到所有请求中。
*
* @param registry 拦截器注册表,用于注册拦截器和配置拦截器的路径模式。
*/
@Override
public void addInterceptors(InterceptorRegistry registry) {
// 添加链接配置拦截器到所有请求
registry.addInterceptor(linkConfiguration()).addPathPatterns("/**");
}
}