TLog 开源项目使用教程

TLog 开源项目使用教程

TLog项目地址:https://gitcode.com/gh_mirrors/tlog/TLog

1. 项目的目录结构及介绍

TLog 项目的目录结构如下：

TLog/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/
│   │   │       └── yomahub/
│   │   │           └── tlog/
│   │   │               ├── agent/
│   │   │               ├── annotation/
│   │   │               ├── aspect/
│   │   │               ├── constant/
│   │   │               ├── context/
│   │   │               ├── enhancer/
│   │   │               ├── filter/
│   │   │               ├── interceptor/
│   │   │               ├── model/
│   │   │               ├── parser/
│   │   │               ├── span/
│   │   │               ├── tag/
│   │   │               ├── template/
│   │   │               └── util/
│   │   └── resources/
│   │       ├── META-INF/
│   │       └── logback.xml
│   └── test/
│       └── java/
│           └── com/
│               └── yomahub/
│                   └── tlog/
│                       └── example/
├── .gitignore
├── LICENSE
├── README.md
├── pom.xml
└── tlog-agent.jar

目录结构介绍

• src/main/java/com/yomahub/tlog/：包含 TLog 项目的核心代码，分为多个子模块，如 agent、annotation、aspect 等。
• src/main/resources/：包含项目的配置文件，如 logback.xml。
• src/test/java/com/yomahub/tlog/example/：包含项目的测试代码示例。
• .gitignore：Git 忽略文件配置。
• LICENSE：项目许可证文件。
• README.md：项目说明文档。
• pom.xml：Maven 项目配置文件。
• tlog-agent.jar：TLog 代理 JAR 文件。

2. 项目的启动文件介绍

TLog 项目的启动文件主要是 tlog-agent.jar，它是一个 Java 代理 JAR 文件，用于在项目启动时自动注入 TLog 功能。

启动文件介绍

• tlog-agent.jar：这是一个 Java 代理 JAR 文件，通过在启动时加入 JVM 参数来实现无侵入式的日志追踪功能。

使用方法：

在启动项目的 JVM 参数中加入以下内容：

-javaagent:/path/to/tlog-agent.jar

3. 项目的配置文件介绍

TLog 项目的配置文件主要位于 src/main/resources/ 目录下，包括 logback.xml 等。

配置文件介绍

• logback.xml：这是 Logback 日志框架的配置文件，用于配置日志的输出格式、级别、目标等。

示例 logback.xml 配置：

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

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

其他配置

TLog 还支持通过 Spring Boot 的 application.properties 文件进行配置，例如：

tlog.traceId.name=traceId
tlog.spanId.name=spanId

以上是 TLog 开源项目的目录结构、启动文件和配置文件的介绍。希望这份教程能帮助你更好地理解和使用 TLog 项目。

TLog项目地址:https://gitcode.com/gh_mirrors/tlog/TLog