輕量級的分散式日誌追蹤利器，十分鐘即可接入，從此日誌追蹤無難事
阿新 • • 發佈：2020-09-17
## 前言
隨著微服務盛行，很多公司都把系統按照業務邊界拆成了很多微服務，在排錯查日誌的時候。因為業務鏈路貫穿著很多微服務節點，導致定位某個請求的日誌以及上下游業務的日誌會變得有些困難。
這時候很多童鞋會開始考慮上SkyWalking，Pinpoint等分散式追蹤系統來解決，基於OpenTracing規範，而且通常都是無侵入性的，並且有相對友好的管理介面來進行鏈路Span的查詢。
但是搭建分散式追蹤系統，熟悉以及推廣到全公司的系統需要一定的時間週期，而且當中涉及到鏈路span節點的儲存成本問題，全量採集還是部分採集？如果全量採集，就以SkyWalking的儲存來舉例，ES叢集搭建至少需要5個節點。這就需要增加伺服器成本。況且如果微服務節點多的話，一天下來產生幾十G上百G的資料其實非常正常。如果想儲存時間長點的話，也需要增加伺服器磁碟的成本。
**所以這次介紹的開源專案是TLog，它的產生背景源於想做一個輕量級的日誌追蹤解決方案，覆蓋目前流行的日誌框架和RPC框架，讓使用者以最少的成本來接入以解決微服務體系中日誌跟蹤的痛點。**
當然分散式追蹤系統是一個最終的解決方案，如果您的公司已經上了分散式追蹤系統，那TLog並不適用。
**TLog提供了一種最簡單的方式來解決日誌追蹤問題，它不收集日誌，也不需要另外的儲存空間，它只是自動的對你的業務日誌進行打標籤，自動生成TraceId貫穿你微服務的一整條鏈路。並且提供上下游節點資訊。適合中小型企業以及想快速解決日誌追蹤問題的公司專案使用。**
**為此我為了TLog適配了三大日誌框架，支援自動檢測適配。支援dubbo，dubbox，spring cloud三大RPC框架，更重要的是，你的專案接入TLog，可能連十分鐘就不需要 ：）**
## TLog專案以及特性
> **專案地址：https://gitee.com/bryan31/TLog**
TLog具有以下特性：
* 通過對日誌打標籤完成輕量級微服務日誌追蹤
* 對業務程式碼無侵入式設計，使用簡單，10分鐘即可接入
* 支援常見的log4j，log4j2，logback三大日誌框架，並提供自動檢測，完成適配
* 支援dubbo，dubbox，springcloud三大RPC框架
* 支援日誌標籤的自定義模板的配置
* 幾乎無效能損耗
## 如何快速接入
TLog支援了springboot的自動裝配，在springboot環境下，只需要以下兩步就可以接入！
**依賴**
```xml
```
目前jar包已上傳中央倉庫，可以直接依賴到
**日誌框架適配**
只需要在你的啟動類中加入一行程式碼，即可以自動進行探測你專案所使用的Log框架，並進行增強，目前支援log4j，log4j2，logback三大日誌框架。
```java
@SpringBootApplication
public class Runner {
static {AspectLogEnhance.enhance();}//進行日誌增強，自動判斷日誌框架
public static void main(String[] args) {
SpringApplication.run(Runner.class, args);
}
}
```
需要注意的是，因為這裡是用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端程式碼：
日誌列印：
```
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
```
Provider程式碼：
日誌列印：
```
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
```
可以看到，經過簡單接入後，各個微服務之間每個請求有一個全域性唯一的traceId貫穿其中，對所有的日誌輸出都能生效，這下定位某個請求的日誌鏈就變得輕鬆了。
## 改變日誌標籤的格式
TLog允許使用者自定義日誌標籤的格式，TLog預設只打出traceId，以<$traceId>這種模板打出，當然你能自定義其模板。還能加入其它的標籤頭
你只需要在springboot的application.properties裡如下定義，改變標籤的格式，就能按照你定義模板進行列印
```properties
tlog.pattern=[$preApp][$preIp][$traceId]
```
`$preApp` ：上游微服務節點名稱
`$preIp`：上游微服務的IP地址
`$traceId`：全域性唯一跟蹤ID
## Log框架的單獨適配
如果你的自動化日誌探測失效或者你用的是外接容器，你需要針對你專案中的日誌框架配置進行修改，修改方法也很簡單。
**Log4j配置檔案增強**
只需要把`layout`的實現類換掉就可以了
每個公司的Log4J的模板大同小異，這裡只給出xml的例子
```xml
```
**Logback的配置檔案增強**
換掉`encoder`的實現類或者換掉`layout`的實現類就可以了
以下給出xml示例：
```xml
```
**Log4j2的配置檔案增強**
log4J2由於是通過外掛形式實現的，log4J2有自動掃描外掛的功能。所以無需對配置檔案做任何更改就能生效。
## 後語
TLog本質上是一個日誌框架，只不過具有了支援RPC框架的日誌追蹤功能。寫框架大概肝了我一週的時間，力求做到一個最輕量級的日誌追蹤解決方案，讓使用者能以最少的成本接入。TLog不光支援springboot，對非springboot專案也進行了支援，具體配置方法請到專案主頁檢視文件。
我還為TLog寫了詳細的示例專案，涵蓋了所涉及幾乎所有場景，具體示例專案地址也在專案主頁。
如果你在專案中也碰到日誌追蹤困難的場景，不妨來試試TLog吧，希望這款開源框架能幫助到你，開源不易，如你喜歡，請幫忙star，你的支援是我前進的最大動力。如你碰到任何疑問，也歡迎聯絡我。
## 關注作者
「元人部落」是一個堅持做原創的技術科技分享號，希望你能關注我，我每週會出一篇實用的原創技術文章，陪著你一起走，陪你一起成長。關注公眾號回覆`tlog`能加入群聊，我會耐心回答你的每一個使用中的問題，也會長期對這個專案進行長期維護和迭代。
![img](https://img2020.cnblogs.com/other/268224/202009/268224-20200917103948828-658135