日志追踪MDC

最新推荐文章于 2024-04-01 09:54:15 发布

SeaDhdhdhdhdh

最新推荐文章于 2024-04-01 09:54:15 发布

阅读量175

点赞数

分类专栏： java 文章标签： java

本文链接：https://blog.csdn.net/weixin_43119856/article/details/131838503

版权

java 专栏收录该内容

11 篇文章 0 订阅

订阅专栏

一、基本介绍：

Mapped Diagnostic Context（MDC）是一个SLF4J和Logback提供的功能，它允许将额外的上下文信息附加到当前线程的日志记录中。通过使用MDC，我们可以在日志中添加唯一标识，以便更好地追踪和分析请求在分布式系统中的调用链路。

下面看一个代码示例：

package org.example;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.MDC;

import java.util.UUID;

/**
 * Hello world!
 */
public class App {
    public static final String REQ_ID = "REQ_ID";

    public static void main(String[] args) {
        Logger logger = LoggerFactory.getLogger(App.class);
        MDC.put(REQ_ID, UUID.randomUUID().toString());
        logger.info("开始调用服务A，进行业务处理");
        logger.info("业务处理完毕，可以释放空间了，避免内存泄露");
        MDC.remove(REQ_ID);
        logger.info("REQ_ID 还有吗？{}", MDC.get(REQ_ID) != null);
    }
}

配置logback.xml

<configuration>

    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <!-- encoders are assigned the type
             ch.qos.logback.classic.encoder.PatternLayoutEncoder by default -->
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] [%X{REQ_ID}] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <!--<appender name="STDOUT" class="ch.qos.logback.core.FileAppender">
        &lt;!&ndash; encoders are assigned the type
             ch.qos.logback.classic.encoder.PatternLayoutEncoder by default &ndash;&gt;
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>
-->
    <root level="debug">
        <appender-ref ref="STDOUT" />
    </root>
</configuration>

打印结果：

23:01:06.069 [main] [bd8bcf53-5ce7-4d41-bd3e-18cf6ac8ef28] INFO org.example.App - 开始调用服务A，进行业务处理
23:01:06.069 [main] [bd8bcf53-5ce7-4d41-bd3e-18cf6ac8ef28] INFO org.example.App - 业务处理完毕，可以释放空间了，避免内存泄露
23:01:06.069 [main] [] INFO org.example.App - REQ_ID 还有吗？false

二、注意事项

1.maven依赖

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
    <slf4j.version>1.7.31</slf4j.version>
    <logback.verson>1.2.6</logback.verson>
  </properties>
  <dependencies>
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-api</artifactId>
      <version>${slf4j.version}</version>
    </dependency>
    <dependency>
      <groupId>ch.qos.logback</groupId>
      <artifactId>logback-core</artifactId>
      <version>${logback.verson}</version>
    </dependency>
    <dependency>
      <groupId>ch.qos.logback</groupId>
      <artifactId>logback-classic</artifactId>
      <version>${logback.verson}</version>
    </dependency>
  </dependencies>

注意slf4j-api包一定要和logback-classic包搭配使用，不然会报找不到StaticLoggerBinder错误以及找不到StaticMDCBinder错误。