logback-mdc-ttl 项目安装和配置指南

logback-mdc-ttl 项目安装和配置指南

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

1. 项目的基础介绍和主要的编程语言

项目名称: logback-mdc-ttl
项目简介: logback-mdc-ttl 是一个 logback 扩展项目，旨在支持跨线程池的 MDC（Mapped Diagnostic Context）跟踪。它通过集成 Transmittable ThreadLocal (TTL) 来实现这一功能，解决了在异步执行时上下文传递的问题。
主要编程语言: Java

2. 项目使用的关键技术和框架

• logback: 一个灵活且高效的日志框架，是 log4j 的后继者。
• Transmittable ThreadLocal (TTL): 一个用于在线程池等缓存线程的组件中传递 ThreadLocal 值的工具。
• MDC (Mapped Diagnostic Context): 用于在多线程环境中传递上下文信息。

3. 项目安装和配置的准备工作和详细的安装步骤

准备工作:

• 确保你已经安装了 Java 开发环境（JDK 6 及以上版本）。
• 确保你已经安装了 Maven 或 Gradle 用于项目依赖管理。

安装步骤:

1. 下载项目: 你可以通过以下命令将项目克隆到本地：

   git clone https://github.com/ofpay/logback-mdc-ttl.git
   

2. 添加项目依赖: 在你的项目 pom.xml 文件中添加以下依赖：

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

3. 配置 Java 启动参数: 在启动 Java 应用程序时，添加以下启动参数：

   -Xbootclasspath/a:/path/to/transmittable-thread-local-2.x.x.jar -javaagent:/path/to/transmittable-thread-local-2.x.x.jar
   

   请将 /path/to/transmittable-thread-local-2.x.x.jar 替换为实际的 TTL 库路径。

4. 配置 logback: 在你的 logback 配置文件（通常是 logback.xml）中添加 TtlMdcListener：

   <configuration>
       <!-- 其他配置项 -->
       <contextListener class="com.ofpay.logback.TtlMdcListener"/>
       <!-- 例子: %X[uuid] 支持在跨线程池时传递 -->
       <property scope="context" name="APP_PATTERN" value='%d[yyyy-MM-dd HH:mm:ss.SSS]|%X[uuid]|%level|%M|%C:%L|%thread|%replace(%msg)["(\r|\n)", ""]|"%ex{full}"%n'/>
   </configuration>
   

5. 验证配置: 启动你的应用程序，并检查日志输出，确保 MDC 信息在跨线程池时能够正确传递。

通过以上步骤，你就可以成功安装和配置 logback-mdc-ttl 项目，实现跨线程池的 MDC 跟踪功能。

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