SpringBoot+Logback實(shí)現(xiàn)一個(gè)簡(jiǎn)單的鏈路追蹤功能
最近線(xiàn)上排查問(wèn)題時(shí)候,發(fā)現(xiàn)請(qǐng)求太多導(dǎo)致日志錯(cuò)綜復(fù)雜,沒(méi)辦法把用戶(hù)在一次或多次請(qǐng)求的日志關(guān)聯(lián)在一起,所以就利用SpringBoot+Logback手寫(xiě)了一個(gè)簡(jiǎn)單的鏈路追蹤,下面詳細(xì)介紹下。
一、實(shí)現(xiàn)原理
Spring Boot默認(rèn)使用LogBack日志系統(tǒng),并且已經(jīng)引入了相關(guān)的jar包,所以我們無(wú)需任何配置便可以使用LogBack打印日志。
MDC(Mapped Diagnostic Context,映射調(diào)試上下文)是log4j和logback提供的一種方便在多線(xiàn)程條件下記錄日志的功能。
實(shí)現(xiàn)思路是在一個(gè)請(qǐng)求開(kāi)始時(shí),將請(qǐng)求相關(guān)的上下文信息(例如客戶(hù)ID、客戶(hù)的IP地址、sessionId、請(qǐng)求參數(shù)等)添加到MDC,然后配置好logback-spring.xml,則Logback組件將會(huì)在每條日志中打印出存放到MDC的信息,從而實(shí)現(xiàn)一個(gè)ID貫穿用戶(hù)的所有操作。
二、代碼實(shí)戰(zhàn)
新建一個(gè)spring boot項(xiàng)目spring-boot-log,按照下面步驟操作。
新建日志攔截器
日志攔截器在請(qǐng)求開(kāi)始獲取用戶(hù)的sessionId,當(dāng)然也可以生成一個(gè)UUID,生成后存放到MDC中。
SessionInterceptor代碼如下:
/** * 日志攔截器 * @Author: Java碎碎念 * */ public class SessionInterceptor extends HandlerInterceptorAdapter { /** * 會(huì)話(huà)ID */ private final static String SESSION_KEY = "sessionId"; @Override public void postHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, ModelAndView arg3) throws Exception { } @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { // String token = UUID.randomUUID().toString().replaceAll("-",""); //本例測(cè)試使用sessionId,也可以使用UUID等 String token = request.getSession().getId(); MDC.put(SESSION_KEY, token); return true; } @Override public void afterCompletion(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, Exception arg3) throws Exception { // 刪除 MDC.remove(SESSION_KEY); } }
新建配置類(lèi)
新建InterceptorConfig,注冊(cè)剛才的日志攔截器。
InterceptorConfig代碼如下:
@Configuration public class InterceptorConfig implements WebMvcConfigurer { @Bean public SessionInterceptor getSessionInterceptor() { return new SessionInterceptor(); } @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(getSessionInterceptor()).addPathPatterns("/*"); } }
修改logback-spring.xml
配置logback-spring.xml,獲取日志攔截器添加的sessionId并打印到日志中,配置文件中獲取方式如下:
%X{sessionId}
本例中打印sessionId到控制臺(tái)和文件,完整配置如下:
<?xml version="1.0" encoding="UTF-8"?> <configuration> <property name="log.base" value="./log/logback"/> <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <pattern> %date [%thread] [%X{sessionId}] %-5level %logger{80} - %msg%n </pattern> </encoder> </appender> <appender name="logfile" class="ch.qos.logback.core.rolling.RollingFileAppender"> <File>${log.base}.log</File> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <FileNamePattern>${log.base}.%d{yyyy -MM-dd}.log.zip</FileNamePattern> </rollingPolicy> <encoder> <pattern> %date [%thread] [%X{sessionId}] %-5level %logger{80} - %msg%n </pattern> </encoder> </appender> <logger name="com.sample" level="TRACE"/> <root> <level value="INFO"/> <appender-ref ref="stdout"/> <appender-ref ref="logfile"/> </root> </configuration>
添加controller
新建TestLogController,打印日志。
代碼如下:
@RestController public class TestLogController { Logger log = LoggerFactory.getLogger(getClass()); /** * 測(cè)試登錄 */ @RequestMapping(value = "/testLogin") public String testLogin() { log.info("用戶(hù)登錄成功!"); return "ok"; } /** * 測(cè)試下單 */ @RequestMapping(value = "/testNewOrder") public String testNewOrder() { log.info("用戶(hù)創(chuàng)建了訂單!"); log.info("請(qǐng)求完成,返回ok!"); return "ok"; } /** * 測(cè)試購(gòu)買(mǎi) */ @RequestMapping(value = "/testPay") public String testPay() { log.info("用戶(hù)付款!"); return "ok"; } }
三、測(cè)試
打開(kāi)瀏覽器連續(xù)訪(fǎng)問(wèn)接口testLogin、testNewOrder和testPay,模擬用戶(hù)登錄、下單、付款操作,控制臺(tái)和文件中打印的日志中已經(jīng)包含了sessonId信息,打印的結(jié)果如下:
[http-nio-8888-exec-1] [CB8E7DB250A31F2BE6C05B30633B9A95] INFO com.example.springbootlog.controller.TestLogController - 用戶(hù)登錄成功!
[http-nio-8888-exec-2] [CB8E7DB250A31F2BE6C05B30633B9A95] INFO com.example.springbootlog.controller.TestLogController - 用戶(hù)創(chuàng)建了訂單!
[http-nio-8888-exec-2] [CB8E7DB250A31F2BE6C05B30633B9A95] INFO com.example.springbootlog.controller.TestLogController - 請(qǐng)求完成,返回ok!
[http-nio-8888-exec-3] [CB8E7DB250A31F2BE6C05B30633B9A95] INFO com.example.springbootlog.controller.TestLogController - 用戶(hù)付款!
到此SpringBoot+Logback手寫(xiě)一個(gè)簡(jiǎn)單的鏈路追蹤功能已經(jīng)全部實(shí)現(xiàn),有問(wèn)題歡迎留言溝通哦!
完整源碼地址: https://github.com/suisui2019/springboot-study
總結(jié)
以上所述是小編給大家介紹的SpringBoot+Logback實(shí)現(xiàn)一個(gè)簡(jiǎn)單的鏈路追蹤功能,希望對(duì)大家有所幫助,如果大家有任何疑問(wèn)請(qǐng)給我留言,小編會(huì)及時(shí)回復(fù)大家的。在此也非常感謝大家對(duì)腳本之家網(wǎng)站的支持!
如果你覺(jué)得本文對(duì)你有幫助,歡迎轉(zhuǎn)載,煩請(qǐng)注明出處,謝謝!
相關(guān)文章
Java IO文件過(guò)濾器對(duì)命令設(shè)計(jì)模式的使用
java io流里面使用到了很多的設(shè)計(jì)模式,最典型的就是裝飾模式,還有命令模式,下面分兩部分來(lái)講Java IO文件過(guò)濾器對(duì)命令設(shè)計(jì)模式的使用,一起看看吧2017-06-06Java 數(shù)據(jù)類(lèi)型及類(lèi)型轉(zhuǎn)換的互相轉(zhuǎn)換實(shí)例代碼
這篇文章主要介紹了Java 數(shù)據(jù)類(lèi)型及類(lèi)型轉(zhuǎn)換的互相轉(zhuǎn)換實(shí)例代碼,需要的朋友可以參考下2020-10-10Spring bean對(duì)象實(shí)例化實(shí)現(xiàn)過(guò)程圖解
這篇文章主要介紹了Spring bean對(duì)象實(shí)例化實(shí)現(xiàn)過(guò)程圖解,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-07-07Java多線(xiàn)程之線(xiàn)程安全問(wèn)題詳細(xì)解析
這篇文章主要給大家介紹了關(guān)于Java多線(xiàn)程之線(xiàn)程安全問(wèn)題的相關(guān)資料,Java多線(xiàn)程中線(xiàn)程安全問(wèn)題是一個(gè)常見(jiàn)的問(wèn)題,因?yàn)槎鄠€(gè)線(xiàn)程可能同時(shí)訪(fǎng)問(wèn)共享的資源,文中通過(guò)圖文介紹的非常詳細(xì),需要的朋友可以參考下2023-11-11Spring--國(guó)內(nèi)Java程序員用得最多的框架
前幾年面試最常問(wèn)的且可以順利拿到高薪的技能是Spring,隨著Spring體系的壯大,除非你在簡(jiǎn)歷上添加Spring Boot和Spring Cloud的技能,才可以打動(dòng)面試官,而現(xiàn)在,除非是Spring全家桶的實(shí)戰(zhàn)經(jīng)驗(yàn),否則難以讓面試官高看2021-06-06SpringBoot實(shí)現(xiàn)轉(zhuǎn)頁(yè)功能
這篇文章主要介紹了SpringBoot實(shí)現(xiàn)轉(zhuǎn)頁(yè)功能,頁(yè)面的跳轉(zhuǎn)在web開(kāi)發(fā)中是經(jīng)常用的基礎(chǔ)功能,感興趣想要詳細(xì)了解可以閱讀下文,對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值2023-05-05