# TLog
**Repository Path**: dromara/TLog
## Basic Information
- **Project Name**: TLog
- **Description**: 一个轻量级的分布式日志标记追踪神器,10分钟即可接入,自动对日志打标签完成微服务的链路追踪
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://tlog.yomahub.com
- **GVP Project**: Yes
## Statistics
- **Stars**: 3425
- **Forks**: 784
- **Created**: 2020-08-01
- **Last Updated**: 2026-11-17
## Categories & Tags
**Categories**: logging
**Tags**: 日志, 链路追踪
## README
Your star is my motivation to keep going, please help with a star in the top right corner if you like it
## Overview
TLog is a lightweight distributed log tagging tracker, accessible in 10 minutes, automatically tags logs to complete microservice link tracking. Support log4j, log4j2, logback three logging framework, support dubbo, dubbox, springcloud three RPC framework
## Project home page please click: [project home page](https://tlog.yomahub.com/)
## Project documentation please click: [project documentation](https://tlog.yomahub.com/pages/5b7bd2/)
## Sample project please click: [sample project](https://gitee.com/bryan31/tlog-example)
## TLog 2.0
The same starter coordinates support Spring Boot 2, 3 and 4. TLog artifacts target Java 8; building the source requires JDK 17 or newer. See the [compatibility tests](compatibility-tests/README.md) for the tested runtime combinations.
Version 2.0 uses logging configuration. The javaagent and `AspectLogEnhance.enhance()` integration methods have been removed. Read the [upgrade guide](docs/TLOG_2.0_UPGRADE.md) before migrating from 1.x.
## Features
* Log labels and MDC for logback, log4j and log4j2, with custom patterns and trace ID generators.
* Automatic javax/jakarta Servlet selection, including Callable and ASYNC/ERROR redispatch.
* Context and MDC propagation for Spring-managed executors, composing existing task decorators; `TLogExecutors.wrap` for other executors.
* Automatic instrumentation of managed RestTemplate, WebClient.Builder and RestClient.Builder (Spring 6.1+).
* Dubbo, Dubbox, Feign, HttpClient 4/5, OkHttp, Hutool HTTP and Forest adapters.
* Reactor Context isolation for WebFlux, Spring Cloud Gateway, Soul and Shenyu, restoring log context during Reactor callbacks.
* JDK TimerTask, Quartz, Spring Scheduled, XXL-JOB.
* Kafka and RabbitMQ propagate the context in message headers: auto-configured for Spring Kafka / Spring AMQP (`tlog.kafka.enabled`, `tlog.rabbitmq.enabled`), one line for the plain clients. Other brokers can keep wrapping the payload with `TLogMqWrapBean`.
* Inbound W3C trace ID reuse, independent feature switches and IDE configuration metadata.
## Getting started
Add `com.yomahub:tlog-web-spring-boot-starter:2.0.0` alongside your application's Spring Boot Web or WebFlux starter. Include `%X{tl}` in the logging pattern, or use a TLog encoder/layout/converter.
See the [upgrade guide](docs/TLOG_2.0_UPGRADE.md) for configuration and asynchronous boundaries, and [release validation](docs/TLOG_2.0_RELEASE.md) for verification commands.
Since the community group is over 200 people, you need to invite to join the group. Follow the public number and click `Personal WeChat` to add me, I can pull you into the group

## Sponsors
**Easysearch**
Open source is not easy, please sponsor TLog if you support it
