spring-boot的access日志格式修改

本文详述了如何在Spring Boot项目中,利用logback布局配置,将业务数据(如用户ID)添加到access日志中,以便于后续的日志分析与统计。通过调整logback-access.xml文件中的pattern配置,结合Servlet API的setAttribute方法,实现更精细化的日志记录。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

前言

使用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.youkuaiyun.com/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);

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

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值