TLog 开源项目使用教程

TLog 开源项目使用教程

1. 项目介绍

TLog 是一个轻量级的分布式日志标记追踪工具，旨在帮助开发者在微服务架构中快速定位和追踪日志。TLog 通过自动对日志进行打标签，生成 TraceId 贯穿整个微服务链路，并提供上下游节点信息，适合中小型企业以及希望快速解决日志追踪问题的公司项目使用。

TLog 支持多种日志框架（如 log4j、log4j2、logback）和主流的 RPC 框架（如 dubbo、dubbox、spring cloud），并且提供了多种接入方式，包括 Javaagent 完全无侵入接入、字节码一行代码接入以及基于配置文件的接入。

2. 项目快速启动

2.1 环境准备

• JDK 1.8 或更高版本
• Maven 3.x
• 支持的日志框架（log4j、log4j2、logback）
• 支持的 RPC 框架（dubbo、dubbox、spring cloud）

2.2 添加依赖

在你的 Maven 项目中，添加 TLog 的依赖：

<dependency>
    <groupId>com.tlog</groupId>
    <artifactId>tlog-core</artifactId>
    <version>1.0.0</version>
</dependency>

2.3 配置 TLog

在你的 Spring Boot 项目中，创建一个配置类来启用 TLog：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import com.tlog.core.TLogConfig;

@Configuration
public class TLogConfiguration {

    @Bean
    public TLogConfig tLogConfig() {
        return new TLogConfig();
    }
}

2.4 启动项目

在启动类上添加 @EnableTLog 注解：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import com.tlog.core.annotation.EnableTLog;

@SpringBootApplication
@EnableTLog
public class Application {

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

2.5 查看日志

启动项目后，TLog 会自动对日志进行打标签，生成的日志中会包含 TraceId 和 SpanId，方便你进行日志追踪。

3. 应用案例和最佳实践

3.1 微服务日志追踪

在微服务架构中，日志分散在各个服务中，TLog 可以帮助你将这些日志串联起来，形成完整的调用链路。通过 TraceId，你可以轻松追踪一个请求在多个服务中的流转情况。

3.2 业务自定义标签

TLog 支持方法级别的自定义业务标签，你可以在方法上使用 @TLogAspect 注解，为日志添加业务相关的标签，方便后续的日志分析和定位。

import com.tlog.core.annotation.TLogAspect;

@TLogAspect(tags = {"orderId", "userId"})
public void processOrder(String orderId, String userId) {
    // 业务逻辑
}

3.3 异步线程追踪

在异步线程中，TLog 也能保持日志的连续性，确保在多级异步线程中也能正确追踪日志。

4. 典型生态项目

4.1 Spring Cloud

TLog 与 Spring Cloud 无缝集成，支持 Spring Cloud 中的服务调用链路追踪，帮助开发者快速定位微服务中的问题。

4.2 Dubbo

对于使用 Dubbo 作为 RPC 框架的项目，TLog 提供了对 Dubbo 的适配，能够自动追踪 Dubbo 服务调用链路。

4.3 Log4j2

TLog 支持 Log4j2 日志框架，能够在 Log4j2 的日志中自动添加 TraceId 和 SpanId，方便日志的追踪和分析。

通过以上步骤，你可以快速接入 TLog，并在微服务架构中实现高效的日志追踪。