推薦一個(gè)輕量級(jí)的分布式日志標(biāo)記追蹤神器！

TLog能解決什么痛點(diǎn)

隨著微服務(wù)盛行，很多公司都把系統(tǒng)按照業(yè)務(wù)邊界拆成了很多微服務(wù)，在排錯(cuò)查日志的時(shí)候。因?yàn)闃I(yè)務(wù)鏈路貫穿著很多微服務(wù)節(jié)點(diǎn)，導(dǎo)致定位某個(gè)請(qǐng)求的日志以及上下游業(yè)務(wù)的日志會(huì)變得有些困難。

這時(shí)候很多童鞋會(huì)開(kāi)始考慮上SkyWalking，Pinpoint等分布式追蹤系統(tǒng)來(lái)解決，基于OpenTracing規(guī)范，而且通常都是無(wú)侵入性的，并且有相對(duì)友好的管理界面來(lái)進(jìn)行鏈路Span的查詢。

但是搭建分布式追蹤系統(tǒng)，熟悉以及推廣到全公司的系統(tǒng)需要一定的時(shí)間周期，而且當(dāng)中涉及到鏈路span節(jié)點(diǎn)的存儲(chǔ)成本問(wèn)題，全量采集還是部分采集？如果全量采集，就以SkyWalking的存儲(chǔ)來(lái)舉例，ES集群搭建至少需要5個(gè)節(jié)點(diǎn)。這就需要增加服務(wù)器成本。況且如果微服務(wù)節(jié)點(diǎn)多的話，一天下來(lái)產(chǎn)生幾十G上百G的數(shù)據(jù)其實(shí)非常正常。如果想保存時(shí)間長(zhǎng)點(diǎn)的話，也需要增加服務(wù)器磁盤的成本。

當(dāng)然分布式追蹤系統(tǒng)是一個(gè)最終的解決方案，如果您的公司已經(jīng)上了分布式追蹤系統(tǒng)，那TLog并不適用。

TLog提供了一種最簡(jiǎn)單的方式來(lái)解決日志追蹤問(wèn)題，它不收集日志，也不需要另外的存儲(chǔ)空間，它只是自動(dòng)的對(duì)你的日志進(jìn)行打標(biāo)簽，自動(dòng)生成TraceId貫穿你微服務(wù)的一整條鏈路。并且提供上下游節(jié)點(diǎn)信息。適合中小型企業(yè)以及想快速解決日志追蹤問(wèn)題的公司項(xiàng)目使用。

為此我為了TLog適配了三大日志框架，支持自動(dòng)檢測(cè)適配。支持dubbo，dubbox，spring cloud三大RPC框架，更重要的是，你的項(xiàng)目接入TLog，可能連十分鐘就不需要 ：）

項(xiàng)目特性

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

• 通過(guò)對(duì)日志打標(biāo)簽完成輕量級(jí)微服務(wù)日志追蹤

• 對(duì)業(yè)務(wù)代碼無(wú)侵入式設(shè)計(jì)，使用簡(jiǎn)單，10分鐘即可接入

• 支持常見(jiàn)的log4j，log4j2，logback三大日志框架，并提供自動(dòng)檢測(cè)，完成適配

• 支持dubbo，dubbox，springcloud三大RPC框架

• 支持日志標(biāo)簽的自定義模板的配置，提供多個(gè)系統(tǒng)級(jí)埋點(diǎn)標(biāo)簽的選擇

• 提供spanId來(lái)表示本次調(diào)用在整個(gè)調(diào)用鏈路樹中的位置

• 支持方法級(jí)別的標(biāo)簽自定義埋入

• 天然支持異步線程的追蹤

• 幾乎無(wú)性能損耗

讓我們開(kāi)始吧！

快速開(kāi)始

TLog支持了springboot的自動(dòng)裝配，在springboot環(huán)境下，只需要以下兩步就可以接入！

依賴

<dependency>
??<groupId>com.yomahubgroupId>
??<artifactId>tlog-all-spring-boot-starterartifactId>
??<version>1.1.0version>
dependency>

目前jar包已上傳中央倉(cāng)庫(kù)，可以直接依賴到

日志框架適配

只需要在你的啟動(dòng)類中加入一行代碼，即可以自動(dòng)進(jìn)行探測(cè)你項(xiàng)目所使用的Log框架，并進(jìn)行增強(qiáng)。

@SpringBootApplication
public?class?Runner?{

????static?{AspectLogEnhance.enhance();}//進(jìn)行日志增強(qiáng)，自動(dòng)判斷日志框架

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

因?yàn)檫@里是用javassist實(shí)現(xiàn)，需要在jvm加載對(duì)應(yīng)日志框架的類之前，進(jìn)行字節(jié)碼增強(qiáng)。所以這里用static塊。并且Springboot/Spring的啟動(dòng)類中不能加入log定義，否則會(huì)不生效。

RPC框架的適配

在Springboot環(huán)境下，TLog會(huì)自動(dòng)探測(cè)你用的RPC框架，自動(dòng)進(jìn)行適配。

最終效果

只需要以上這2步，就可以把springboot項(xiàng)目快速接入了

這里以dubbo+log4j為例，Consumer端代碼

日志打?。?/p>

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]?<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]?<7161457983341056>?測(cè)試日志aaaa??>>?com.yomahub.tlog.example.dubbox.controller.DemoController:23
2020-09-16?18:12:56,763?[INFO]?<7161457983341056>?測(cè)試日志bbbb??>>?com.yomahub.tlog.example.dubbox.controller.DemoController:24

Provider代碼：

日志打?。?/p>

2020-09-16?18:12:56,854?[INFO]?<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]?<7161457983341056>?測(cè)試日志cccc??>>?com.yomahub.tlog.example.dubbo.service.impl.DemoServiceImpl:16
2020-09-16?18:12:56,854?[INFO]?<7161457983341056>?測(cè)試日志dddd??>>?com.yomahub.tlog.example.dubbo.service.impl.DemoServiceImpl:17

可以看到，經(jīng)過(guò)簡(jiǎn)單接入后，各個(gè)微服務(wù)之間每個(gè)請(qǐng)求有一個(gè)全局唯一的traceId貫穿其中，對(duì)所有的日志輸出都能生效，這下定位某個(gè)請(qǐng)求的日志鏈就變得輕松了。

項(xiàng)目地址

官網(wǎng)地址：http://bryan31.gitee.io/tlog