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

admin 2025-09-14 阅读:51 评论:0
TLog概述 TLog提供了一种最简单的方式来解决日志追踪问题,它不收集日志,也不需要另外的存储空间,它只是自动的对你的日志进行打标签,自动生成TraceId贯穿你微服务的一整条链路。并且提供上下游节点信息。适合中小型企业以及想快速解决日志...

TLog概述

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

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

TLog特点

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

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

log4j一个日志被覆盖_Javaagent无侵入式接入_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端代码如下。

Javaagent无侵入式接入_log4j一个日志被覆盖_TLog日志追踪系统

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端代码如下。

Javaagent无侵入式接入_TLog日志追踪系统_log4j一个日志被覆盖

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

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

字节码注入方式

这种方式适合springboot项目,需要项目依赖

tlog-all-spring-boot-starter包, tlog提供springboot的自动装配功能。

依赖包如下。

log4j一个日志被覆盖_TLog日志追踪系统_Javaagent无侵入式接入

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

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

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

log4j一个日志被覆盖_Javaagent无侵入式接入_TLog日志追踪系统

日志框架适配器方式

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

依赖包如下。

log4j一个日志被覆盖_Javaagent无侵入式接入_TLog日志追踪系统

Log4j框架适配器

Log4j同步日志

TLog日志追踪系统_log4j一个日志被覆盖_Javaagent无侵入式接入

Log4j异步日志

log4j一个日志被覆盖_Javaagent无侵入式接入_TLog日志追踪系统

Logback框架适配器

Logback同步日志

log4j一个日志被覆盖_Javaagent无侵入式接入_TLog日志追踪系统

Logback异步日志

Javaagent无侵入式接入_TLog日志追踪系统_log4j一个日志被覆盖

Log4j2框架适配器

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

日志标签模板自定义

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

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

$preHost:上游微服务的Host Name

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

$spanId:链路spanId

$traceId:全局唯一跟踪ID

SpanId的生成规则

TLog默认的标签打印模板是

TLog 中的 SpanId 代表本次调用在整个调用链路树中的位置,假设一个 Web 系统 A 接收了一次用户请求,那么在这个系统的日志中whatsapp网页版,记录下的 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。根据上面的描述whatsapp网页版,我们可以知道,如果把一次调用中所有的 SpanId 收集起来,可以组成一棵完整的链路树。

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

Javaagent无侵入式接入_TLog日志追踪系统_log4j一个日志被覆盖

业务自定义标签

很多公司的系统在打日志的时候,每打一个日志里都会带入一些业务信息,比如记录ID,会员CODE,方便业务日志的定位。现在有了TLog,不仅能做分布式链路标签追加,还能自动帮你做业务标签的添加。这样在定位日志的时候可以更加方便的搜索。

Tlog支持方法级别的自定义业务标签。你可以在方法上定义简单的标注,来实现在某一个方法的日志里,统一加入业务的指标标签,用于更加细致的定位。

在你的方法上加上@TLogAspect标注。简单的例子如下:

TLog日志追踪系统_Javaagent无侵入式接入_log4j一个日志被覆盖

假设id的值为'NO1234',日志打出来的样子如下,其中前面为框架spanId+traceId

log4j一个日志被覆盖_TLog日志追踪系统_Javaagent无侵入式接入

@TLogAspect标注支持多个参数:

Javaagent无侵入式接入_log4j一个日志被覆盖_TLog日志追踪系统

假设传入id的值为'NO1234',name为'jenny',日志打出来的样子如下,其中前面为框架spanId+traceId:

Javaagent无侵入式接入_log4j一个日志被覆盖_TLog日志追踪系统

版权声明

本文仅代表作者观点,不代表百度立场。
本文系作者授权百度百家发表,未经许可,不得转载。

分享:

扫一扫在手机阅读、分享本文

3502文章数 0评论数
热门文章
  • 详细指南:WhatsApp国内使用方法全攻略-下载安装、注册登录及功能使用攻略

    详细指南:WhatsApp国内使用方法全攻略-下载安装、注册登录及功能使用攻略
    一、下载与安装WhatsApp WhatsApp是一款全球使用范围极广的即时通讯软件,不仅可以实现文本聊天,还能进行语音、视频通话WhatsApp中文版,发送文件等功能。由于众所周知的原因,国内用户想要下载和安装WhatsApp可能会遇到一些困难。不过,只要按照以下步骤操作,就能顺利完成WhatsApp的下载和安装。 首先,我们需要解决的是下载问题。由于WhatsApp在国内的应用商店无法直接下载,所以我们需要寻找其他的下载途径。Android用户可以选择到各大安卓市场搜索下...
  • 苹果IOS5.1.1机完美越狱

    苹果IOS5.1.1机完美越狱
    越狱工具下载:(需手动复制: http://bbs./read-htm-tid-4804612.html ) 详细的越狱教程: Absinthe 2.0.4的越狱方法与Absinthe 1.0的越狱方法完全一样,非常简单的“傻瓜一键式”。不过这里绿毒有说明,最好重新刷固件。支持越狱设备IOS5.1.1的固件下载地址请点击本站的IOS固件下载,看下图: 下载完固件之后,把设备连接iTunes,开始刷固件。你也可以选择不刷,但是在越狱的过程之中,新的系统在越狱时会比较的顺利,...
  • 电脑微信的聊天照片文件在哪里微信图片保存电脑哪个文件夹

    电脑微信的聊天照片文件在哪里微信图片保存电脑哪个文件夹
    1. 怎么找到微信聊天图片在哪个文件夹里 图片保存路径:/storage/emulated/tencent/MicroMsg/WeiXin/文件夹,这个是完整路径。而在文件夹中只需要找到/tencent/MicroMsg/WeiXinWhatsApp中文版,就可以了,前面两个文件夹是系统根目录。以下是保存及查找图片的方法步骤介绍。 第一步、找到桌面的微信APP,直接点击打开这个微信的APP。 2. 电脑微信图片保存在哪个文件夹 个人微信文件夹。 电脑版微信聊天的图片,都保存到...
  • Windows 11版WhatsApp将从UWP/Native切换回WebView2打包模式

    Windows 11版WhatsApp将从UWP/Native切换回WebView2打包模式
    Meta(最近更名为 Meta AI)悄然宣布,WhatsApp 将在 Windows 11 上放弃 UWP(WinUI)WhatsApp中文版,退回采用基于 Chromium 的容器。这意味着 WhatsApp 又回到了几年前的样子。由于 web.whatsapp.com 一直领先于 Windows 应用开发,它确实拥有一些新功能,但速度更慢,占用更多内存。 如果独立开发者因为无力维护所有平台的代码库而选择 Web 应用程序,那是一回事,但当像 Meta 这样价值万亿美元...
  • 小米下載WhatsApp的完整指南:安装与使用注意事项

    小米下載WhatsApp的完整指南:安装与使用注意事项
    综上所述,确保您的小米手机具备以上条件,将有助于您顺利下载和安装WhatsApp,享受便捷的通讯服务。在满足这些条件后,您就可以按照后续步骤进行WhatsApp的下载和安装。 2. 下载和安装WhatsApp的具体步骤 在小米手机上下载和安装WhatsApp的具体步骤相对简单,但需注意一些特殊情况。首先,确保你的手机系统已更新到最新版本,以保证最佳的兼容性。由于安卓手机商店内无法直接找到WhatsApp,你可以通过APKPure等第三方应用商店进行下载。打开APKPure应用...