SpringCloudGateway使用Skywalking时日志打印traceId解析

 更新时间:2023年06月14日 14:42:20   作者:SparkOnly  
这篇文章主要为大家介绍了SpringCloudGateway使用Skywalking时日志打印traceId解析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

环境信息

  • SpringCloudGateway 3.1.3
  • Skywalking Agent 8.10.0

环境配置

Agent

由于SpringCloudGateway是基于WebFlux来实现的,需要进到skywalking的agent目录,将optional-plugins目录底下的以下两个jar包复制到plugins目录

  • apm-spring-webflux-5.x-plugin-8.10.0.jar
  • apm-spring-cloud-gateway-3.x-plugin-8.10.0.jar

Maven依赖配置

<dependency>
  <groupId>org.apache.skywalking</groupId>
    <artifactId>apm-toolkit-log4j-2.x</artifactId>
    <version>${skywalking.version}</version>
</dependency>
<dependency>
    <groupId>org.apache.skywalking</groupId>
    <artifactId>apm-toolkit-trace</artifactId>
    <version>${skywalking.version}</version>
</dependency>

日志pattern配置

[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%traceId] [%logger{36}] [%thread] [%-5level] %msg%n

启动参数

新增启动参数

-javaagent:D:\work\skywalking-agent\skywalking-agent.jar=agent.service_name=xxx
-Dskywalking.collector.backend_service=xxx:11800

启动程序后,尝试通过网关进行接口调用,可以在Skywalking-ui上看到链路已经串起来了

调用链路

但是有个问题,日志里记录的日志始终不显示正确的TID

[2022-06-15 14:53:19.958] [TID: N/A]

问题处理过程

查看agent是怎么串联链路的

查看Skywalking-agent的源码,可以看到,在apm-spring-webflux-5.x-plugin-8.10.0.jar插件里,拦截了org.springframework.web.reactive.DispatcherHandlerhandle方法
拦截器里往reactor的调用链路里,放入 < SKYWALKING_CONTEXT_SNAPSHOT - ContextSnapshot >

image.png

所以traceId可以从reactor的context里获取到

怎么让日志获取到traceId

网上找了下资料,在这里[https://github.com/reactor/reactor-core/blob/main/docs/asciidoc/faq.adoc#context.api]发现了相关信息

public static <T> Consumer<Signal<T>> logOnNext(Consumer<T> logStatement) {
    return signal -> {
        if (!signal.isOnNext()) return; (1)
        Optional<String> toPutInMdc = signal.getContext().getOrEmpty("CONTEXT_KEY"); (2)
        toPutInMdc.ifPresentOrElse(tpim -> {
            try (MDC.MDCCloseable cMdc = MDC.putCloseable("MDC_KEY", tpim)) { (3)
                logStatement.accept(signal.get()); (4)
            }
        },
        () -> logStatement.accept(signal.get())); (5)
    };
}
@GetMapping("/byPrice")
public Flux<Restaurant> byPrice(@RequestParam Double maxPrice, @RequestHeader(required = false, name = "X-UserId") String userId) {
    String apiId = userId == null ? "" : userId; (1)
    return restaurantService.byPrice(maxPrice))
               .doOnEach(logOnNext(r -> LOG.debug("found restaurant {} for ${}", (2)
                    r.getName(), r.getPricePerPerson())))
               .contextWrite(Context.of("CONTEXT_KEY", apiId)); (3)
}

获取不到traceId的时候,怎么显示默认值

https://logging.apache.org/log4j/2.x/manual/layouts.html#PatternLayout

equals{pattern}{test}{substitution}
equalsIgnoreCase{pattern}{test}{substitution}

完整例子

  • pattern改为 [%d{yyyy-MM-dd HH:mm:ss.SSS}] [TID: %equals{%X{traceId}}{}{N/A}] [%logger{36}] [%thread] [%-5level] %msg%n
  • 注册onEachOperator的Hooks
@Component
public class LogHooks {
    private static final String KEY = "logMdc";
    @PostConstruct
    @SuppressWarnings("unchecked")
    public void setHook() {
        reactor.core.publisher.Hooks.onEachOperator(KEY,
                Operators.lift((scannable, coreSubscriber) -> new MdcSubscriber(coreSubscriber)));
    }
    @PreDestroy
    public void resetHook() {
        reactor.core.publisher.Hooks.resetOnEachOperator(KEY);
    }
}
public class MdcSubscriber implements CoreSubscriber {
    private static final String TRACE_ID = "traceId";
    private static final String SKYWALKING_CTX_SNAPSHOT = "SKYWALKING_CONTEXT_SNAPSHOT";
    private final CoreSubscriber<Object> actual;
    public MdcSubscriber(CoreSubscriber<Object> actual) {
        this.actual = actual;
    }
    @Override
    public void onSubscribe(Subscription s) {
        actual.onSubscribe(s);
    }
    @Override
    public void onNext(Object o) {
        Context c = actual.currentContext();
        Optional<String> traceIdOptional = Optional.empty();
        if (!c.isEmpty() && c.hasKey(SKYWALKING_CTX_SNAPSHOT)) {
            traceIdOptional = Optional.of(c.get(SKYWALKING_CTX_SNAPSHOT)).map(BeanUtil::beanToMap)
                    .map(t -> t.get(TRACE_ID)).map(BeanUtil::beanToMap).map(t -> t.get("id")).map(Object::toString);
        }
        try (MDC.MDCCloseable cMdc = MDC.putCloseable(TRACE_ID, traceIdOptional.orElse("N/A"))) {
            actual.onNext(o);
        }
    }
    @Override
    public void onError(Throwable throwable) {
        actual.onError(throwable);
    }
    @Override
    public void onComplete() {
        actual.onComplete();
    }
    @Override
    public Context currentContext() {
        return actual.currentContext();
    }
}

以上就是SpringCloudGateway使用Skywalking时日志打印traceId解析的详细内容,更多关于SpringCloudGateway Skywalking的资料请关注脚本之家其它相关文章!

相关文章

  • Java maven三种仓库,本地仓库,私服,中央仓库的配置

    Java maven三种仓库,本地仓库,私服,中央仓库的配置

    今天给大家简单介绍Maven三种仓库的配置,文中有非常详细的解释,对Java初学者很有帮助哟,需要的朋友可以参考下,希望能够给你带来帮助
    2021-09-09
  • springboot整合security和vue的实践

    springboot整合security和vue的实践

    本文主要介绍了springboot整合security和vue的实践,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-09-09
  • Java中和队列相关的基本操作

    Java中和队列相关的基本操作

    在Java中,队列是一种常用的数据结构,用于存储和管理元素。Java提供了Queue接口和其实现类,包括LinkedList和ArrayDeque等。队列的基本操作包括入队(enqueue)、出队(dequeue)、获取队首元素(peek)和判断队列是否为空(isEmpty)。
    2023-09-09
  • 解读httpclient的validateAfterInactivity连接池状态检测

    解读httpclient的validateAfterInactivity连接池状态检测

    这篇文章主要为大家介绍了httpclient的validateAfterInactivity连接池状态检测解读*,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-11-11
  • SpringBoot中使用Servlet三大组件的方法(Servlet、Filter、Listener)

    SpringBoot中使用Servlet三大组件的方法(Servlet、Filter、Listener)

    这篇文章主要介绍了SpringBoot中使用Servlet三大组件的方法(Servlet、Filter、Listener),本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-01-01
  • 使用springboot打包后的文件读取方式

    使用springboot打包后的文件读取方式

    这篇文章主要介绍了使用springboot打包后的文件读取方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-08-08
  • java DataInputStream和DataOutputStream详解及实例代码

    java DataInputStream和DataOutputStream详解及实例代码

    这篇文章主要介绍了java DataInputStream和DataOutputStream详解及实例代码的相关资料,需要的朋友可以参考下
    2017-01-01
  • Java中String类的常见方法超详细讲解

    Java中String类的常见方法超详细讲解

    这篇文章主要介绍了Java中String类常见方法的相关资料,String类是不可变的,字符串常量池用于存储字符串字面量,常用方法包括字符串查找、转换、比较、替换、拆分和截取,需要的朋友可以参考下
    2025-04-04
  • Java Web开发中的分页与参数校验举例详解

    Java Web开发中的分页与参数校验举例详解

    这篇文章主要介绍了JavaWeb开发中的分页设计和参数校验,分页设计通过分页查询参数优化查询性能,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2025-02-02
  • 数据库CURD必备搭档mybatis plus详解

    数据库CURD必备搭档mybatis plus详解

    这篇文章主要为大家介绍了数据库CURD必备搭档mybatis plus详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-05-05

最新评论