跟我学SpringCloud-第五篇熔断监控Hystrix-Dashboard和Turbine

jiezi

5 年前

Springboot: 2.1.6.RELEASE

SpringCloud: Greenwich.SR1

如无特殊说明，本系列教程全采用以上版本

Hystrix-dashboard 是一款针对 Hystrix 进行实时监控的工具，通过 Hystrix Dashboard 我们可以在直观地看到各 Hystrix Command 的请求响应时间, 请求成功率等数据。但是只使用 Hystrix Dashboard 的话, 你只能看到单个应用内的服务信息, 这明显不够。我们需要一个工具能让我们汇总系统内多个服务的数据并显示到 Hystrix Dashboard 上, 这个工具就是 Turbine。

创建一个新的项目 hystrix-dashboard，延用上一篇文章提到的 eureka 和 producer 两个项目。

<?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.6.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.springcloud</groupId>
    <artifactId>hystrix-dashboard</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>hystrix-dashboard</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
        <spring-cloud.version>Greenwich.SR1</spring-cloud.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</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-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-openfeign</artifactId>
        </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>

</project>

前面介绍过的包我这里不再多说，讲几个前面没有见过的包：

actuator： 这个包是用来做服务监控的，很多监控相关的功能都会用到这个包，具体的内容我这里先不讲，后面会专门有一篇来讲这个。
hystrix-dashboard： 这个是今天的主角，hystrix-dashboard 帮我们封装好了 hystrix 的监控面板。

package com.springcloud.hystrixdashboard;

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.netflix.eureka.EnableEurekaClient;
import org.springframework.cloud.netflix.hystrix.dashboard.EnableHystrixDashboard;
import org.springframework.cloud.openfeign.EnableFeignClients;
import org.springframework.context.annotation.Bean;

@SpringBootApplication
@EnableEurekaClient
@EnableFeignClients
@EnableHystrixDashboard
@EnableCircuitBreaker
public class HystrixDashboardApplication {public static void main(String[] args) {SpringApplication.run(HystrixDashboardApplication.class, args);
    }

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

}

启动类添加启用 Hystrix Dashboard 和熔断器

注意： 各位看官这里一定要注意，我在这里注册了 HystrixMetricsStreamServlet，在 springboot1.x 版本下，这里是无需注册的，在 2.x 版本后，这里才需要注册 HystrixMetricsStreamServlet，并且显示的给出访问路径。

server:
  port: 8081
spring:
  application:
    name: spring-cloud-hystrix-dashboard
eureka:
  client:
    service-url:
      defaultZone: http://localhost:8761/eureka/
feign:
  hystrix:
    enabled: true

又到了测试时间，我们先把昨天的 eureka 和 producer CV 到今天的工作目录下，顺次启动服务，HystrixDashboard 最后启动，启动完成后我们访问：http://localhost:8081/hystrix，将会看到如下界面：

图中会有一些提示：

Cluster via Turbine (default cluster): http://turbine-hostname:port/turbine.stream

Cluster via Turbine (custom cluster): http://turbine-hostname:port/turbine.stream?cluster=[clusterName]

Single Hystrix App: http://hystrix-app:port/hystrix.stream

大致大概意思就是如果查看默认集群使用第一个 url, 查看指定集群使用第二个 url, 单个应用的监控使用最后一个，我们暂时只演示单个应用的所以在输入框中输入：http://localhost:8081/hystrix.stream，输入之后点击 monitor，进入页面。

如果没有请求会先显示 Loading …，访问 http://localhost:8081/hystrix.stream 也会不断的显示 ping。

我们请求一下昨天用过的链接：http://localhost:8081/hello/spring。

马上就能看到统计信息了。

可以再访问一下 http://localhost:8081/hystrix.stream，显示如下：

ping: 

data: {"type":...}

data: {"type":...}

说明已经返回了监控的各项结果.

到了监控页面就会显示如下图所示：

其实就是 http://localhost:8081/hystrix.stream 返回结果的图形化显示，Hystrix Dashboard Wiki 上详细说明了图上每个指标的含义，如下图：

到此单个应用的熔断监控已经完成。

在复杂的分布式系统中，相同服务的节点经常需要部署上百甚至上千个，很多时候，运维人员希望能够把相同服务的节点状态以一个整体集群的形式展现出来，这样可以更好的把握整个系统的状态。为此，Netflix 提供了一个开源项目（Turbine）来提供把多个 hystrix.stream 的内容聚合为一个数据源供 Dashboard 展示。

<?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.6.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.springcloud</groupId>
    <artifactId>turbine</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>turbine</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
        <spring-cloud.version>Greenwich.SR1</spring-cloud.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</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-turbine</artifactId>
        </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>

</project>

server:
  port: 8888
spring:
  application:
    name: hystrix-dashboard-turbine
turbine:
  app-config: node01,node02
  aggregator:
    cluster-config: default
  cluster-name-expression: new String("default")
  combine-host-port: true
eureka:
  client:
    service-url:
      defaultZone: http://localhost:8761/eureka/

turbine.appConfig： 配置 Eureka 中的 serviceId 列表，表明监控哪些服务
turbine.aggregator.clusterConfig： 指定聚合哪些集群，多个使用”,”分割，默认为 default。可使用 http://…/turbine.stream?clu…{clusterConfig 之一} 访问
turbine.clusterNameExpression： 1. clusterNameExpression 指定集群名称，默认表达式 appName；此时：turbine.aggregator.clusterConfig 需要配置想要监控的应用名称；2. 当 clusterNameExpression: default 时，turbine.aggregator.clusterConfig 可以不写，因为默认就是 default；3. 当 clusterNameExpression: metadata[‘cluster’] 时，假设想要监控的应用配置了 eureka.instance.metadata-map.cluster: ABC，则需要配置，同时 turbine.aggregator.clusterConfig: ABC

启动类添加 @EnableTurbine，激活对 Turbine 的支持

package com.springcloud.turbine;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.hystrix.dashboard.EnableHystrixDashboard;
import org.springframework.cloud.netflix.turbine.EnableTurbine;

@SpringBootApplication
@EnableHystrixDashboard
@EnableTurbine
public class TurbineApplication {public static void main(String[] args) {SpringApplication.run(TurbineApplication.class, args);
    }

}

将昨天的消费者 copy2 份到今天的文件路径下，修改名称为 consumers-node01，consumers-node02

增加依赖包

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-hystrix-dashboard</artifactId>
</dependency>

启动类增加 HystrixMetricsStreamServlet 注册

package com.springcloud.consumers;

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.netflix.eureka.EnableEurekaClient;
import org.springframework.cloud.openfeign.EnableFeignClients;
import org.springframework.context.annotation.Bean;

@SpringBootApplication
@EnableEurekaClient
@EnableFeignClients
public class ConsumersApplication {public static void main(String[] args) {SpringApplication.run(ConsumersApplication.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;
    }
}

注意： 这里注册的 HystrixMetricsStreamServlet 访问路径是 ”/actuator/hystrix.stream”，这是因为 Turbine 默认访问的是这个路径。

两个配置文件大家自行修改启动端口号，spring.application.name 分别修改为 node01 和 node02

现在依次启动注册中心，两个消费者和 Turbine，顺次访问两个消费者，并访问 http://localhost:8888/turbine.stream，会返回和上面一样的一穿 ping 的信息。

并且会不断刷新以获取实时的监控数据，说明和单个的监控类似，返回监控项目的信息。

进行图形化监控查看，输入：http://localhost:8888/hystrix，返回酷酷的小熊界面，输入：http://localhost:8888/turbine.stream，然后点击 Monitor Stream , 可以看到出现了俩个监控列表（这是理论情况）

注意，这里本地环境无法测试成功，本地环境只能显示一个服务，Turbine 日志中会报错

你的主机中的软件中止了一个已建立的连接。

原因目前不明，已经在 github 上提 Issues。

示例代码 -Github

跟我学SpringCloud-第五篇熔断监控Hystrix-Dashboard和Turbine

SpringCloud 系列教程 | 第五篇：熔断监控 Hystrix Dashboard 和 Turbine

1. Hystrix Dashboard

1. hystrix-dashboard pom.xml 依赖包管理

2. 启动类 HystrixDashboardApplication.java

3. 配置文件

4. 测试

2. Turbine

1. Turbine pom.xml

2. 配置文件

3. 启动类

4. 创建消费者集群

5. 测试