Sentinel整合Gateway控制台不显示API管理

文章目录

  • 1. 问题场景
  • 2. 原因分析
    • 2.1. 查看源码页面
    • 2.2 2. 查看客户端源码
  • 3. 解决方案
    • 3.1. 配置JVM启动参数
    • 3.2 启动类直接设置系统参数
  • 参考

1. 问题场景

在Spring Cloud Gateway整合Sentinel时,发现API管理这个菜单没有显示。

在官方文档里,是有这个菜单的:
Sentinel整合Gateway控制台不显示API管理_第1张图片
Sentinel整合Gateway控制台不显示API管理_第2张图片

2. 原因分析

2.1. 查看源码页面

在控制台对应的页面sidebar.html中,我们发现这个菜单时通过entry.isGateway这个条件语句来判断的,那么肯定是因为这个判断了不是网关,所以才不显示。
Sentinel整合Gateway控制台不显示API管理_第3张图片
然后在sidebar.js中,发现在查询客户端注册的信息时,appType为0,而只有当appType为1、11、12时,这里才会认为是网关。

Sentinel整合Gateway控制台不显示API管理_第4张图片

2.2 2. 查看客户端源码

首先看下心跳发送器SimpleHttpHeartbeatSender,这个类负责提供基本的 API 来向控制台发送心跳请求。可以看到我们发出心跳时,appType是0,那么控制台接受到的肯定也是0,则不会认为这个一个网关应用了。

Sentinel整合Gateway控制台不显示API管理_第5张图片
在SentinelConfig配置类中,我们看到,appType没有配置时,默认为0。

Sentinel整合Gateway控制台不显示API管理_第6张图片
但是我们在Cloud Sentinel包中的SentinelSCGAutoConfiguration自动配置类中,发现有设置appType为11:
Sentinel整合Gateway控制台不显示API管理_第7张图片
那么结合以上分析,可以猜到,应该是在心跳比SentinelSCGAutoConfiguration先加载,所以控制台获取的的appType为0了。

实际Debug发现,果然如此。

3. 解决方案

既然找到了是因为心跳优先发送了appType,那么我们需要事先在发送心跳之前配置appType。

如果是已经失败的场景,需要重启 dashboard。

3.1. 配置JVM启动参数

可以在IDEA中,或者java -jar配置启动参数

-Dcsp.sentinel.app.type=1

3.2 启动类直接设置系统参数

    public static void main(String[] args) {
        System.setProperty("csp.sentinel.app.type", "1");
        SpringApplication.run(GatewayApp.class);
    }

之后发现就能正常显示菜单了:
Sentinel整合Gateway控制台不显示API管理_第8张图片

参考

Alibaba Sentinel对接Spring Cloud Gateway关于不显示API管理及请求链路的坑附带解决方案
【问题解决】Sentinel整合Gateway控制台不显示API管理

你可能感兴趣的:(微服务专题,sentinel,api)