在Logback中配置`requestId`进行日志追踪的实践与应用

在Logback中配置requestId进行日志追踪的实践与应用

1. 引言

在分布式系统和微服务架构中，日志是调试、监控和性能分析的关键工具。然而，由于多个请求会在系统中并行处理，日志记录很容易变得杂乱无章，难以区分属于同一请求的日志。为了解决这一问题，我们可以在日志中引入requestId，确保每个请求的生命周期内生成的所有日志都包含一个唯一标识符。

本文将深入探讨如何在Java Spring Boot应用中，通过配置logback-spring.xml文件和使用MDC（Mapped Diagnostic Context）技术，确保在不同场景下（包括普通Controller请求、定时任务、线程池场景等）日志中都能记录并追踪唯一的requestId。

2. 基础知识

2.1 什么是Logback？

Logback 是一个高效、灵活的Java日志框架，广泛用于Spring Boot项目中。它支持多种日志输出格式和策略，允许用户灵活配置日志级别、输出格式、目标位置等。

2.2 什么是requestId？

requestId是一个唯一标识符，用于标识每个请求的日志条目。通过为每个请求生成一个唯一的requestId，我们可以在分布式系统中轻松追踪请求的流向和执行情况。

2.3 什么是MDC（Mapped Diagnostic Context）？

MDC（映射诊断上下文）是slf4j提供的一种机制，允许在多线程环境中存储和共享上下文信息（例如requestId）。MDC数据与当前线程相关联，因此能够有效区分和跟踪多线程环境中的日志。

---

3. 普通Controller请求场景

3.1 场景描述

在Web应用中，每个HTTP请求会触发一个Controller方法的执行。为了在日志中记录每个请求的唯一标识符，我们需要在每个请求开始时生成一个requestId，并将其贯穿于请求处理的整个流程中。

3.2 配置Logback

首先，我们需要在logback-spring.xml文件中配置日志格式，确保requestId能被正确输出：

1. 修改logback-spring.xml文件：

   <?xml version="1.0" encoding="UTF-8"?>
   <configuration>
   
       <property name="LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] [%X{requestId}] %-5level %logger{36} - %msg%n" />
   
       <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
           <encoder>
               <pattern>${LOG_PATTERN}</pattern>
           </encoder>
       </appender>
   
       <root level="INFO">
           <appender-ref ref="CONSOLE" />
       </root>
   
   </configuration>
   

   在这里，我们使用%X{requestId}来引用MDC中的requestId。

2. 创建过滤器以生成和设置requestId：

   创建一个Servlet过滤器，在每个请求到达时生成一个requestId并将其放入MDC：

   import org.slf4j.MDC;
   import javax.servlet.Filter;
   import javax.servlet.FilterChain;
   import javax.servlet.FilterConfig;
   import javax.servlet.ServletException;<