SpringCloud之熔断监控Hystrix Dashboard

红太狼 2022-01-27 11:23 363阅读 0赞

前言

SpringCloud 是微服务中的翘楚，最佳的落地方案。

SpringCloud 中的 Hystrix 组件可以实现熔断，而在实际情况中，一般还需要直观地看到各个服务的调用情况，

这时，就用到了 SpringCloud 另一个组件：Hystrix Dashboard。

Hystrix Dashboard 是一款针对于 Hystrix 进行实时监控的工具，还提供了友好的图形化界面。

源码

GitHub地址：https://github.com/intomylife/SpringCloud

环境

  • JDK 1.8.0 +
  • Maven 3.0 +
  • SpringBoot 2.0.3
  • SpringCloud Finchley.RELEASE

开发工具

  • IntelliJ IDEA

正文

commons 工程

commons 工程 - POM 文件

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  4.     <modelVersion>4.0.0</modelVersion>
  6.     <!-- 三坐标 -->
  7.     <groupId>com.zwc</groupId>
  8.     <artifactId>springcloud-dashboard-commons</artifactId>
  9.     <version>1.0</version>
  11.     <!-- 工程名称和描述 -->
  12.     <name>springcloud-dashboard-commons</name>
  13.     <description>公用工程</description>
  15.     <!-- 打包方式 -->
  16.     <packaging>jar</packaging>
  18.     <!-- 在 properties下声明相应的版本信息，然后在dependency下引用的时候用 ${} 就可以引入该版本jar包了 -->
  19.     <properties>
  20.         <!-- 编码 -->
  21.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  22.         <!-- jdk -->
  23.         <java.version>1.8</java.version>
  25.         <!-- SpringBoot -->
  26.         <platform-bom.version>Cairo-SR3</platform-bom.version>
  28.         <!-- SpringCloud -->
  29.         <spring-cloud-dependencies.version>Finchley.RELEASE</spring-cloud-dependencies.version>
  30.     </properties>
  32.     <!-- 加入依赖 -->
  33.     <dependencies>
  35.     </dependencies>
  37.     <!-- 依赖 jar 包版本管理的管理器 -->
  38.     <!-- 如果 dependencies 里的 dependency 自己没有声明 version 元素，那么 maven 就此处来找版本声明。 -->
  39.     <!-- 如果有，就会继承它；如果没有就会报错，告诉你没有版本信息 -->
  40.     <!-- 优先级：如果 dependencies 里的 dependency 已经声明了版本信息，就不会生效此处的版本信息了 -->
  41.     <dependencyManagement>
  42.         <dependencies>
  43.             <!-- SpringBoot -->
  44.             <dependency>
  45.                 <groupId>io.spring.platform</groupId>
  46.                 <artifactId>platform-bom</artifactId>
  47.                 <version>${platform-bom.version}</version>
  48.                 <type>pom</type>
  49.                 <scope>import</scope>
  50.             </dependency>
  51.             <!-- SpringCloud -->
  52.             <dependency>
  53.                 <groupId>org.springframework.cloud</groupId>
  54.                 <artifactId>spring-cloud-dependencies</artifactId>
  55.                 <version>${spring-cloud-dependencies.version}</version>
  56.                 <type>pom</type>
  57.                 <scope>import</scope>
  58.             </dependency>
  59.         </dependencies>
  60.     </dependencyManagement>
  62.     <!-- 插件依赖 -->
  63.     <build>
  64.         <plugins>
  65.             <plugin>
  66.                 <groupId>org.springframework.boot</groupId>
  67.                 <artifactId>spring-boot-maven-plugin</artifactId>
  68.             </plugin>
  69.         </plugins>
  70.     </build>
  72. </project>
  • 配置一些共用依赖

commons 工程 - 项目结构

watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNDAyMjAw_size_16_color_FFFFFF_t_70

service 工程

① 此工程下有三个模块：一个注册中心以及服务 A、B

② A 提供服务并且调用服务 B 以及 B 提供服务

registry-service（注册中心）

registry-service - POM 文件

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  4.     <modelVersion>4.0.0</modelVersion>
  6.     <!-- 继承父 -->
  7.     <parent>
  8.         <groupId>com.zwc</groupId>
  9.         <artifactId>springcloud-dashboard-service</artifactId>
  10.         <version>1.0</version>
  11.     </parent>
  13.     <!-- 三坐标 -->
  14.     <groupId>com.zwc</groupId>
  15.     <artifactId>springcloud-dashboard-registry-service</artifactId>
  16.     <version>1.0</version>
  18.     <!-- 工程名称描述 -->
  19.     <name>springcloud-dashboard-registry-service</name>
  20.     <description>注册中心</description>
  22.     <!-- 打包方式 -->
  23.     <packaging>jar</packaging>
  25.     <!-- 在 properties下声明相应的版本信息，然后在dependency下引用的时候用 ${} 就可以引入该版本jar包了 -->
  26.     <properties>
  28.     </properties>
  30.     <!-- 加入依赖 -->
  31.     <dependencies>
  32.         <!-- commons工程 依赖 -->
  33.         <dependency>
  34.             <groupId>com.zwc</groupId>
  35.             <artifactId>springcloud-dashboard-commons</artifactId>
  36.             <version>1.0</version>
  37.         </dependency>
  39.         <!-- 服务注册中心 -->
  40.         <dependency>
  41.             <groupId>org.springframework.cloud</groupId>
  42.             <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
  43.         </dependency>
  44.     </dependencies>
  46.     <!-- 插件依赖 -->
  47.     <build>
  48.         <plugins>
  49.             <plugin>
  50.                 <groupId>org.springframework.boot</groupId>
  51.                 <artifactId>spring-boot-maven-plugin</artifactId>
  52.             </plugin>
  53.         </plugins>
  54.     </build>
  56. </project>
  • 主要是加入 spring-cloud-starter-netflix-eureka-server 依赖

registry-service - application.yml 配置文件

  1. # 端口
  2. server:
  3.   port: 8761
  5. # 应用名称
  6. spring:
  7.   application:
  8.     name: eureka-server
  10. eureka:
  11.   instance:
  12.     # 使用 ip 代替实例名
  13.     prefer-ip-address: true
  14.     # 实例的主机名
  15.     hostname: ${spring.cloud.client.ip-address}
  16.     # 实例的 ID 规则
  17.     instance-id: ${spring.cloud.client.ip-address}:${spring.application.name}:${server.port}
  18.   client:
  19.     # 是否向注册中心注册自己
  20.     registerWithEureka: false
  21.     # 是否向注册中心获取注册信息
  22.     fetchRegistry: false
  23.     serviceUrl:
  24.       # 注册中心地址
  25.       defaultZone: http://${eureka.instance.hostname}:${server.port}/eureka/
  • 这里使用了默认的 8761 端口，当然也可以更改，不过在发现调用服务端的注册中心地址端口要与它一致

registry-service - 启动类

  1. package com.zwc;
  3. import org.springframework.boot.SpringApplication;
  4. import org.springframework.boot.autoconfigure.SpringBootApplication;
  5. import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer;
  7. @SpringBootApplication
  8. @EnableEurekaServer
  9. public class SpringcloudDashboardRegistryServiceApplication {
  11.     public static void main(String[] args) {
  12.         SpringApplication.run(SpringcloudDashboardRegistryServiceApplication.class, args);
  13.     }
  15. }
  • 在启动类中添加 @EnableEurekaServer 注解表示此工程是注册中心

registry-service - 启动项目

  1. 项目启动成功后访问 http://localhost:8761/ 即可看到 eureka-server 主页面

    watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNDAyMjAw_size_16_color_FFFFFF_t_70 1

服务工程 A（提供者和消费者）

服务工程 A - POM 文件

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  4.     <modelVersion>4.0.0</modelVersion>
  6.     <!-- 继承父 -->
  7.     <parent>
  8.         <groupId>com.zwc</groupId>
  9.         <artifactId>springcloud-dashboard-a-service</artifactId>
  10.         <version>1.0</version>
  11.     </parent>
  13.     <!-- 三坐标 -->
  14.     <groupId>com.zwc</groupId>
  15.     <artifactId>springcloud-dashboard-a-service-core</artifactId>
  16.     <version>1.0</version>
  18.     <!-- 工程名称描述 -->
  19.     <name>springcloud-dashboard-a-service-core</name>
  20.     <description>服务工程 - A 核心</description>
  22.     <!-- 打包方式 -->
  23.     <packaging>jar</packaging>
  25.     <!-- 在 properties下声明相应的版本信息，然后在dependency下引用的时候用 ${} 就可以引入该版本jar包了 -->
  26.     <properties>
  28.     </properties>
  30.     <!-- 加入依赖 -->
  31.     <dependencies>
  32.         <!-- commons工程 依赖 -->
  33.         <dependency>
  34.             <groupId>com.zwc</groupId>
  35.             <artifactId>springcloud-dashboard-commons</artifactId>
  36.             <version>1.0</version>
  37.         </dependency>
  39.         <!-- api工程 依赖 -->
  40.         <dependency>
  41.             <groupId>com.zwc</groupId>
  42.             <artifactId>springcloud-dashboard-a-service-api</artifactId>
  43.             <version>1.0</version>
  44.         </dependency>
  46.         <!-- 提供者消费者 -->
  47.         <dependency>
  48.             <groupId>org.springframework.cloud</groupId>
  49.             <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
  50.         </dependency>
  51.         <!-- feign -->
  52.         <dependency>
  53.             <groupId>org.springframework.cloud</groupId>
  54.             <artifactId>spring-cloud-starter-openfeign</artifactId>
  55.         </dependency>
  56.         <!-- actuator -->
  57.         <dependency>
  58.             <groupId>org.springframework.boot</groupId>
  59.             <artifactId>spring-boot-starter-actuator</artifactId>
  60.         </dependency>
  61.         <!-- hystrix -->
  62.         <dependency>
  63.             <groupId>org.springframework.cloud</groupId>
  64.             <artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
  65.         </dependency>
  66.         <!-- dashboard -->
  67.         <dependency>
  68.             <groupId>org.springframework.cloud</groupId>
  69.             <artifactId>spring-cloud-starter-netflix-hystrix-dashboard</artifactId>
  70.         </dependency>
  71.     </dependencies>
  73.     <!-- 插件依赖 -->
  74.     <build>
  75.         <plugins>
  76.             <plugin>
  77.                 <groupId>org.springframework.boot</groupId>
  78.                 <artifactId>spring-boot-maven-plugin</artifactId>
  79.             </plugin>
  80.         </plugins>
  81.     </build>
  83. </project>
  • 加入 spring-cloud-starter-netflix-eureka-client 依赖：提供和注册服务
  • 加入 Feign 的起步依赖 spring-cloud-starter-openfeign：消费服务
  • 加入依赖 spring-boot-starter-actuator：开启并配置端点
  • 加入依赖 spring-cloud-starter-netflix-hystrix：熔断器
  • 加入依赖 spring-cloud-starter-netflix-hystrix-dashboard：熔断监控

服务工程 A - application.yml 配置文件

  1. # 端口
  2. server:
  3.   port: 8090
  5. # 应用名称
  6. spring:
  7.   application:
  8.     name: dashboard-a
  10. eureka:
  11.   instance:
  12.     # 使用 ip 代替实例名
  13.     prefer-ip-address: true
  14.     # 实例的主机名
  15.     hostname: ${spring.cloud.client.ip-address}
  16.     # 实例的 ID 规则
  17.     instance-id: ${spring.cloud.client.ip-address}:${spring.application.name}:${server.port}
  18.   client:
  19.     serviceUrl:
  20.       # 注册中心地址
  21.       defaultZone: http://${eureka.instance.hostname}:8761/eureka/
  23. management:
  24.   endpoints:
  25.     web:
  26.       exposure:
  27.         # 开启监控端点
  28.         include: hystrix.stream
  29.       base-path: /
  • 注意此处配置注册中心地址的端口为 8761 也就是上面注册中心工程配置的端口
  • spring.application.name：应用名称，被消费者调用时需要用到，它在消费的同时也可以被消费
  • 另一个服务工程 B 配置与此类似，只是端口和应用名称不一样，不再赘述
  • 在 2.0 后需要主动开启端点 hystrix.stream，否则 404

服务工程 A - application.properties（注意）

  1. # 开启断路器
  2. feign.hystrix.enabled=true
  • 断路器要主动开启，服务调用失败时才会熔断
  • 此处有一个坑，把此配置写到 yml 中熔断不会生效
  • 由于 B 工程只提供服务，没有消费服务。所以 B 工程不用该配置
  • application.properties 和 bootstrap.yml 二选一就行

服务工程 A - bootstrap.yml（注意）

  1. feign:
  2.   hystrix:
  3.     # 开启断路器
  4.     enabled: true
  • 断路器要主动开启，服务调用失败时才会熔断
  • 此处有一个坑，把此配置写到 application.yml 中熔断不会生效
  • application.properties 和 bootstrap.yml 二选一就行

服务工程 A - controller 前端控制器（提供服务）

  1. package com.zwc.a.controller;
  3. import org.springframework.beans.factory.annotation.Value;
  4. import org.springframework.web.bind.annotation.RequestMapping;
  5. import org.springframework.web.bind.annotation.RestController;
  7. /*
  8.  * @ClassName ASayHelloController
  9.  * @Desc TODO   Say Hello
  10.  * @Date 2019/5/20 23:24
  11.  * @Version 1.0
  12.  */
  13. @RestController
  14. public class ASayHelloController {
  16.     /*
  17.      * @ClassName ASayHelloController
  18.      * @Desc TODO   读取配置文件中的端口
  19.      * @Date 2019/5/20 23:24
  20.      * @Version 1.0
  21.      */
  22.     @Value("${server.port}")
  23.     private String port;
  25.     /*
  26.      * @ClassName ASayHelloController
  27.      * @Desc TODO   Say Hello
  28.      * @Date 2019/5/20 23:24
  29.      * @Version 1.0
  30.      */
  31.     @RequestMapping("/a")
  32.     public String a(){
  33.         return "Hello！I'm a. port：" + port;
  34.     }
  36. }
  • 提供一个服务：输出 Hello 和端口

服务工程 A - 服务调用

  1. package com.zwc.a.api.feign;
  3. import com.zwc.a.api.impl.FeignApiFallBack;
  4. import org.springframework.cloud.openfeign.FeignClient;
  5. import org.springframework.web.bind.annotation.RequestMapping;
  7. /*
  8.  * @ClassName FeignApi
  9.  * @Desc TODO   使用 Feign 调用 b - 接口
  10.  * @Date 2019/5/20 23:21
  11.  * @Version 1.0
  12.  */
  13. @FeignClient(value = "dashboard-b" , fallback = FeignApiFallBack.class)
  14. public interface FeignApi {
  16.     /*
  17.      * @ClassName FeignApi
  18.      * @Desc TODO   通过 dashboard-b 服务名调用 b() 方法
  19.      * @Date 2019/5/20 23:21
  20.      * @Version 1.0
  21.      */
  22.     @RequestMapping("/b")
  23.     String b();
  25. }
  • 通过 @FeignClient 注解中 value = “dashboard-b” 来指定调用哪个服务
  • dashboard-b 就是提供者的 spring.application.name：应用名称
  • 通过 @FeignClient 注解中 fallback = FeignApiFallBack.class 来指定熔断时调用的方法
  • FeignApiFallBack 就是此接口（FeignApi）的实现类，对应的实现方法就是熔断时调用的方法
  • b()：此方法是 B 工程中提供的服务，在这里定义成接口
  • 注意要与提供者具有相同返回值，相同方法名以及相同参数

服务工程 A - Fallback（FeignApiFallBack）

  1. package com.zwc.a.api.impl;
  3. import com.zwc.a.api.feign.FeignApi;
  4. import org.springframework.stereotype.Component;
  6. /*
  7.  * @ClassName FeignApi
  8.  * @Desc TODO   fallback
  9.  * @Date 2019/5/20 23:21
  10.  * @Version 1.0
  11.  */
  12. @Component
  13. public class FeignApiFallBack implements FeignApi {
  15.     /*
  16.      * @ClassName FeignApiFallBack
  17.      * @Desc TODO   调用 dashboard-b 服务中的 b() 方法失败时执行
  18.      * @Date 2019/5/20 23:31
  19.      * @Version 1.0
  20.      */
  21.     @Override
  22.     public String b() {
  23.         return "Hello！aUseB fail";
  24.     }
  25. }
  • 使用 @Component 注解把此类交给 Spring 管理
  • 实现了 FeignApi 接口，提供熔断时对应的方法

服务工程 A - controller 前端控制器（消费服务）

  1. package com.zwc.a.controller;
  3. import com.zwc.a.api.feign.FeignApi;
  4. import org.springframework.beans.factory.annotation.Autowired;
  5. import org.springframework.web.bind.annotation.RequestMapping;
  6. import org.springframework.web.bind.annotation.RestController;
  8. /*
  9.  * @ClassName AUseBFeignController
  10.  * @Desc TODO   使用 Feign 调用 b - 前端控制器
  11.  * @Date 2019/5/20 23:23
  12.  * @Version 1.0
  13.  */
  14. @RestController
  15. public class AUseBFeignController {
  17.     @Autowired(required = false)
  18.     private FeignApi feignApi;
  20.     /*
  21.      * @ClassName FeignController
  22.      * @Desc TODO   通过 dashboard-b 服务名调用 b() 方法
  23.      * @Date 2019/5/20 23:13
  24.      * @Version 1.0
  25.      */
  26.     @RequestMapping("/aUseB")
  27.     public String aUseB(){
  28.         return feignApi.b();
  29.     }
  31. }
  • 使用 @Autowired 注解装配 Bean，通过此 Bean 中的方法调用服务
  • 此类对外暴露接口，调用的实则是提供者的服务

服务工程 A - 启动类

  1. package com.zwc;
  3. import org.springframework.boot.SpringApplication;
  4. import org.springframework.boot.autoconfigure.SpringBootApplication;
  5. import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
  6. import org.springframework.cloud.netflix.hystrix.EnableHystrix;
  7. import org.springframework.cloud.netflix.hystrix.dashboard.EnableHystrixDashboard;
  8. import org.springframework.cloud.openfeign.EnableFeignClients;
  10. @SpringBootApplication
  11. @EnableEurekaClient
  12. @EnableFeignClients
  13. @EnableHystrix
  14. @EnableHystrixDashboard
  15. public class SpringcloudDashboardAServiceCoreApplication {
  17.     public static void main(String[] args) {
  18.         SpringApplication.run(SpringcloudDashboardAServiceCoreApplication.class, args);
  19.     }
  21. }
  • 添加 @EnableEurekaClient 注解表示此工程可以向注册中心提供服务
  • 添加 @EnableFeignClients 注解表示开启 Feign 功能进行远程调用
  • 添加 @EnableHystrix 注解表示开启熔断器
  • 添加 @EnableHystrixDashboard 注解表示开启熔断监控

服务工程 A - 启动项目

  1. 项目启动成功后访问：http://localhost:8090/hystrix 可以看到

    watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNDAyMjAw_size_16_color_FFFFFF_t_70 2

  2. 在中间的输入框中输入：http://127.0.0.1:8090/hystrix.stream ，点击 Monitor Stream 按钮可以看到

    watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNDAyMjAw_size_16_color_FFFFFF_t_70 3

  3. 此时还未调用服务，所以一直显示 ‘Loading …’

  4. 另起页面访问：http://localhost:8090/a （调用自己的服务）

  5. 输出内容：’Hello！I’m a. port：8090’

  6. 这是熔断监控页面还是不会有所改变，因为在调用别人的服务时才会有相关数据

  7. 访问地址：http://localhost:8090/aUseB （调用 B 工程的服务）

  8. 输出内容：’Hello！aUseB fail’ （此时因为 B 工程还未启动，所以调用了 fallback 中的方法）

  9. 再观察步骤 2 中的熔断监控页面，可以看到

    watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNDAyMjAw_size_16_color_FFFFFF_t_70 4

    1. 启动服务工程 B，项目启动成功后再次访问：http://localhost:8090/aUseB （调用 B 工程的服务）

    2. 输出内容：’Hello！I’m b. port：8091’ （如果还未调用成功，等待一会再刷新试试）

    3. 再次观察步骤 2 中的熔断监控页面，可以看到

    watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNDAyMjAw_size_16_color_FFFFFF_t_70 5

    1. 红色的百分比表示失败率

    2. 左边的六个数字对应着页面右上角的六个状态（Success、Short-Circuited..）

service 工程 - 项目结构

watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNDAyMjAw_size_16_color_FFFFFF_t_70 6

把多工程项目使用 IntelliJ IDEA 打开

  1. 把项目从 GitHub 中下载到你的本地
  2. 打开 IntelliJ IDEA
  3. 点击 File -> Open
  4. 打开你下载到本地的项目目录
  5. springcloud-dashboard -> springcloud-dashboard-service（选择打开此工程）
  6. 打开 service 工程后
  7. 再次点击 File -> Project Structrue
  8. 选择 Modules，点击 ‘+’ 符号
  9. 点击 Import Module
  10. 还是打开你下载到本地的项目目录
  11. springcloud-dashboard -> springcloud-dashboard-commons -> pom.xml
  12. 点击 OK
  13. 点击 Next，Finish
  14. 点击 Apply，OK

希望能够帮助到你

over

发表评论

表情：
评论列表 （有 0 条评论，363人围观）

还没有评论，来说两句吧...

相关阅读