Spring Cloud：使用TraceId进行日志追踪

使用 TraceId 来进行日志追踪，目前常见的做法都是基于日志框架的 MDC 机制。例如 Spring Cloud Sleuth 就是借助 MDC 机制的。

MDC 介绍 MDC（Mapped Diagnostic Context，映射调试上下文）是 log4j 和 logback 提供的一种方便在多线程条件下记录日志的功能。MDC 可以看成是一个与当前线程绑定的Map，可以往其中添加键值对。MDC 中包含的内容可以被同一线程中执行的代码所访问。当前线程的子线程会继承其父线程中的 MDC 的内容。当需要记录日志时，只需要从 MDC 中获取所需的信息即可。MDC 的内容则由程序在适当的时候保存进去。对于一个 Web 应用来说，通常是在请求被处理的最开始保存这些数据。

术语

 

• Span：基础工作单元。例如一个RPC请求就是一个span，span还包含其他数据，例如ID , 描述（descriptions）, 时间戳事件（timestamped events）, 键值标签（key-value tags）, 进程ID
• Trace：一组span组成的树状结构。例如，在一个分布式系统里，一个trace就是一个request请求

举个例子（Spring Cloud）

Spring Cloud 项目直接添加 Spring Cloud Sleuth，然后就可以在日志中打印 TraceId。

如：

pom.xml

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-sleuth</artifactId>
</dependency>

然后就可以在日志中使用 TraceId 了，如 logback.xml 中这样配置 ：

...
    <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %5p ${APPLICATION_NAME} ${HOSTNAME} ${PID} [%X{traceId},%X{spanId}] ==> [%thread] [%c#%M-%L] : %m%n"</pattern>
...

注意，Spring Cloud Sleuth 使用的 TraceId key 为 traceId,spanId

Example

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.*;
import org.springframework.boot.autoconfigure.*;
import org.springframework.web.bind.annotation.*;

@RestController
@EnableAutoConfiguration
public class Example {

    private static final Logger log = LoggerFactory.getLogger(Example.class);

    @RequestMapping("/")
    String home() {
        log.info("Hello world!");
        return "Hello World!";
    }

    public static void main(String[] args) {
        SpringApplication.run(Example.class, args);
    }

}