技术分享 - 日志链路追踪
1.背景简述
在技术运维过程中,很难从某服务庞杂的日志中,单独找寻出某次 API 调用的全部日志。
为提高排查问题的效率,在多个系统及应用内根据 统一的 TraceId 查找同一次请求链路上的日志,根据日志快速定位问题,同时需对业务代码无侵入,特别是在高频请求下,也可以方便的搜索此次请求的日志内容。
本此分享一个使用 MDC 实现日志链路跟踪,在微服务环境中,我们经常使用 Skywalking、Spring Cloud Sleut 等去实现整体请求链路的追踪,但是这个整体运维成本高,架构复杂,本次我们来使用 MDC 通过 Log 来实现一个轻量级的会话事务跟踪功能,需要的朋友可以参考一下。
应用效果图
我们知道了 MDC 的好处后,其实在用户从第一时间调用请求时候,我们其实可以将请求增加 tarceid 一并返回,这样用户反馈时候,我们直接用 traceid 就可以全链路追踪到所有请求的情况了,做到信息的闭环。
请求效果图:
LOGBOOK 效果图:
2.关键思路
2.1.MDC
日志追踪目标是每次请求级别的,也就是说同一个接口的每次请求,都应该有不同的 traceId。 每次接口请求,都是一个单独的线程,所以自然我们很容易考虑到通过 ThreadLocal 实现上述需求。 考虑到 log4j 本身已经提供了类似的功能 MDC,所以直接使用 MDC 进行实现。
关于 MDC 的简述
MDC(Mapped Diagnostic Context)是一个映射,用于存储运行上下文的特定线程的上下文数据。因此,如果使用 log4j 进行日志记录,则每个线程都可以拥有自己的 MDC,该 MDC 对整个线程是全局的。属于该线程的任何代码都可以轻松访问线程的 MDC 中存在的值。
API 说明:
•clear() => 移除所有 MDC
•get (String key) => 获取当前线程 MDC 中指定 key 的值
•getContext() => 获取当前线程 MDC 的 MDC
•put(String key, Object o) => 往当前线程的 MDC 中存入指定的键值对
•remove(String key) => 删除当前线程 MDC 中指定的键值对 。
3.目标
1.需要一个全服务唯一的 id,即 traceId,如何保证?
2.traceId 如何在服务内部传递?
3.traceId 如何在服务间传递?
4.traceId 如何在多线程中传递?
4、实现方式
4.1 需要一个全服务唯一的 id,即 traceId,如何保证?
使用最简单的 uuid 即可。复杂的话可以配置 redis,雪花算法等方式。本次分享选最简单 uuid 生成 traceId 的方式。
4.2 traceId 如何在服务间传递?
1)在 xml 的日志格式中添加 %X{traceId} 配置。
2)新增拦截器,拦截所有请求,从 header 中获取 traceId 然后放到 MDC 中,如果没有获取到,则直接用 UUID 生成一个。
3)配置拦截器
4.3 traceId 如何在服务间传递?
封装 Http 工具类,把 traceId 加入头中,带到下一个服务。
4.4 traceId 如何在多线程中传递?
spring 项目也使用到了很多线程池,比如 @Async 异步调用,zookeeper 线程池、kafka 线程池等。不管是哪种线程池都大都支持传入指定的线程池实现,
拿 @Async 举例:
原理为:
MDC 底层使用 TreadLocal 来实现,那根据 TreadLocal 的特点,它是可以让我们在同一个线程中共享数据的,但是往往我们在业务方法中,会开启多线程来执行程序,这样的话 MDC 就无法传递到其他子线程了。这时,我们需要使用额外的方法来传递存在 TreadLocal 里的值。
MDC 提供了一个叫 getCopyOfContextMap 的方法,很显然,该方法就是把当前线程 TreadLocal 绑定的 Map 获取出来,之后就是把该 Map 绑定到子线程中的 ThreadLocal 中了
改造 Spring 的异步线程池,包装提交的任务。
接下来需要对ThreadPoolTaskExecutor
的方法进行重写:
5、扩展点
5.1 JSF 接口日志追踪的应用
项目中也运用到了大量的 jsf 接口,我们其实可以按照上述的思路进行服务间的传递。
调用端:
Provider 端:
1.filter 中直接获取,包括标记为 hiden 的参数。通过 Rpccontext 无法获取。
2.
1.服务端业务代码中直接获取
2.
tips:调用链中的隐式传参
注意:在调用链例如 A–>B–>C,A 和 B 都要隐私传参的时候,由于是同一个线程,会出现数据污染。例如 A 发参数 P1 给 B,B 收到请求拿到 P1 同时要发参数 P2 给 C,那么 C 会直接拿到 P1,P2。 这种情况,就要求 B 收到 P1,然后设置 P2 调用 C 之前,要求自己清空上下文数据(RpcContext.getContext().clearAttachments();)
5.2 接口返回值应用
我们知道了 MDC 的好处后,其实在用户从第一时间调用请求时候,我们其实可以将有误的请求增加 tarceid 一并返回,这样用户反馈时候,我们直接用 traceid 就可以全链路追踪到所有请求的情况了,做到信息的闭环。
效果图:
6、备注:
各位知道了日志追踪的原理,其实很多应用场景可以继续补充,例如 MQ,JD 的其他中间件也可以应用相同原理进行追踪。其实,当了解了底层的原理后,我们其实就可以了解到 JD 监控中间件 PFinder 监控等中间件是如何做的了,本次由于时间情况,就不进行扩展了,各位可以线下去了解 Skywalking 分布式链路追踪系统,就可以知道,万变不离其宗。
版权声明: 本文为 InfoQ 作者【京东科技开发者】的原创文章。
原文链接:【http://xie.infoq.cn/article/6006cf27153c09bc89b90bb74】。文章转载请联系作者。
评论