spring-boot的access日志格式修改

前言

使用spring-boot框架开发的项目中,默认的logback格式可能默认是以下的格式:git

<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的问题。github

具体思路

tomcat的access日志配置介绍能够参考博文:【Tomcat Access Log配置
在上述博文中,咱们能够看到以下内容:spring

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}才能够。apache

<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>

只须要在代码中进行以下设置便可tomcat

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

(可能写的有点抽象啊,只是为了本身记录一下,不要忘记)cookie

相关文章
相关标签/搜索