SkyWalking Agent 配置 Spring Cloud Gateway 插件解决日志错误

SkyWalking Agent 配置 Spring Cloud Gateway 插件解决日志错误

IDEA中启动网管时,需要配置VM启动参数,格式如下:

bash 复制代码
# 配置 SkyWalking Agent 启动参数,以便将网关服务的性能数据上报到 SkyWalking 服务器。
-javaagent:/path/to/skywalking-agent.jar \
-Dskywalking.agent.service_name=${APPLICATION_NAME}-skywalking \
-Dskywalking.collector.backend_service=127.0.0.1:11800
问题详情

在一个应用项目中使用 SkyWalking 监控时,Spring Cloud Gateway 服务上报出如下错误信息:

复制代码
2024-12-29 16:45:34.076 [TID:N/A] [http-nio-5] ERROR
  o.s.b.a.w.r.error.AbstractErrorWebExceptionHandler:122 - [2349a963-1]  500 Server Error for HTTP GET "/app/consumer/skuInfo/1"
java.lang.NullPointerException: null
    at org.apache.skywalking.apm.plugin.spring.cloud.gateway.v21x.HttpClientFinalizerResponseConnectionInterceptor$1.apply(HttpClientFinalizerResponseConnectionInterceptor.java:42)
...
解决过程

过程分析后发现,错误原因是 SkyWalking Agent 的 plugins 文件夹中缺少对 Spring Cloud Gateway 进行监控的实现插件。此插件位于 SkyWalking Agent 的 optional-plugins 文件夹中,应采取如下步骤进行解决:

  1. 确定 Spring Cloud Gateway 版本:

    • 通过命令格式查看项目依赖。

      bash 复制代码
      mvn dependency:tree | grep gateway
      # 或
      gradle dependencies | grep gateway
    • 记录项目中 Spring Cloud Gateway 版本,例如「3.x」。

  2. 找到相关插件文件:

    • 在 SkyWalking Agent 文件夹中的 optional-plugins 下,找到适配版本的插件:

      text 复制代码
      apm-spring-cloud-gateway-3.x-plugin-8.9.0.jar
  3. 将插件拷贝到 plugins 文件夹:

    • 将上述插件文件拷贝到 skywalking-agent/plugins 文件夹中。
  4. 重启服务:

    • 重新启动应用项目,检查 SkyWalking 探针是否正常工作。
注意事项
  1. 插件版本对应:

    • SkyWalking Agent 的插件需要和项目使用的 Spring Cloud Gateway 版本相匹配。
    • SkyWalking 主版本应与插件版本匹配:
      • 例如,SkyWalking 进行到8.9.0,应使用 apm-spring-cloud-gateway-3.x-plugin-8.9.0.jar。
  2. Reactor Netty 依赖关系:

    • Spring Cloud Gateway 依赖 Reactor Netty,需要 Reactor Netty 版本和插件声明匹配。
  3. 用 SkyWalking UI 校验效果:

    • 启动后,访问相关服务探针,检查是否显示完整的调用链,如响应时间、问题码、路由等。
进阶优化提示
  1. 调试 SkyWalking 日志源:

    • 启用 SkyWalking 调试日志,查看插件是否被正确装载。

      properties 复制代码
      logging.level.org.apache.skywalking=DEBUG
  2. 优化插件版本:

    • 实时升级项目依赖和 SkyWalking 插件,确保与 Spring 最新版本兼容。
  3. 产线通用化添加:

    • 在多服务环境中,确保同样插件配置在所有相关服务中完整加载。
相关推荐
代码不停6 天前
分布式链路追踪 SkyWalking介绍
skywalking·1024程序员节
流烟默13 天前
日志里的 TID 为什么是 N/A:SkyWalking 异步线程池 traceId 传递实战
skywalking·异步线程池
AscendKing14 天前
可观测性选型:ELK vs SkyWalking,到底哪个更重?是二选一,还是两者一起部署?
elk·skywalking·apm·可观测
AscendKing14 天前
Docker Compose 一键部署 SkyWalking 10.2.0 + Elasticsearch8.11,分布式链路追踪完整实战
elasticsearch·docker·skywalking·链路追踪·微服务监控
飘然生14 天前
traceId链路 skywalking java agent
java·开发语言·skywalking
Thomas.Sir16 天前
第27课:SkyWalking全链路追踪实战 & 微服务调用链路分析
spring cloud·微服务·skywalking
lisanmengmeng1 个月前
分布式追踪与监控:Skywalking(三)
分布式·skywalking
lisanmengmeng1 个月前
分布式追踪与监控:Skywalking介绍(一)
分布式·skywalking
Jinkxs2 个月前
SkyWalking - 生产级部署:集成 Elasticsearch 作为后端存储
大数据·elasticsearch·skywalking