// trace日志 { "message":"trace log", "context":{ "trace_id":"e0d5c5ba-f497-4407-b8ca-f657a88452fc517513", "request_uri":"/customize-trace-A/trace/jdk/async", "request_method":"GET", "refer_service_name":null, "service_name":"customize-trace-A", "refer_service_host":"127.0.0.1", "request_time":1608896030.689531, "response_time":1608896030.692276, "time_used":3.479, "service_addr":"192.168.45.42", "service_port":8095, "request_id":"9adfcf3c-d606-418f-abc7-6600bff6adf0533098" }, "datetime":"2020-12-25 19:33:50.690014" } // span节点 { "trace_id":"e0d5c5ba-f497-4407-b8ca-f657a88452fc517513", "request_id":"9adfcf3c-d606-418f-abc7-6600bff6adf0533098", "span":{ "span_id":"eb12eaf8-df3d-4dd2-923a-685360a4fd79588942", "parent_id":null, "duration":3426, "annotations":[ { "timestamp":1608896030686322, "action":"sr" }, { "timestamp":1608896030689748, "action":"ss" } ] } , "datetime":"2020-12-25 19:34:50.690014" }
public class LoggerUtil{ /** * 生成traceId ,requestId,spanId 类似,设置不同的方法名即可 */ static String traceId() { return UUID.randomUUID().toString() + new Random().nextInt(1000000); } } public final class ThreadHolderUtil { /** * 任意类型数据集合 */ private static final ThreadLocal<Map<Object, Object>> VALUE_MAP = ThreadLocal.withInitial(HashMap::new); /** * 设置key值 * * @param key key * @param value 值 */ public static void setValue(Object key, Object value) { Optional.ofNullable(VALUE_MAP.get()).ifPresent(valueMap -> valueMap.put(key, value)); } /** * 清除指定Key * * @param key 指定key */ public static void clearValue(Object key) { Optional.ofNullable(VALUE_MAP.get()).ifPresent(valueMap -> valueMap.remove(key)); } /** * 清除整个map */ public static void clearValueMap() { VALUE_MAP.remove(); } }
/** * 调用服务追踪信息feign拦截器 * */ public class FeignTraceInterceptor implements RequestInterceptor { private static final Logger LOGGER = LoggerUtil.getTraceLogger(); @Override public void apply(RequestTemplate template) { String projectName = LoggerUtil.PROJECT_NAME; if (!StringUtils.isEmpty(projectName)) { template.header(REFER_SERVICE_NAME, projectName); } if (!StringUtils.isEmpty(HOST_IP)) { template.header(REFER_REQUEST_HOST, HOST_IP); } String traceId = TraceUtil.getTraceId(); if (StringUtils.isEmpty(traceId)) { traceId = LoggerUtil.traceId(); } template.header(GATEWAY_TRACE, traceId); String spanId = TraceContext.parentSpanId(); template.header(PARENT_ID_HEADER, spanId); } } @ConditionalOnClass(Feign.class) public static class FeignTraceAutoConfiguration { @Bean public FeignTraceInterceptor feignTraceInterceptor() { return new FeignTraceInterceptor(); } }
@Aspect @Component public class FeignSpanAspect { @Pointcut("@annotation(com.trace.base.tool.annotation.FeignSpan)") public void pointcut() { } @Around("pointcut()") public void around(ProceedingJoinPoint joinPoint) { try { // 先生成spanId String spanId = TraceContext.parentSpanId(); ThreadHolderUtil.setValue("feign-spanId", spanId); // cs Annotation cs = TraceContext.cs(); List<Annotation> annotations = new ArrayList<>(2); annotations.add(cs); // 避免执行超时,所以先设置span cs信息 Span span = new Span.Builder() .parentId(ThreadHolderUtil.getValue(PARENT_SPAN_ID_KEY, String.class)) .spanId(spanId) .annotations(annotations) .build(); List<Span> subSpanList = ThreadHolderUtil.getValue(SUB_SPAN_LIST_KEY, List.class); if (subSpanList != null) { subSpanList.add(span); } joinPoint.proceed(); // cr Annotation cr = TraceContext.cr(); // 增加cr annotations.add(cr); span.setDuration(cr.getTimestamp() - cs.getTimestamp()); } catch (Throwable throwable) { throwable.printStackTrace(); } } }
@Override public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException { HttpServletRequest servletRequest = (HttpServletRequest) request; String uri = servletRequest.getRequestURI(); // 服务健康检查日志不统计,根目录和HEAD请求忽略 final String slash = "/"; if (Arrays.stream(ignorePath).anyMatch(uri::startsWith) || slash.equals(uri) || HttpMethod.HEAD.name().equalsIgnoreCase(servletRequest.getMethod())) { chain.doFilter(request, response); } else { try { int port = request.getLocalPort(); TraceLog traceLog = new TraceLog(); traceLog.setRequestTime(getNowUs()); //服务名称 traceLog.setServiceName(LoggerUtil.PROJECT_NAME); // 开始时间戳(微秒) long start = LocalDateTimeUtil.getCurrentMicroSecond(); // traceId String traceId = servletRequest.getHeader(GATEWAY_TRACE); // 没有就新生成一个 if (StringUtils.isEmpty(traceId)) { traceId = LoggerUtil.traceId(); } // 尝试获取上游传递的parent_id String parentId = servletRequest.getHeader(TraceContext.PARENT_ID_HEADER); // 首先设置span id,作为后续子span的父span id String spanId = TraceContext.parentSpanId(); ThreadHolderUtil.setValue(PARENT_SPAN_ID_KEY, spanId); // 需要提前初始化子span列表,否则父子线程无法持有一个数据引用 ThreadHolderUtil.setValue(SUB_SPAN_LIST_KEY, new ArrayList<>()); // sr Annotation sr = TraceContext.sr(); String requestId = LoggerUtil.requestId(); // 设置trace,用于ResponseBody能够获取 Trace trace = new Trace(traceId, requestId); ThreadHolderUtil.setValue(TRACE_KEY, trace); traceLog.setTraceId(traceId); // 远程调用服务名称 traceLog.setReferServiceName(servletRequest.getHeader(REFER_SERVICE_NAME)); traceLog.setRequestUri(servletRequest.getRequestURI()); String method = servletRequest.getMethod(); traceLog.setRequestMethod(method); traceLog.setServicePort(port); // 原始response对象 chain.doFilter(request, response); // 结束时间戳(微秒) long end = LocalDateTimeUtil.getCurrentMicroSecond(); // ss Annotation ss = TraceContext.ss(); // duration long duration = ss.getTimestamp() - sr.getTimestamp(); // span日志 SpanLog spanLog = new SpanLog(); // 父span Span span = new Span.Builder() .parentId(parentId) .spanId(spanId) .duration(duration) .annotations(Arrays.asList(sr, ss)) .build(); spanLog.setTraceId(traceId); spanLog.setRequestId(requestId); spanLog.setSpan(span); List<Span> subSpanList = ThreadHolderUtil.getValue(SUB_SPAN_LIST_KEY, List.class); spanLog.setSubSpans(subSpanList); // todo 存储span信息 // todo 存储trace信息 } finally { // 最后清除VALUE_MAP // 执行完成后,清空产生的日志信息 ThreadHolderUtil.clearValueMap(); } } }
{ "message":"trace log", "context":{ "trace_id":"2bf002c7-c140-4304-9c42-98ec0e359e1a314225", "request_uri":"/customize-trace-A/trace/feign/name", "request_method":"GET", "refer_service_name":null, "service_name":"customize-trace-A", "refer_service_host":"127.0.0.1", "request_time":1612344583.027557, "response_time":1612344589.716305, "time_used":4774.917, "service_addr":"192.168.45.42", "service_port":8095, "request_id":"01d91c6f-1745-414c-a556-06d2e2630995119672" }, "level":200, "level_name":"INFO", "channel":"REQUEST", "datetime":"2021-02-03 17:29:50.405499" }
{ "message":"span log", "context":{ "trace_id":"2bf002c7-c140-4304-9c42-98ec0e359e1a314225", "request_id":"01d91c6f-1745-414c-a556-06d2e2630995119672", "span":{ "span_id":"e495b1e3-72e3-4dfc-92ad-8526c1c05e68901528", "parent_id":null, "duration":4772900, "annotations":[ { "timestamp":1612344583030172, "action":"sr" }, { "timestamp":1612344587803072, "action":"ss" } ] }, "request_uri":null, "request_method":null, "sub_spans":[ { "span_id":"6a112df7-762d-4467-aab5-8d4ea8d30e34265554", "parent_id":"e495b1e3-72e3-4dfc-92ad-8526c1c05e68901528", "duration":4064421, "annotations":[ { "timestamp":1612344583090733, "action":"cs" }, { "timestamp":1612344587155154, "action":"cr" } ] } ] }, "level":200, "level_name":"INFO", "channel":"SPAN", "datetime":"2021-02-03 17:29:49.705213" }
{ "message":"trace log", "context":{ "trace_id":"2bf002c7-c140-4304-9c42-98ec0e359e1a314225", "request_uri":"/customize-trace-B/trace/name", "request_method":"GET", "refer_service_name":"customize-trace-A", "service_name":"customize-trace-B", "refer_service_host":"127.0.0.1", "request_time":1612344586.914167, "response_time":1612344587.162829, "time_used":218.196, "service_addr":"192.168.45.42", "service_port":8096, "request_id":"c3141791-b5c4-49e3-ad4a-08c40782f687651638" }, "level":200, "level_name":"INFO", "channel":"REQUEST", "datetime":"2021-02-03 17:29:47.161630" }
{ "message":"span log", "context":{ "trace_id":"2bf002c7-c140-4304-9c42-98ec0e359e1a314225", "request_id":"c3141791-b5c4-49e3-ad4a-08c40782f687651638", "span":{ "span_id":"d4a7f2d5-d49d-4f88-95ee-4f73c18ff9d5967084", "parent_id":"6a112df7-762d-4467-aab5-8d4ea8d30e34265554", "duration":207818, "annotations":[ { "timestamp":1612344586929937, "action":"sr" }, { "timestamp":1612344587137755, "action":"ss" } ] }, "request_uri":null, "request_method":null, "sub_spans":[ ] }, "level":200, "level_name":"INFO", "channel":"SPAN", "datetime":"2021-02-03 17:29:47.139560" }
参考完整实现代码:https://github.com/wuya11/TraceDemo
运行截图参考: