基于OpenTelemetry Java Agent捕获SpringBoot应用HTTP请求与响应体的最佳方案咨询
基于OpenTelemetry Java Agent捕获SpringBoot应用HTTP请求与响应体的最佳方案咨询
刚好之前帮团队处理过类似的需求,结合你用的SpringBoot 3.4.1和OpenTelemetry Java Agent 2.20.1版本,来给你梳理下可行的方案和注意事项:
一、关于自定义OpenTelemetry扩展是否是最佳方案
答案是肯定的,官方的OpenTelemetry Java Agent本身就是为可扩展设计的,通过自定义Instrumentation扩展来实现请求/响应体捕获,有几个核心优势:
- 完全无侵入业务代码,不需要修改现有Controller或者过滤器逻辑
- 能和Agent自带的链路追踪逻辑无缝整合,捕获到的内容可以直接关联到对应的Span上
- 遵循OTel的规范,后续升级Agent版本时兼容性更好
二、具体实现的核心思路
不用找外部资源,直接给你说落地的关键步骤:
- 针对Spring Web场景做方法增强:
如果你用的是Servlet栈(Spring MVC),可以对DispatcherServlet的doDispatch方法做增强,在方法执行前包装HttpServletRequest为ContentCachingRequestWrapper,这样就能缓存请求体并重复读取;响应体则通过包装HttpServletResponse为ContentCachingResponseWrapper来捕获。
如果你用的是WebFlux栈,就针对ServerWebExchange的相关方法做增强,用ServerHttpRequestDecorator和ServerHttpResponseDecorator来缓存流数据。 - 将捕获的内容注入Span:
在捕获到请求体/响应体后,通过Span currentSpan = Span.current()获取当前链路的Span,然后调用currentSpan.setAttribute("http.request.body", 缓存的请求体内容)、currentSpan.setAttribute("http.response.body", 缓存的响应体内容),把数据添加为Span的自定义属性。 - 处理流重复读取的问题:
一定要注意,原始的HTTP请求/响应流只能读取一次,所以必须用缓存类包装后再传递给后续的业务逻辑,否则会导致业务代码无法读取流而报错。
三、有没有现成的参考实现?
社区里很多团队都做过类似的扩展,你可以参考官方提供的Spring Web Instrumentation的代码结构来搭建自己的扩展:
- 先创建一个基于
io.opentelemetry.instrumentation:opentelemetry-instrumentation-api的项目,版本要和你用的Agent 2.20.1保持一致 - 参考官方spring-web instrumentation的增强逻辑,替换成自己的请求/响应体捕获逻辑
- 打包成jar后,通过
-Dotel.javaagent.extensions=你的扩展jar路径参数加载到Agent中
四、必须注意的几个坑
- 敏感数据脱敏:捕获的请求/响应体很可能包含密码、token等敏感信息,一定要在注入Span前做脱敏处理,比如替换掉敏感字段的内容,避免数据泄露。
- 性能与内存控制:大文件上传或者大响应体的场景下,缓存整个内容会占用大量内存,建议添加开关控制是否开启捕获,或者设置内容大小上限,超过上限就只捕获部分内容或者直接跳过。
- 版本兼容性:SpringBoot 3.4.1对应的Spring Web模块和OTel 2.20.1的Instrumentation要匹配,建议先在测试环境验证,避免出现类找不到、方法增强失败等问题。
如果在实现过程中遇到具体的代码问题,比如包装流的细节或者Span属性注入的问题,可以再细化提问,我再给你针对性的建议~




