前言
隨著微服務盛行，很多公司都把系統按照業務邊界拆成了很多微服務，在排隊查日誌的時候。因為業務鏈路貫穿著很多微服務節點，導致定位某個請求的日誌以及上下游業務的日誌會變得有些困難。
這時候很多童鞋會開始考慮上SkyWalking，Pinpoint等分佈式追蹤系統來解決，基於OpenTracing規範，而且通常都是無侵入性的，並且有相對友好的管理界面來進行鏈路Span的查詢。
但是搭建分佈式追蹤系統，熟悉以及推廣到全公司的系統需要一定的時間週期，而且當中涉及到鏈路span節點的存儲成本問題，全量採集還是部分採集？如果全量採集，就以SkyWalking的存儲來舉例，ES集群搭建至少需要5個節點。這就需要增加服務器成本。況且如果微服務節點多的話，一天下來產生幾十G上百G的數據其實非常正常。如果想保存時間長點的話，也需要增加服務器磁盤的成本。
所以這次介紹的開源項目是TLog，它的產生背景源於想做一個輕量級的日誌追蹤解決方案，覆蓋目前流行的日誌框架和RPC框架，讓用戶以最少的成本來接入以解決微服務體系中日誌跟蹤的痛點。
當然分佈式追蹤系統是一個最終的解決方案，如果您的公司已經上了分佈式追蹤系統，那TLog並不適用。
TLog提供了一種最簡單的方式來解決日誌追蹤問題，它不收集日誌，也不需要另外的存儲空間，它只是自動的對你的業務日誌進行打標籤，自動生成TraceId貫穿你微服務的一整條鏈路。並且提供上下游節點信息。適合中小型企業以及想快速解決日誌追蹤問題的公司項目使用。
為此我為了TLog適配了三大日誌框架，支持自動檢測適配。支持dubbo，dubbox，spring cloud三大RPC框架，更重要的是，你的項目接入TLog，可能連十分鐘就不需要 ：）
TLog項目以及特性
項目地址：gitee.com/bryan31/TLo…
TLog具有以下特性：
- 通過對日誌打標籤完成輕量級微服務日誌追蹤
- 對業務代碼無侵入式設計，使用簡單，10分鐘即可接入
- 支持常見的log4j，log4j2，logback三大日誌框架，並提供自動檢測，完成適配
- 支持dubbo，dubbox，springcloud三大RPC框架
- 支持日誌標籤的自定義模板的配置
- 幾乎無性能損耗
如何快速接入
TLog支持了springboot的自動裝配，在springboot環境下，只需要以下兩步就可以接入！
依賴
<code><
dependency
><
groupId
> com.yomahubgroupId
><
artifactId
>tlog-all-spring-boot-starterartifactId
><
version
>1.0.0version
>dependency
> 複製代碼/<code>
目前jar包已上傳中央倉庫，可以直接依賴到
日誌框架適配
只需要在你的啟動類中加入一行代碼，即可以自動進行探測你項目所使用的Log框架，並進行增強，目前支持log4j，log4j2，logback三大日誌框架。
<code>public
class
Runner
{static
{AspectLogEnhance.enhance();}public
static
void
main
(String[] args)
{ SpringApplication.run(Runner.
class
,args
); } } 複製代碼/<code>
需要注意的是，因為這裡是用javassit實現，需要在jvm加載對應日誌框架的類之前，進行字節碼增強。所以這裡用static塊。但是在以下2種情況下這種一行自動適配的可能不會生效：
1.Springboot/Spring的啟動類加入log定義，這種情況不會生效，因為classload在加載static塊之前已經把log日誌框架加載了。
2.你是用tomcat/jboss/jetty等外置容器啟動的（對於springboot內置容器無影響）
對於這2種情況，TLog也提供了3大日誌框架的單獨適配，只要替換日誌配置文件中的相應layout類就可以了，下文也會介紹到
RPC框架的適配
在Springboot環境下，TLog會自動探測你用的RPC框架，自動進行適配。
做完以上2步，就ok了，最終效果如下（這裡以dubbo+log4j為例）：
Consumer端代碼：
日誌打印：
<code>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>
測試日誌aaaa
>>
com.yomahub.tlog.example.dubbox.controller.DemoController:23
2020
-09
-16
18
:12:56,763
[INFO]
<7161457983341056>
測試日誌bbbb
>>
com.yomahub.tlog.example.dubbox.controller.DemoController:24
複製代碼
/<code>
Provider代碼：
日誌打印：
<code>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>
測試日誌cccc
>>
com.yomahub.tlog.example.dubbo.service.impl.DemoServiceImpl:16
2020
-09
-16
18
:12:56,854
[INFO]
<7161457983341056>
測試日誌dddd
>>
com.yomahub.tlog.example.dubbo.service.impl.DemoServiceImpl:17
複製代碼
/<code>
可以看到，經過簡單接入後，各個微服務之間每個請求有一個全局唯一的traceId貫穿其中，對所有的日誌輸出都能生效，這下定位某個請求的日誌鏈就變得輕鬆了。
改變日誌標籤的格式
TLog允許用戶自定義日誌標籤的格式，TLog默認只打出traceId，以這種模板打出，當然你能自定義其模板。還能加入其它的標籤頭
你只需要在springboot的application.properties裡如下定義，改變標籤的格式，就能按照你定義模板進行打印
<code>tlog.pattern=[$preApp
][$preIp
][$traceId
] 複製代碼/<code>
$preApp ：上游微服務節點名稱
$preIp：上游微服務的IP地址
$traceId：全局唯一跟蹤ID
Log框架的單獨適配
如果你的自動化日誌探測失效或者你用的是外置容器，你需要針對你項目中的日誌框架配置進行修改，修改方法也很簡單。
Log4j配置文件增強
只需要把layout的實現類換掉就可以了
每個公司的Log4J的模板大同小異，這裡只給出xml的例子
<code> :configuration ><
log4j:configuration
><
appender
name
="stdout"
class
="org.apache.log4j.ConsoleAppender"
><
layout
class
="com.yomahub.tlog.core.enhance.log4j.AspectLog4jPatternLayout"
><
param
name
="ConversionPattern"
value
="%d{yyyy-MM-dd HH:mm:ss,SSS} [%p] %m >> %c:%L%n"
/>layout
>appender
><
appender
name
="fileout"
class
="org.apache.log4j.DailyRollingFileAppender"
><
param
name
="File"
value
="./logs/test.log"
/><
layout
class
="com.yomahub.tlog.core.enhance.log4j.AspectLog4jPatternLayout"
><
param
name
="ConversionPattern"
value
="%d{yyyy-MM-dd HH:mm:ss,SSS} [%p] %m >> %c:%L%n"
/>layout
>appender
><
root
><
priority
value
="info"
/><
appender-ref
ref
="stdout"
/><
appender-ref
ref
="fileout"
/>root
>log4j:configuration
> 複製代碼/<code>
Logback的配置文件增強
換掉encoder的實現類或者換掉layout的實現類就可以了
以下給出xml示例：
<code><
configuration
debug
="false"
><
property
name
="APP_NAME"
value
="logtest"
/><
property
name
="LOG_HOME"
value
="./logs"
/><
appender
name
="STDOUT"
class
="ch.qos.logback.core.ConsoleAppender"
><
encoder
class
="com.yomahub.tlog.core.enhance.logback.AspectLogbackEncoder"
><
pattern
>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%npattern
>encoder
>appender
><
appender
name
="FILE"
class
="ch.qos.logback.core.rolling.RollingFileAppender"
><
File
>${LOG_HOME}/${APP_NAME}.logFile
><
rollingPolicy
class
="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy"
><
FileNamePattern
>${LOG_HOME}/${APP_NAME}.log.%d{yyyy-MM-dd}.%i.logFileNamePattern
><
MaxHistory
>30MaxHistory
><
maxFileSize
>1000MBmaxFileSize
>rollingPolicy
><
encoder
class
="com.yomahub.tlog.core.enhance.logback.AspectLogbackEncoder"
><
pattern
>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%npattern
>encoder
>appender
><
root
level
="INFO"
><
appender-ref
ref
="STDOUT"
/><
appender-ref
ref
="FILE"
/>root
>configuration
> 複製代碼/<code>
Log4j2的配置文件增強
log4J2由於是通過插件形式實現的，log4J2有自動掃描插件的功能。所以無需對配置文件做任何更改就能生效。
後語
TLog本質上是一個日誌框架，只不過具有了支持RPC框架的日誌追蹤功能。寫框架大概肝了我一週的時間，力求做到一個最輕量級的日誌追蹤解決方案，讓使用者能以最少的成本接入。TLog不光支持springboot，對非springboot項目也進行了支持，具體配置方法請到項目主頁查看文檔。
我還為TLog寫了詳細的示例項目，涵蓋了所涉及幾乎所有場景，具體示例項目地址也在項目主頁。
如果你在項目中也碰到日誌追蹤困難的場景，不妨來試試TLog吧，希望這款開源框架能幫助到你，開源不易，如你喜歡，請幫忙star。如你碰到任何疑問，也歡迎聯繫我。
