SpringBoot?2.5.5整合輕量級(jí)的分布式日志標(biāo)記追蹤神器TLog的詳細(xì)過程
隨著微服務(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ì)開始考慮上SkyWalking,Pinpoint等分布式追蹤系統(tǒng)來解決,基于OpenTracing規(guī)范,而且通常都是無侵入性的,并且有相對(duì)友好的管理界面來進(jìn)行鏈路Span的查詢。
但是搭建分布式追蹤系統(tǒng),熟悉以及推廣到全公司的系統(tǒng)需要一定的時(shí)間周期,而且當(dāng)中涉及到鏈路span節(jié)點(diǎn)的存儲(chǔ)成本問題,全量采集還是部分采集?如果全量采集,就以SkyWalking的存儲(chǔ)來舉例,ES集群搭建至少需要5個(gè)節(jié)點(diǎn)。這就需要增加服務(wù)器成本。況且如果微服務(wù)節(jié)點(diǎn)多的話,一天下來產(chǎn)生幾十G上百G的數(shù)據(jù)其實(shí)非常正常。如果想保存時(shí)間長點(diǎn)的話,也需要增加服務(wù)器磁盤的成本。
當(dāng)然分布式追蹤系統(tǒng)是一個(gè)最終的解決方案,如果您的公司已經(jīng)上了分布式追蹤系統(tǒng),那TLog并不適用。
項(xiàng)目整合
項(xiàng)目結(jié)構(gòu)

添加依賴
<!-- 引入全量tlog依賴 -->
<dependency>
<groupId>com.yomahub</groupId>
<artifactId>tlog-all-spring-boot-starter</artifactId>
<version>1.5.0</version>
</dependency>logback-spring.xml
<?xml version="1.0" encoding="UTF-8"?>
<!-- 日志級(jí)別從低到高分為TRACE < DEBUG < INFO < WARN < ERROR < FATAL,如果設(shè)置為WARN,則低于WARN的信息都不會(huì)輸出 -->
<!-- scan:當(dāng)此屬性設(shè)置為true時(shí),配置文件如果發(fā)生改變,將會(huì)被重新加載,默認(rèn)值為true -->
<!-- scanPeriod:設(shè)置監(jiān)測配置文件是否有修改的時(shí)間間隔,如果沒有給出時(shí)間單位,默認(rèn)單位是毫秒。當(dāng)scan為true時(shí),此屬性生效。默認(rèn)的時(shí)間間隔為1分鐘。 -->
<!-- debug:當(dāng)此屬性設(shè)置為true時(shí),將打印出logback內(nèi)部日志信息,實(shí)時(shí)查看logback運(yùn)行狀態(tài)。默認(rèn)值為false。 -->
<configuration scan="true" scanPeriod="10 seconds">
<contextName>logback</contextName>
<!-- name的值是變量的名稱,value的值時(shí)變量定義的值。通過定義的值會(huì)被插入到logger上下文中。定義變量后,可以使“${}”來使用變量。 -->
<property name="log.path" value="applog/" />
<property name="log.name" value="springboot-tlog"/>
<property name="CONSOLE_LOG_PATTERN_FILE" value="%d{yyyy-MM-dd HH:mm:ss.SSS} %C:%M:%L [%thread] %-5level %msg%n"/>
<!-- 彩色日志 -->
<!-- 彩色日志依賴的渲染類 -->
<conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
<conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />
<conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />
<!-- 彩色日志格式 -->
<property name="CONSOLE_LOG_PATTERN" value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
<!--輸出到控制臺(tái)-->
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<!--此日志appender是為開發(fā)使用,只配置最底級(jí)別,控制臺(tái)輸出的日志級(jí)別是大于或等于此級(jí)別的日志信息-->
<!-- <filter class="ch.qos.logback.classic.filter.ThresholdFilter">-->
<!-- <level>info</level>-->
<!-- </filter>-->
<encoder class="com.yomahub.tlog.core.enhance.logback.AspectLogbackEncoder">
<Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
<!-- 設(shè)置字符集 -->
<charset>UTF-8</charset>
</encoder>
</appender>
<!--輸出到文件-->
<!-- 時(shí)間滾動(dòng)輸出 level為 INFO 日志 -->
<appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 正在記錄的日志文件的路徑及文件名 -->
<file>${log.path}/${log.name}/${log.name}_info.log</file>
<!--日志文件輸出格式-->
<encoder class="com.yomahub.tlog.core.enhance.logback.AspectLogbackEncoder">
<pattern>${CONSOLE_LOG_PATTERN_FILE}</pattern>
<charset>UTF-8</charset>
</encoder>
<!-- 日志記錄器的滾動(dòng)策略,按日期,按大小記錄 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- 每天日志歸檔路徑以及格式 -->
<fileNamePattern>${log.path}/${log.name}/info/${log.name}-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!--日志文件保留天數(shù)-->
<maxHistory>180</maxHistory>
</rollingPolicy>
<!-- 此日志文件只記錄info級(jí)別的 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>info</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!-- 時(shí)間滾動(dòng)輸出 level為 ERROR 日志 -->
<appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 正在記錄的日志文件的路徑及文件名 -->
<file>${log.path}/${log.name}/${log.name}_error.log</file>
<!--日志文件輸出格式-->
<encoder class="com.yomahub.tlog.core.enhance.logback.AspectLogbackEncoder">
<pattern>${CONSOLE_LOG_PATTERN_FILE}</pattern>
<charset>UTF-8</charset> <!-- 此處設(shè)置字符集 -->
</encoder>
<!-- 日志記錄器的滾動(dòng)策略,按日期,按大小記錄 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${log.path}/${log.name}/error/${log.name}-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!--日志文件保留天數(shù)-->
<maxHistory>180</maxHistory>
</rollingPolicy>
<!-- 此日志文件只記錄ERROR級(jí)別的 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>ERROR</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<root level="info">
<appender-ref ref="CONSOLE" />
<appender-ref ref="INFO_FILE" />
<appender-ref ref="ERROR_FILE" />
</root>
<!-- sql打印 -->
<!-- <logger name="com.ybchen.mapper" level="DEBUG"/>-->
</configuration>請(qǐng)求類
package com.ybchen.request;
import lombok.Data;
/**
* @author: chenyanbin 2022-10-18 23:03
*/
@Data
public class PersonRequest {
private Long id;
private Long age;
private String name;
}Controller
package com.ybchen.controller;
import com.ybchen.request.PersonRequest;
import com.yomahub.tlog.core.annotation.TLogAspect;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* @author: chenyanbin 2022-10-18 22:56
*/
@RestController
@Slf4j
public class DemoController {
@TLogAspect({"id"})
@GetMapping("demo1")
public void demo1(String id, String name) {
log.info("這是第一條日志---->簡單例子");
log.info("這是第二條日志---->簡單例子");
log.info("這是第三條日志---->簡單例子");
new Thread(() -> log.info("這是異步日志---->簡單例子")).start();
}
@TLogAspect({"id", "name"})
@GetMapping("demo2")
public void demo2(String id, String name) {
log.info("這是第一條日志----->多個(gè)數(shù)值");
log.info("這是第二條日志----->多個(gè)數(shù)值");
log.info("這是第三條日志----->多個(gè)數(shù)值");
new Thread(() -> log.info("這是異步日志----->多個(gè)數(shù)值")).start();
}
@TLogAspect(value = {"id", "name"}, pattern = "<-{}->", joint = "_")
@GetMapping("demo3")
public void demo3(String id, String name) {
log.info("多個(gè)數(shù)值-------->加了patter和joint的示例");
}
@TLogAspect(str = "陳彥斌博客地址:https://www.cnblogs.com/chenyanbin/")
@GetMapping("demo4")
public void demo4(String name){
log.info("這是第一條日志----->常量字符串標(biāo)簽");
log.info("這是第二條日志----->常量字符串標(biāo)簽");
log.info("這是第三條日志----->常量字符串標(biāo)簽");
new Thread(() -> log.info("這是異步日志----->常量字符串標(biāo)簽")).start();
}
@TLogAspect({"request.id","request.age"})
@GetMapping("demo5")
public void demo4(PersonRequest request){
log.info("多參數(shù)加多層級(jí)示例");
}
}SpanId的生成規(guī)則

TLog業(yè)務(wù)標(biāo)簽
很多公司的系統(tǒng)在打日志的時(shí)候,每打一個(gè)日志里都會(huì)帶入一些業(yè)務(wù)信息,比如記錄ID,會(huì)員CODE,方便業(yè)務(wù)日志的定位。現(xiàn)在有了TLog,不僅能做分布式鏈路標(biāo)簽追加,還能自動(dòng)幫你做業(yè)務(wù)標(biāo)簽的添加。這樣在定位日志的時(shí)候可以更加方便的搜索。
Tlog支持方法級(jí)別的自定義業(yè)務(wù)標(biāo)簽。你可以在方法上定義簡單的標(biāo)注,來實(shí)現(xiàn)在某一個(gè)方法的日志里,統(tǒng)一加入業(yè)務(wù)的指標(biāo)標(biāo)簽,用于更加細(xì)致的定位。
演示
示例1


@TLogAspect({"id"})
@GetMapping("demo1")
public void demo1(String id, String name) {
log.info("這是第一條日志---->簡單例子");
log.info("這是第二條日志---->簡單例子");
log.info("這是第三條日志---->簡單例子");
new Thread(() -> log.info("這是異步日志---->簡單例子")).start();
}2022-10-18 23:14:37.450 INFO 88321 --- [nio-8080-exec-4] com.ybchen.controller.DemoController : <0><11477324755760832> [id:"10086"] 這是第一條日志---->簡單例子 2022-10-18 23:14:37.451 INFO 88321 --- [nio-8080-exec-4] com.ybchen.controller.DemoController : <0><11477324755760832> [id:"10086"] 這是第二條日志---->簡單例子 2022-10-18 23:14:37.451 INFO 88321 --- [nio-8080-exec-4] com.ybchen.controller.DemoController : <0><11477324755760832> [id:"10086"] 這是第三條日志---->簡單例子 2022-10-18 23:14:37.452 INFO 88321 --- [ Thread-12] com.ybchen.controller.DemoController : <0><11477324755760832> [id:"10086"] 這是異步日志---->簡單例子 2022-10-18 23:14:41.160 INFO 88321 --- [nio-8080-exec-5] com.ybchen.controller.DemoController : <0><11477324998899392> [id:"10087"] 這是第一條日志---->簡單例子 2022-10-18 23:14:41.160 INFO 88321 --- [nio-8080-exec-5] com.ybchen.controller.DemoController : <0><11477324998899392> [id:"10087"] 這是第二條日志---->簡單例子 2022-10-18 23:14:41.160 INFO 88321 --- [nio-8080-exec-5] com.ybchen.controller.DemoController : <0><11477324998899392> [id:"10087"] 這是第三條日志---->簡單例子 2022-10-18 23:14:41.161 INFO 88321 --- [ Thread-13] com.ybchen.controller.DemoController : <0><11477324998899392> [id:"10087"] 這是異步日志---->簡單例子 2022-10-18 23:14:43.938 INFO 88321 --- [nio-8080-exec-6] com.ybchen.controller.DemoController : <0><11477325181023936> [id:"10085"] 這是第一條日志---->簡單例子 2022-10-18 23:14:43.939 INFO 88321 --- [nio-8080-exec-6] com.ybchen.controller.DemoController : <0><11477325181023936> [id:"10085"] 這是第二條日志---->簡單例子 2022-10-18 23:14:43.939 INFO 88321 --- [nio-8080-exec-6] com.ybchen.controller.DemoController : <0><11477325181023936> [id:"10085"] 這是第三條日志---->簡單例子 2022-10-18 23:14:43.940 INFO 88321 --- [ Thread-14] com.ybchen.controller.DemoController : <0><11477325181023936> [id:"10085"] 這是異步日志---->簡單例子
示例二

@TLogAspect({"id", "name"})
@GetMapping("demo2")
public void demo2(String id, String name) {
log.info("這是第一條日志----->多個(gè)數(shù)值");
log.info("這是第二條日志----->多個(gè)數(shù)值");
log.info("這是第三條日志----->多個(gè)數(shù)值");
new Thread(() -> log.info("這是異步日志----->多個(gè)數(shù)值")).start();
}2022-10-18 23:22:33.941 INFO 88321 --- [nio-8080-exec-8] com.ybchen.controller.DemoController : <0><11477355982223040> [id:"10085",name:"alex"] 這是第一條日志----->多個(gè)數(shù)值 2022-10-18 23:22:33.946 INFO 88321 --- [nio-8080-exec-8] com.ybchen.controller.DemoController : <0><11477355982223040> [id:"10085",name:"alex"] 這是第二條日志----->多個(gè)數(shù)值 2022-10-18 23:22:33.947 INFO 88321 --- [nio-8080-exec-8] com.ybchen.controller.DemoController : <0><11477355982223040> [id:"10085",name:"alex"] 這是第三條日志----->多個(gè)數(shù)值 2022-10-18 23:22:33.950 INFO 88321 --- [ Thread-15] com.ybchen.controller.DemoController : <0><11477355982223040> [id:"10085",name:"alex"] 這是異步日志----->多個(gè)數(shù)值 2022-10-18 23:22:37.744 INFO 88321 --- [nio-8080-exec-9] com.ybchen.controller.DemoController : <0><11477356232308416> [id:"10086",name:"alex"] 這是第一條日志----->多個(gè)數(shù)值 2022-10-18 23:22:37.744 INFO 88321 --- [nio-8080-exec-9] com.ybchen.controller.DemoController : <0><11477356232308416> [id:"10086",name:"alex"] 這是第二條日志----->多個(gè)數(shù)值 2022-10-18 23:22:37.744 INFO 88321 --- [nio-8080-exec-9] com.ybchen.controller.DemoController : <0><11477356232308416> [id:"10086",name:"alex"] 這是第三條日志----->多個(gè)數(shù)值 2022-10-18 23:22:37.745 INFO 88321 --- [ Thread-16] com.ybchen.controller.DemoController : <0><11477356232308416> [id:"10086",name:"alex"] 這是異步日志----->多個(gè)數(shù)值
示例三

@TLogAspect(value = {"id", "name"}, pattern = "<-{}->", joint = "_")
@GetMapping("demo3")
public void demo3(String id, String name) {
log.info("多個(gè)數(shù)值-------->加了patter和joint的示例");
}2022-10-18 23:24:52.137 INFO 88321 --- [nio-8080-exec-1] com.ybchen.controller.DemoController : <0><11477365039888064> <-id:"10086"_name:"alex"-> 多個(gè)數(shù)值-------->加了patter和joint的示例 2022-10-18 23:24:56.329 INFO 88321 --- [nio-8080-exec-2] com.ybchen.controller.DemoController : <0><11477365314614976> <-id:"10089"_name:"alex"-> 多個(gè)數(shù)值-------->加了patter和joint的示例
示例四

@TLogAspect(str = "陳彥斌博客地址:https://www.cnblogs.com/chenyanbin/")
@GetMapping("demo4")
public void demo4(String name){
log.info("這是第一條日志----->常量字符串標(biāo)簽");
log.info("這是第二條日志----->常量字符串標(biāo)簽");
log.info("這是第三條日志----->常量字符串標(biāo)簽");
new Thread(() -> log.info("這是異步日志----->常量字符串標(biāo)簽")).start();
}2022-10-18 23:29:25.801 INFO 10245 --- [nio-8080-exec-4] com.ybchen.controller.DemoController : <0><11477382974797504> [陳彥斌博客地址:https://www.cnblogs.com/chenyanbin/] 這是第一條日志----->常量字符串標(biāo)簽 2022-10-18 23:29:25.802 INFO 10245 --- [nio-8080-exec-4] com.ybchen.controller.DemoController : <0><11477382974797504> [陳彥斌博客地址:https://www.cnblogs.com/chenyanbin/] 這是第二條日志----->常量字符串標(biāo)簽 2022-10-18 23:29:25.802 INFO 10245 --- [nio-8080-exec-4] com.ybchen.controller.DemoController : <0><11477382974797504> [陳彥斌博客地址:https://www.cnblogs.com/chenyanbin/] 這是第三條日志----->常量字符串標(biāo)簽 2022-10-18 23:29:25.803 INFO 10245 --- [ Thread-8] com.ybchen.controller.DemoController : <0><11477382974797504> [陳彥斌博客地址:https://www.cnblogs.com/chenyanbin/] 這是異步日志----->常量字符串標(biāo)簽 2022-10-18 23:29:30.216 INFO 10245 --- [nio-8080-exec-5] com.ybchen.controller.DemoController : <0><11477383264138944> [陳彥斌博客地址:https://www.cnblogs.com/chenyanbin/] 這是第一條日志----->常量字符串標(biāo)簽 2022-10-18 23:29:30.217 INFO 10245 --- [nio-8080-exec-5] com.ybchen.controller.DemoController : <0><11477383264138944> [陳彥斌博客地址:https://www.cnblogs.com/chenyanbin/] 這是第二條日志----->常量字符串標(biāo)簽 2022-10-18 23:29:30.217 INFO 10245 --- [nio-8080-exec-5] com.ybchen.controller.DemoController : <0><11477383264138944> [陳彥斌博客地址:https://www.cnblogs.com/chenyanbin/] 這是第三條日志----->常量字符串標(biāo)簽 2022-10-18 23:29:30.218 INFO 10245 --- [ Thread-9] com.ybchen.controller.DemoController : <0><11477383264138944> [陳彥斌博客地址:https://www.cnblogs.com/chenyanbin/] 這是異步日志----->常量字符串標(biāo)簽
示例五
@TLogAspect支持點(diǎn)操作符,適用于對(duì)象的取值,支持類型:
- Bean對(duì)象
- Map對(duì)象
- Json格式的字符串
- Fastjson的JSONObject對(duì)象

@TLogAspect({"request.id","request.age"})
@GetMapping("demo5")
public void demo4(PersonRequest request){
log.info("多參數(shù)加多層級(jí)示例");
}
================
@Data
public class PersonRequest {
private Long id;
private Long age;
private String name;
}2022-10-18 23:32:58.761 INFO 14747 --- [nio-8080-exec-2] com.ybchen.controller.DemoController : <0><11477396931212992> [request.id:10089,request.age:27] 多參數(shù)加多層級(jí)示例 2022-10-18 23:33:03.289 INFO 14747 --- [nio-8080-exec-3] com.ybchen.controller.DemoController : <0><11477
到此這篇關(guān)于SpringBoot 2.5.5整合輕量級(jí)的分布式日志標(biāo)記追蹤神器TLog的文章就介紹到這了,更多相關(guān)SpringBoot 2.5.5整合輕量級(jí)內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
- SpringBoot中dubbo+zookeeper實(shí)現(xiàn)分布式開發(fā)的應(yīng)用詳解
- 2020最新IDEA SpringBoot整合Dubbo的實(shí)現(xiàn)(zookeeper版)
- SpringBoot系列教程之dubbo和Zookeeper集成方法
- 淺談Java(SpringBoot)基于zookeeper的分布式鎖實(shí)現(xiàn)
- SpringBoot整合XxlJob分布式任務(wù)調(diào)度平臺(tái)
- springboot如何使用redis的incr創(chuàng)建分布式自增id
- SpringBoot集成redis與session實(shí)現(xiàn)分布式單點(diǎn)登錄
- springboot 使用zookeeper實(shí)現(xiàn)分布式隊(duì)列的基本步驟
相關(guān)文章
java設(shè)計(jì)模式之觀察者模式學(xué)習(xí)
這篇文章主要為大家詳細(xì)介紹了java設(shè)計(jì)模式之觀察者模式,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2017-01-01
Spring Boot Shiro在Web應(yīng)用中的作用詳解
這篇文章主要為大家介紹了Spring Boot Shiro在Web應(yīng)用中的作用詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-02-02
mvc架構(gòu)實(shí)現(xiàn)商品的購買(二)
這篇文章主要為大家詳細(xì)介紹了mvc架構(gòu)實(shí)現(xiàn)商品購買功能,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2016-11-11
SpringBoot解析JSON數(shù)據(jù)的三種方案
JSON(JavaScript Object Notation) 是一種輕量級(jí)的數(shù)據(jù)交換格式,易于人閱讀和編寫,同時(shí)也易于機(jī)器解析和生成,本文給大家介紹了SpringBoot解析JSON數(shù)據(jù)的三種方案,需要的朋友可以參考下2024-03-03
IntelliJ IDEA 詳細(xì)圖解最常用的配置(適合剛剛用的新人)
這篇文章主要介紹了IntelliJ IDEA 詳細(xì)圖解最常用的配置,本篇教程非常適合剛剛用的新人,本文圖文并茂給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2020-08-08

