輕量級的分佈式日誌追蹤利器，十分鐘便可接入，今後日誌追蹤無難事

時間 2020-09-19

原文原文鏈接

前言

隨着微服務盛行，不少公司都把系統按照業務邊界拆成了不少微服務，在排錯查日誌的時候。由於業務鏈路貫穿着不少微服務節點，致使定位某個請求的日誌以及上下游業務的日誌會變得有些困難。java

這時候不少童鞋會開始考慮上SkyWalking，Pinpoint等分佈式追蹤系統來解決，基於OpenTracing規範，並且一般都是無侵入性的，而且有相對友好的管理界面來進行鏈路Span的查詢。git

可是搭建分佈式追蹤系統，熟悉以及推廣到全公司的系統須要必定的時間週期，並且當中涉及到鏈路span節點的存儲成本問題，全量採集仍是部分採集？若是全量採集，就以SkyWalking的存儲來舉例，ES集羣搭建至少須要5個節點。這就須要增長服務器成本。何況若是微服務節點多的話，一天下來產生幾十G上百G的數據其實很是正常。若是想保存時間長點的話，也須要增長服務器磁盤的成本。web

因此此次介紹的開源項目是TLog，它的產生背景源於想作一個輕量級的日誌追蹤解決方案，覆蓋目前流行的日誌框架和RPC框架，讓用戶以最少的成原本接入以解決微服務體系中日誌跟蹤的痛點。spring

固然分佈式追蹤系統是一個最終的解決方案，若是您的公司已經上了分佈式追蹤系統，那TLog並不適用。apache

TLog提供了一種最簡單的方式來解決日誌追蹤問題，它不收集日誌，也不須要另外的存儲空間，它只是自動的對你的業務日誌進行打標籤，自動生成TraceId貫穿你微服務的一整條鏈路。而且提供上下游節點信息。適合中小型企業以及想快速解決日誌追蹤問題的公司項目使用。tomcat

爲此我爲了TLog適配了三大日誌框架，支持自動檢測適配。支持dubbo，dubbox，spring cloud三大RPC框架，更重要的是，你的項目接入TLog，可能連十分鐘就不須要：）springboot

TLog項目以及特性

項目地址：https://gitee.com/bryan31/TLog

TLog具備如下特性：服務器

經過對日誌打標籤完成輕量級微服務日誌追蹤
對業務代碼無侵入式設計，使用簡單，10分鐘便可接入
支持常見的log4j，log4j2，logback三大日誌框架，並提供自動檢測，完成適配
支持dubbo，dubbox，springcloud三大RPC框架
支持日誌標籤的自定義模板的配置
幾乎無性能損耗

如何快速接入

TLog支持了springboot的自動裝配，在springboot環境下，只須要如下兩步就能夠接入！app

依賴框架

<dependency>
  <groupId>com.yomahub</groupId>
  <artifactId>tlog-all-spring-boot-starter</artifactId>
  <version>1.0.0</version>
</dependency>

目前jar包已上傳中央倉庫，能夠直接依賴到

日誌框架適配

只須要在你的啓動類中加入一行代碼，便可以自動進行探測你項目所使用的Log框架，並進行加強，目前支持log4j，log4j2，logback三大日誌框架。

@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裏以下定義，改變標籤的格式，就能按照你定義模板進行打印

tlog.pattern=[$preApp][$preIp][$traceId]

$preApp ：上游微服務節點名稱

$preIp：上游微服務的IP地址

$traceId：全局惟一跟蹤ID

Log框架的單獨適配

若是你的自動化日誌探測失效或者你用的是外置容器，你須要針對你項目中的日誌框架配置進行修改，修改方法也很簡單。

Log4j配置文件加強

只須要把layout的實現類換掉就能夠了

每一個公司的Log4J的模板大同小異，這裏只給出xml的例子

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration>
    <appender name="stdout" class="org.apache.log4j.ConsoleAppender">
        <!--替換成AspectLog4jPatternLayout-->
        <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"/>
        <!--替換成AspectLog4jPatternLayout-->
        <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>

Logback的配置文件加強

換掉encoder的實現類或者換掉layout的實現類就能夠了

如下給出xml示例：

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
    <property name="APP_NAME" value="logtest"/>
    <property name="LOG_HOME" value="./logs" />
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <!--替換成AspectLogbackEncoder-->
        <encoder class="com.yomahub.tlog.core.enhance.logback.AspectLogbackEncoder">
              <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </encoder>
    </appender>
    <appender name="FILE"  class="ch.qos.logback.core.rolling.RollingFileAppender">
        <File>${LOG_HOME}/${APP_NAME}.log</File>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <FileNamePattern>${LOG_HOME}/${APP_NAME}.log.%d{yyyy-MM-dd}.%i.log</FileNamePattern>
            <MaxHistory>30</MaxHistory>
            <maxFileSize>1000MB</maxFileSize>
        </rollingPolicy>
        <!--替換成AspectLogbackEncoder-->
        <encoder class="com.yomahub.tlog.core.enhance.logback.AspectLogbackEncoder">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- 日誌輸出級別 -->
    <root level="INFO">
        <appender-ref ref="STDOUT" />
        <appender-ref ref="FILE" />
    </root>
</configuration>

Log4j2的配置文件加強

log4J2因爲是經過插件形式實現的，log4J2有自動掃描插件的功能。因此無需對配置文件作任何更改就能生效。