轻量级日志追踪方案——TLog

黑洞代码

发布于 2021-03-19 18:01:25

3.1K0

发布于 2021-03-19 18:01:25

TLog概述

TLog提供了一种最简单的方式来解决日志追踪问题，它不收集日志，也不需要另外的存储空间，它只是自动的对你的日志进行打标签，自动生成TraceId贯穿你微服务的一整条链路。并且提供上下游节点信息。适合中小型企业以及想快速解决日志追踪问题的公司项目使用。

为此TLog适配了三大日志框架，支持自动检测适配。支持dubbo，dubbox，spring cloud三大RPC框架，更重要的是，你的项目接入TLog，可能连十分钟就不需要：）

TLog特点

目前TLog的支持的特性如下：

通过对日志打标签完成轻量级微服务日志追踪
提供三种接入方式：javaagent完全无侵入接入，字节码一行代码接入，基于配置文件的接入
对业务代码无侵入式设计，使用简单，10分钟即可接入
支持常见的log4j，log4j2，logback三大日志框架，并提供自动检测，完成适配
支持dubbo，dubbox，springcloud三大RPC框架
支持日志标签的自定义模板的配置，提供多个系统级埋点标签的选择
支持异步线程的追踪，包括线程池，多级异步线程等场景
几乎无性能损耗，快速稳定

TLog接入方式

自启动是指由main函数作为项目的启动入口(springboot项目的starter-web这种也属于自启动模式)

外置容器是指项目部署在类似tomcat容器中的，tomcat作为外容器，项目部署在webapp目录下的

javaagent本质上也是字节码注入方式，只不过是完全无侵入项目的方式。字节码在某些复杂的项目上由于类加载机制的不同，有可能会失效，所以你的项目结构如果很复杂，发现javaagent和字节码方式不起作用的话，那还是推荐日志框架适配器方式，这种相对最稳定。

Javaagent接入方式

这种方式完全不侵入项目，利用Javaagent在启动时加入jar包，整个过程1分钟就能搞定。不管你使用的RPC是dubbo/dubbox还是spring cloud，不管你使用的日志框架是log4j,log4j2还是logback，tlog-agent都能自动适配不过这种方式要求你的项目是springboot项目。

使用javaagent方式，只需要在你的java启动参数中加入：

最新的tlog-agent.jar可以在以下地址进行下载

https://gitee.com/dromara/TLog/releases/v1.2.4

只需要这一步，就可以把springboot项目快速接入了，这里以dubbo+log4j为例。Dubbo Consumer端代码如下。

2020-09-16 18:12:56,748 [WARN] [TLOG]重新生成traceId[7161457983341056]  >> com.yomahub.tlog.web.TLogWebInterceptor:39
2020-09-16 18:12:56,763 [INFO] <0><7161457983341056> logback-dubbox-consumer:invoke method sayHello,name=jack  >> com.yomahub.tlog.example.dubbox.controller.DemoController:22
2020-09-16 18:12:56,763 [INFO] <0><7161457983341056> 测试日志aaaa  >> com.yomahub.tlog.example.dubbox.controller.DemoController:23
2020-09-16 18:12:56,763 [INFO] <0><7161457983341056> 测试日志bbbb  >> com.yomahub.tlog.example.dubbox.controller.DemoController:24

Dubbo Provider端代码如下。

2020-09-16 18:12:56,854 [INFO] <0.1><7161457983341056> logback-dubbox-provider:invoke method sayHello,name=jack  >> com.yomahub.tlog.example.dubbo.service.impl.DemoServiceImpl:15
2020-09-16 18:12:56,854 [INFO] <0.1><7161457983341056> 测试日志cccc  >> com.yomahub.tlog.example.dubbo.service.impl.DemoServiceImpl:16
2020-09-16 18:12:56,854 [INFO] <0.1><7161457983341056> 测试日志dddd  >> com.yomahub.tlog.example.dubbo.service.impl.DemoServiceImpl:17

可以看到，经过简单接入后，各个微服务之间每个请求有一个全局唯一的traceId贯穿其中，对所有的日志输出都能生效，这下定位某个请求的日志链就变得轻松了。

字节码注入方式

这种方式适合springboot项目，需要项目依赖tlog-all-spring-boot-starter包， tlog提供springboot的自动装配功能。

依赖包如下。

只需要在你的启动类中加入一行代码，即可以自动进行探测你项目所使用的Log框架，并进行增强。

以下方法适用于log4j，logback，原则上log4j2连这一行都不需要，因为log4j2会插件架构设计，会自动读取TLog项目中log4j2的适配插件

以下方法对3大日志框架的异步日志形式也支持，请放心使用

日志框架适配器方式

如果字节码增强配置方式失败，或者你的项目比较复杂。TLog还提供了针对每一种日志框架适配的方式，需要你去修改日志的配置文件，替换相应的类，配置方式也很简单，下面给出了每一种场景的示例

依赖包如下。

Log4j框架适配器

Log4j同步日志

Log4j异步日志

Logback框架适配器

Logback同步日志

Logback异步日志

Log4j2框架适配器

log4J2由于是通过插件形式实现的，log4J2有自动扫描插件的功能。所以无需对配置文件做任何更改就能生效。

日志标签模板自定义

你只需要在springboot的application.properties里如下定义：

$preApp：上游微服务节点名称

$preHost：上游微服务的Host Name

$preIp：上游微服务的IP地址

$spanId：链路spanId

$traceId：全局唯一跟踪ID

SpanId的生成规则

TLog默认的标签打印模板是<traceId：全局唯一跟踪ID¨K12KTLog默认的标签打印模板是<spanId><$traceId>

TLog 中的 SpanId 代表本次调用在整个调用链路树中的位置，假设一个 Web 系统 A 接收了一次用户请求，那么在这个系统的日志中，记录下的 SpanId 是 0，代表是整个调用的根节点，如果 A 系统处理这次请求，需要通过 RPC 依次调用 B，C，D 三个系统，那么在 A 系统的客户端日志中，SpanId 分别是 0.1，0.2 和 0.3，在 B，C，D 三个系统的服务端日志中，SpanId 也分别是 0.1，0.2 和 0.3；如果 C 系统在处理请求的时候又调用了 E，F 两个系统，那么 C 系统中对应的客户端日志是 0.2.1 和 0.2.2，E，F 两个系统对应的服务端日志也是 0.2.1 和 0.2.2。根据上面的描述，我们可以知道，如果把一次调用中所有的 SpanId 收集起来，可以组成一棵完整的链路树。

我们假设一次分布式调用中产生的 TraceId 是 0a1234（实际不会这么短），那么根据上文 SpanId 的产生过程，有下图：