JAVA 应用程序内调用链跟踪简单实现方案(基于日志)

最新推荐文章于 2023-12-15 23:42:25 发布

weixin_33909059

最新推荐文章于 2023-12-15 23:42:25 发布

阅读量1.1k

点赞数

文章标签： java 测试

原文链接：https://my.oschina.net/fdhay/blog/1545529

版权

为什么80%的码农都做不了架构师？>>>

背景描述：

在用java语言开发经典的MVC服务端应用时，一个请求从controller进入，会经过N个service层，N个Dao层。怎么准确的跟踪一次请求到底经过了哪些方法？本文基于log4j日志提供一个解决思路（如有相同，纯属巧合，^_^）。

实现方案：

1. 首先要实现能区分每次请求的唯一标识（记作：traceId）, 可以通过如下TraceContext .ctx.getTraceId() 得到traceId。


public class TraceContext {

	public static ThreadLocal ctx = new InheritableThreadLocal(){ //此处用InheritableThreadLocal保证可以在子线程得到相同的traceId
		@Override
		protected TraceContext initialValue() {
			return new TraceContext();
		}
	};
	private String traceId;

	public String getTraceId() {
		if(traceId == null || "".equals(traceId)){
			traceId = System.nanoTime() + "";
		}
		return traceId;
	}
}

2. 在每次请求进入controller业务逻辑之前，比如可以是springmvc的HandlerInterceptor.preHandle方法，也可以是servlet规范中的javax.servlet.Filter.doFilter方法，重置traceId的值，并把新traceId的值put到MDC（org.slf4j.MDC，此处推荐使用slf4j的MDC对象，这样底层的实际日志引擎可以自由切换，比如由log4j切换到log4j2或者logback）上下文中。


//clear and reset trace context
TraceContext.ctx.get().clear();
//org.slf4j.MDC
MDC.put("traceId", TraceContext.ctx.get().getTraceId());

//Then, do your business...

3. 在底层日志系统的配置文件中增加traceId标识（此处以log4j配置为例）。



log4j.appender.stdout.layout.ConversionPattern=[%5p] [%d{yyyy-MM-dd HH:mm:ss}] [%t] [traceId:%X{traceId}] (%F:%L) %m%n

4. 打印日志中即可显示traceId，再结合日志检索（不是本文重点，比如可以使用ELK，输入traceId作为查询条件）功能，即可定位一次请求都经历了哪些过程。


[DEBUG] [2017-09-29 18:03:38] [http-80-1] [traceId:] (AppInterceptor.java:42) AppInterceptor: [traceId:175161640446888]
[DEBUG] [2017-09-29 18:06:09] [LocalCache-Timer] [traceId:175161640446888] (LocalCache.java:28) LocalCache clearExpired start...
[DEBUG] [2017-09-29 18:06:09] [LocalCache-Timer] [traceId:175161640446888] (LocalCache.java:53) LocalCache clearExpired count=1 , remain count=2,  time_cost=3ms

转载于:https://my.oschina.net/fdhay/blog/1545529