SpringCloud 熔断器仪表盘 Hystrix Dashboard实现

古城微笑少年丶 2022-03-15 12:42 274阅读 0赞

之前实现的熔断器的配置，SpringCloud还提供了熔断器的可视化界面仪表盘Hystrix Dashboard功能，这里配置的时候踩了一些坑，这边记录下。

之前熔断有通过Ribbon和Feign两种方式实现，这边可以通过仪表盘监控这两种方式的熔断。项目依旧基于之前的[hystrix][]项目：

[hystrix实现][hystrix]

**目录**

一、配置仪表盘

二、配置监控方

1、Ribbon方式

2、Feign方式

--------------------

# 一、配置仪表盘 #

在工程中新建新的module，和之前项目创建方式一致。在组件选择中，选上[hystrix][]，Hystrix Dashboard。这里建议选上eureka server和eureka Discovery。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhcnJ5cHR0ZXI_size_16_color_FFFFFF_t_70][]

创建完之后在启动类HystrixDashboarApplication上面加上注解@EnableHystrixDashboard

package com.hystrixdashboar;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.client.SpringCloudApplication;
    import org.springframework.cloud.netflix.hystrix.dashboard.EnableHystrixDashboard;
    
    @SpringBootApplication
    @EnableHystrixDashboard
    public class HystrixDashboarApplication {
    
    	public static void main(String[] args) {
    		SpringApplication.run(HystrixDashboarApplication.class, args);
    	}
    
    }

在对应的pom.xml 文件中加上：

<dependency>
    		<groupId>org.springframework.boot</groupId>
    		<artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>

我这边的pom.xml文件（我这里配置了mysql）为：

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    	<modelVersion>4.0.0</modelVersion>
    	<parent>
    		<groupId>org.springframework.boot</groupId>
    		<artifactId>spring-boot-starter-parent</artifactId>
    		<version>2.1.3.RELEASE</version>
    		<relativePath/> 
    	</parent>
    	<groupId>com.hystrixdashboar</groupId>
    	<artifactId>hystrixdashboar</artifactId>
    	<version>0.0.1-SNAPSHOT</version>
    	<name>hystrixdashboar</name>
    	<description>Demo project for Spring Boot</description>
    
    	<properties>
    		<java.version>1.8</java.version>
    		<spring-cloud.version>Greenwich.RELEASE</spring-cloud.version>
    	</properties>
    
    	<dependencies>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-data-jpa</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-web</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.cloud</groupId>
    			<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.cloud</groupId>
    			<artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.cloud</groupId>
    			<artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.cloud</groupId>
    			<artifactId>spring-cloud-starter-netflix-hystrix-dashboard</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.cloud</groupId>
    			<artifactId>spring-cloud-starter-netflix-ribbon</artifactId>
    		</dependency>
    
    		<dependency>
    		<groupId>org.springframework.boot</groupId>
    		<artifactId>spring-boot-starter-actuator</artifactId>
    		</dependency>
    
    		<dependency>
    			<groupId>mysql</groupId>
    			<artifactId>mysql-connector-java</artifactId>
    			<scope>runtime</scope>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-test</artifactId>
    			<scope>test</scope>
    		</dependency>
    	</dependencies>
    
    	<dependencyManagement>
    		<dependencies>
    			<dependency>
    				<groupId>org.springframework.cloud</groupId>
    				<artifactId>spring-cloud-dependencies</artifactId>
    				<version>${spring-cloud.version}</version>
    				<type>pom</type>
    				<scope>import</scope>
    			</dependency>
    		</dependencies>
    	</dependencyManagement>
    
    	<build>
    		<plugins>
    			<plugin>
    				<groupId>org.springframework.boot</groupId>
    				<artifactId>spring-boot-maven-plugin</artifactId>
    			</plugin>
    		</plugins>
    	</build>
    
    	<repositories>
    		<repository>
    			<id>spring-milestones</id>
    			<name>Spring Milestones</name>
    			<url>https://repo.spring.io/milestone</url>
    		</repository>
    	</repositories>
    
    </project>

然后是application.properties配置文件，配置端口号和服务名称：

server.port = 10030
    
    spring.application.name =  SPRING-CLOUD-HYSTRIX-DASHBOARD
    
    eureka.client.serviceUrl.defaultZone= http://localhost:12345/eureka/
    
    spring.datasource.url=jdbc:mysql://127.0.0.1:3306/testmysql
    spring.datasource.username=root
    spring.datasource.password=123456
    spring.datasource.driver-class-name=com.mysql.jdbc.Driver
    spring.datasource.max-idle=10
    spring.datasource.max-wait=10000
    spring.datasource.min-idle=5
    spring.datasource.initial-size=5

这里有第一个坑：如果之前有其他端口作为cloud eureka服务器的话，建议加上eureka.client.serviceUrl.defaultZone的配置，不然在启动的时候一直会报错。

这样Hystrix Dashboard这个module就弄好了，之后就是配置它监测的Ribbon或者feign了。

# 二、配置监控方 #

## 1、Ribbon方式 ##

在项目的负载均衡Ribbon模块的pom.xml中加上actuator的配置：

<dependency>
    		<groupId>org.springframework.boot</groupId>
    		<artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>

在Ribbon的启动类上加上注解@EnableCircuitBreaker。

第二个坑：如果用的springboot 版本是2.0及以上的，在ribbon启动类里面要加上下面这段代码：

@Bean
        public ServletRegistrationBean getServlet(){
            HystrixMetricsStreamServlet streamServlet = new HystrixMetricsStreamServlet();
            ServletRegistrationBean registrationBean = new ServletRegistrationBean(streamServlet);
            registrationBean.setLoadOnStartup(1);
            registrationBean.addUrlMappings("/actuator/hystrix.stream");
            registrationBean.setName("HystrixMetricsStreamServlet");
            return registrationBean;
        }

我这边最后Ribbon启动类代码是：

package com.cloud.ribbonservice;
    
    import com.netflix.hystrix.contrib.metrics.eventstream.HystrixMetricsStreamServlet;
    import com.netflix.loadbalancer.IRule;
    import com.netflix.loadbalancer.RandomRule;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.boot.web.servlet.ServletRegistrationBean;
    import org.springframework.cloud.client.circuitbreaker.EnableCircuitBreaker;
    import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
    import org.springframework.cloud.client.loadbalancer.LoadBalanced;
    import org.springframework.cloud.netflix.hystrix.EnableHystrix;
    import org.springframework.context.annotation.Bean;
    import org.springframework.web.client.RestTemplate;
    
    @SpringBootApplication
    @EnableDiscoveryClient
    @EnableHystrix
    @EnableCircuitBreaker
    public class RibbonserviceApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(RibbonserviceApplication.class, args);
        }
    
        @Bean
        @LoadBalanced
        RestTemplate restTemplate() {
            return new RestTemplate();
        }
    
        @Bean
        public IRule ribbonRule() {
            return new RandomRule();	//这里配置策略，和配置文件对应
        }
    
        @Bean
        public ServletRegistrationBean getServlet(){
            HystrixMetricsStreamServlet streamServlet = new HystrixMetricsStreamServlet();
            ServletRegistrationBean registrationBean = new ServletRegistrationBean(streamServlet);
            registrationBean.setLoadOnStartup(1);
            registrationBean.addUrlMappings("/actuator/hystrix.stream");
            registrationBean.setName("HystrixMetricsStreamServlet");
            return registrationBean;
        }
    
    }

然后在配置文件里面加上下面这段配置：

management.endpoints.web.exposure.include= '*'
    management.endpoint.health.show-details= ALWAYS

这边最后的application.properties文件内容是（我这边有导入mysql，所以有datasource内容）:

server.port = 11000
    
    eureka.client.serviceUrl.defaultZone= http://localhost:12345/eureka/
    spring.application.name= SPRING-CLIENT-02
    
    SPRING-CLIENT-01.ribbon.NFLoadBalancerRuleClassName: com.netflix.loadbalancer.RandomRule
    
    spring.datasource.url=jdbc:mysql://127.0.0.1:3306/testmysql
    spring.datasource.username=root
    spring.datasource.password=123456
    spring.datasource.driver-class-name=com.mysql.jdbc.Driver
    spring.datasource.max-idle=10
    spring.datasource.max-wait=10000
    spring.datasource.min-idle=5
    spring.datasource.initial-size=5
    
    management.endpoints.web.exposure.include= '*'
    management.endpoint.health.show-details= ALWAYS

然后就依次运行eureka sever,eureka client，ribbon，和 Hystrix Dashboard服务。

我这边 Hystrix Dashboard配置的端口是10030。

第三个注意的地方是：由于监控的是ribbon，所以先要在浏览器中调用下ribbon里面的服务。这个参照之前[hystrix][]文章写的：在浏览器中输入：

http://localhost:10010/getInfoTwo

调用一下。

然后在浏览器中输入 Hystrix Dashboard的本地地址：

http://localhost:10030/hystrix

显示的界面就是：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhcnJ5cHR0ZXI_size_16_color_FFFFFF_t_70 1][]

这个是说明不同情况下不同的请求地址，前两个是对于集群模式使用的，最后一个是单节点模式使用的，此篇配置的是单节点模式，所以在页面的地址栏输入 http://localhost:11000/actuator/hystrix.stream

然后输入熔断器对应的ribbon stream地址 http://localhost:11000/actuator/hystrix.stream：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhcnJ5cHR0ZXI_size_16_color_FFFFFF_t_70 2][]

点击monitor stream按钮：

显示监控仪表盘界面：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhcnJ5cHR0ZXI_size_16_color_FFFFFF_t_70 3][]

**注：有可能你进来后页面显示的是 Loading... 状态，这个是因为你的服务没有被消费调用，所以此时没有数据监控，只要调用下被监控的服务，就会出现上图状态了。**

## 2、Feign方式 ##

在pom.xml中加入：

<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-actuator</artifactId>
            </dependency>

在feign启动类加入注解和代码：

package com.springcloudfeign.feign;
    
    import com.netflix.hystrix.contrib.metrics.eventstream.HystrixMetricsStreamServlet;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.boot.web.servlet.ServletRegistrationBean;
    import org.springframework.cloud.client.circuitbreaker.EnableCircuitBreaker;
    import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
    import org.springframework.cloud.netflix.hystrix.EnableHystrix;
    import org.springframework.cloud.openfeign.EnableFeignClients;
    import org.springframework.context.annotation.Bean;
    
    @SpringBootApplication
    @EnableDiscoveryClient
    @EnableFeignClients
    @EnableCircuitBreaker
    @EnableHystrix
    public class FeignApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(FeignApplication.class, args);
        }
    
        @Bean
        public ServletRegistrationBean getServlet(){
            HystrixMetricsStreamServlet streamServlet = new HystrixMetricsStreamServlet();
            ServletRegistrationBean registrationBean = new ServletRegistrationBean(streamServlet);
            registrationBean.setLoadOnStartup(1);
            registrationBean.addUrlMappings("/actuator/hystrix.stream");
            registrationBean.setName("HystrixMetricsStreamServlet");
            return registrationBean;
        }
    
    
    }

application.properties文件加上：

management.endpoints.web.exposure.include= '*'
    management.endpoint.health.show-details= ALWAYS

这样就可以了，然后先在浏览器中调用这个Feign 中的服务接口：参照之前构建[hystrix实现][hystrix]中在浏览器中输入：

http://localhost:10010/getInfoTwo

调用之后，在仪表盘界面中输入需要监控的页面地址：http://localhost:10010/actuator/hystrix.stream：

显示的结果界面：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhcnJ5cHR0ZXI_size_16_color_FFFFFF_t_70 4][]

这样基本的仪表盘监控就实现了。

仪表盘中：实心圆：颜色代表健康度，（绿-黄-红-橙递减）；大小代表并发量。

曲线：请求量的变化

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhcnJ5cHR0ZXI_size_16_color_FFFFFF_t_70 5][]

以上代码github地址： [源码地址][Link 1]

[hystrix]: https://blog.csdn.net/harryptter/article/details/88077753
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhcnJ5cHR0ZXI_size_16_color_FFFFFF_t_70]: /images/20220315/eaf1d002c09c471398010393427ff843.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhcnJ5cHR0ZXI_size_16_color_FFFFFF_t_70 1]: /images/20220315/784356c500294686aa3a6d644dc0c9a7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhcnJ5cHR0ZXI_size_16_color_FFFFFF_t_70 2]: /images/20220315/b1f1b40a5ada426a9693ff21a7cd7a1a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhcnJ5cHR0ZXI_size_16_color_FFFFFF_t_70 3]: /images/20220315/51813b80cfe0414b9f8d7b00abe74dfb.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhcnJ5cHR0ZXI_size_16_color_FFFFFF_t_70 4]: /images/20220315/731ac420fdea4ed4a878e7edea2169cd.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhcnJ5cHR0ZXI_size_16_color_FFFFFF_t_70 5]: /images/20220315/2066282a23894050b621ec3f859b6a65.png
[Link 1]: https://github.com/harrypitter/springCloudDemo.git