logback-mdc-ttl 使用教程

logback-mdc-ttl 使用教程

logback-mdc-ttllogback扩展，集成transmittable-thread-local支持跨线程池的mdc跟踪项目地址:https://gitcode.com/gh_mirrors/lo/logback-mdc-ttl

项目介绍

logback-mdc-ttl 是一个开源项目，旨在解决分布式系统中跨线程池的日志跟踪问题。通过集成 SLF4J 的 MDC（Mapped Diagnostic Context）和阿里的 TransmittableThreadLocal，该项目能够确保在多线程环境下，日志的上下文信息（如 TraceID）能够正确传递，从而实现日志的连续性和可追踪性。

项目快速启动

环境准备

• Java 8 或更高版本
• Maven 3.x

添加依赖

在您的 pom.xml 文件中添加以下依赖：

<dependency>
    <groupId>com.ofpay</groupId>
    <artifactId>logback-mdc-ttl</artifactId>
    <version>1.0.0</version>
</dependency>

配置 logback.xml

在 src/main/resources 目录下创建或更新 logback.xml 文件，添加以下配置：

<configuration>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %X{traceId} - %msg%n</pattern>
        </encoder>
    </appender>

    <root level="debug">
        <appender-ref ref="STDOUT"/>
    </root>
</configuration>

示例代码

以下是一个简单的示例代码，展示如何在多线程环境中使用 logback-mdc-ttl：

import com.alibaba.ttl.TransmittableThreadLocal;
import com.alibaba.ttl.TtlRunnable;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.MDC;

import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;

public class LogbackMdcTtlExample {
    private static final Logger logger = LoggerFactory.getLogger(LogbackMdcTtlExample.class);

    public static void main(String[] args) {
        TransmittableThreadLocal<String> context = new TransmittableThreadLocal<>();
        context.set("12345");

        MDC.put("traceId", context.get());

        ExecutorService executorService = Executors.newFixedThreadPool(2);

        Runnable task = () -> {
            logger.info("Logging in thread");
        };

        executorService.submit(TtlRunnable.get(task));

        executorService.shutdown();
    }
}

应用案例和最佳实践

应用案例

在分布式系统中，特别是在微服务架构中，logback-mdc-ttl 可以帮助开发人员追踪用户请求的完整流程。例如，当用户发起一个请求时，系统可以生成一个唯一的 TraceID，并将其放入 MDC 中。无论请求在系统中经过多少个服务和线程，这个 TraceID 都会被保留，从而使得开发人员可以轻松地通过日志追踪请求的完整路径。

最佳实践

1. 统一日志格式：确保所有服务的日志格式一致，特别是 TraceID 的位置和格式。
2. 自动化集成：在服务启动时自动生成 TraceID，并将其放入 MDC 中，减少手动操作。
3. 监控和报警：结合日志监控系统，如 ELK Stack，实时监控日志并设置报警机制。

典型生态项目

logback-mdc-ttl 通常与其他日志和监控工具结合使用，以构建完整的日志跟踪和分析系统。以下是一些典型的生态项目：

1. ELK Stack：Elasticsearch, Logstash, Kibana 用于日志的收集、存储和可视化。
2. Zipkin：分布式跟踪系统，用于收集和查找微服务架构中的性能数据。
3. Prometheus：开源监控系统和时间序列数据库，用于收集和查询系统指标。

通过这些工具的结合使用，可以实现对分布式系统中日志的全面管理和分析，从而提高系统的可维护性和问题定位效率。

logback-mdc-ttllogback扩展，集成transmittable-thread-local支持跨线程池的mdc跟踪项目地址:https://gitcode.com/gh_mirrors/lo/logback-mdc-ttl