百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 编程网 > 正文

轻量级日志追踪方案——TLog_日志追踪系统

yuyutoo 2025-02-19 14:27 7 浏览 0 评论

TLog概述

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

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

TLog特点

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

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

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>

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 的产生过程,有下图:

业务自定义标签

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


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


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

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

@TLogAspect标注支持多个参数:

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

相关推荐

墨尔本一华裔男子与亚裔男子分别失踪数日 警方寻人

中新网5月15日电据澳洲新快网报道,据澳大利亚维州警察局网站消息,22岁的华裔男子邓跃(Yue‘Peter’Deng,音译)失踪已6天,维州警方于当地时间13日发布寻人通告,寻求公众协助寻找邓跃。华...

网络交友须谨慎!美国犹他州一男子因涉嫌杀害女网友被捕

伊森·洪克斯克(图源网络,侵删)据美国广播公司(ABC)25日报道,美国犹他州一名男子于24日因涉嫌谋杀被捕。警方表示,这名男子主动告知警局,称其杀害了一名在网络交友软件上认识的25岁女子。雷顿警...

一课译词:来龙去脉(来龙去脉 的意思解释)

Mountainranges[Photo/SIPA]“来龙去脉”,汉语成语,本指山脉的走势和去向,现比喻一件事的前因后果(causeandeffectofanevent),可以翻译为“i...

高考重要考点:range(range高考用法)

range可以用作动词,也可以用作名词,含义特别多,在阅读理解中出现的频率很高,还经常作为完形填空的选项,而且在作文中使用是非常好的高级词汇。...

C++20 Ranges:现代范围操作(现代c++白皮书)

1.引言:C++20Ranges库简介C++20引入的Ranges库是C++标准库的重要更新,旨在提供更现代化、表达力更强的方式来处理数据序列(范围,range)。Ranges库基于...

学习VBA,报表做到飞 第二章 数组 2.4 Filter函数

第二章数组2.4Filter函数Filter函数功能与autofilter函数类似,它对一个一维数组进行筛选,返回一个从0开始的数组。...

VBA学习笔记:数组:数组相关函数—Split,Join

Split拆分字符串函数,语法Split(expression,字符,Limit,compare),第1参数为必写,后面3个参数都是可选项。Expression为需要拆分的数据,“字符”就是以哪个字...

VBA如何自定义序列,学会这些方法,让你工作更轻松

No.1在Excel中,自定义序列是一种快速填表机制,如何有效地利用这个方法,可以大大增加工作效率。通常在操作工作表的时候,可能会输入一些很有序的序列,如果一一录入就显得十分笨拙。Excel给出了一种...

Excel VBA入门教程1.3 数组基础(vba数组详解)

1.3数组使用数组和对象时,也要声明,这里说下数组的声明:'确定范围的数组,可以存储b-a+1个数,a、b为整数Dim数组名称(aTob)As数据类型Dimarr...

远程网络调试工具百宝箱-MobaXterm

MobaXterm是一个功能强大的远程网络工具百宝箱,它将所有重要的远程网络工具(SSH、Telnet、X11、RDP、VNC、FTP、MOSH、Serial等)和Unix命令(bash、ls、cat...

AREX:携程新一代自动化回归测试工具的设计与实现

一、背景随着携程机票BU业务规模的不断提高,业务系统日趋复杂,各种问题和挑战也随之而来。对于研发测试团队,面临着各种效能困境,包括业务复杂度高、数据构造工作量大、回归测试全量回归、沟通成本高、测试用例...

Windows、Android、IOS、Web自动化工具选择策略

Windows平台中应用UI自动化测试解决方案AutoIT是开源工具,该工具识别windows的标准控件效果不错,但是当它遇到应用中非标准控件定义的UI元素时往往就无能为力了,这个时候选择silkte...

python自动化工具:pywinauto(python快速上手 自动化)

简介Pywinauto是完全由Python构建的一个模块,可以用于自动化Windows上的GUI应用程序。同时,它支持鼠标、键盘操作,在元素控件树较复杂的界面,可以辅助我们完成自动化操作。我在...

时下最火的 Airtest 如何测试手机 APP?

引言Airtest是网易出品的一款基于图像识别的自动化测试工具,主要应用在手机APP和游戏的测试。一旦使用了这个工具进行APP的自动化,你就会发现自动化测试原来是如此简单!!连接手机要进行...

【推荐】7个最强Appium替代工具,移动App自动化测试必备!

在移动应用开发日益火爆的今天,自动化测试成为了确保应用质量和用户体验的关键环节。Appium作为一款广泛应用的移动应用自动化测试工具,为测试人员所熟知。然而,在不同的测试场景和需求下,还有许多其他优...

取消回复欢迎 发表评论: