spring-boot的access日誌格式修改

前言

使用spring-boot框架開發的項目中,默認的logback格式可能默認是如下的格式:

<Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs" prefix="access." suffix=".log" 
        pattern="%h %l %u %t "%r" %s %b "%{Referer}i" "%{User-Agent}i" %{X-Forwarded-For}i "%Dms"" resolveHosts="false"/>

假設有一種場景,我們希望能夠將業務數據加入到access日誌中,方便統計每個接口在用戶粒度的調用量。
那麼在分佈式日誌服務中,我們可以考慮在每行的access日誌中,添加用戶的id,方便直接解析到es中,在es中計算count即可。
本文主要解決access日誌中添加userId的問題。

具體思路

tomcat的access日誌配置介紹可以參考博文:【Tomcat Access Log配置
在上述博文中,我們可以看到如下內容:

Access Log中也支持cookie,請求header,響應headers,Session或者其他在ServletRequest中的對象的信息。格式遵循apache語法
%{xxx}i 請求headers的信息
%{xxx}o 響應headers的信息
%{xxx}c 請求cookie的信息
%{xxx}r xxx是ServletRequest的一個屬性
%{xxx}s xxx是HttpSession的一個屬性

我們發現是可以給ServletRequest添加屬性,打印日誌的時候進行解析的。
不過使用上述的格式配置的logback-access.xml文件因爲格式問題導致無法解析。
找到一篇詳解logback layout配置的文章:https://blog.csdn.net/Doraemo...
可以看到需要使用%reqAttribute{XXXX}纔可以。

<pattern>%i{ClientIp} %h %l %u [%t] "%r" %s %b "%i{Referer}" "%i{User-Agent}" %i{x-ssl-header} %reqAttribute{user-id}%n======%n%fullRequest%n======%n%fullResponse</pattern>

只需要在代碼中進行如下設置即可

servletRequest.setAttribute("user-id", userId);

(可能寫的有點抽象啊,只是爲了自己記錄一下,不要忘記)

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章