欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

SpringCloud之熔断监控Hystrix Dashboard的实现

程序员文章站 2022-10-25 18:39:31
前言 springcloud 是微服务中的翘楚,最佳的落地方案。 springcloud 中的 hystrix 组件可以实现熔断,而在实际情况中,一般还需要直...

前言

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 文件

<?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>
 
  <!-- 三坐标 -->
  <groupid>com.zwc</groupid>
  <artifactid>springcloud-dashboard-commons</artifactid>
  <version>1.0</version>
 
  <!-- 工程名称和描述 -->
  <name>springcloud-dashboard-commons</name>
  <description>公用工程</description>
 
  <!-- 打包方式 -->
  <packaging>jar</packaging>
 
  <!-- 在 properties下声明相应的版本信息,然后在dependency下引用的时候用 ${} 就可以引入该版本jar包了 -->
  <properties>
    <!-- 编码 -->
    <project.build.sourceencoding>utf-8</project.build.sourceencoding>
    <!-- jdk -->
    <java.version>1.8</java.version>
 
    <!-- springboot -->
    <platform-bom.version>cairo-sr3</platform-bom.version>
 
    <!-- springcloud -->
    <spring-cloud-dependencies.version>finchley.release</spring-cloud-dependencies.version>
  </properties>
 
  <!-- 加入依赖 -->
  <dependencies>
 
  </dependencies>
 
  <!-- 依赖 jar 包版本管理的管理器 -->
  <!-- 如果 dependencies 里的 dependency 自己没有声明 version 元素,那么 maven 就此处来找版本声明。 -->
  <!-- 如果有,就会继承它;如果没有就会报错,告诉你没有版本信息 -->
  <!-- 优先级:如果 dependencies 里的 dependency 已经声明了版本信息,就不会生效此处的版本信息了 -->
  <dependencymanagement>
    <dependencies>
      <!-- springboot -->
      <dependency>
        <groupid>io.spring.platform</groupid>
        <artifactid>platform-bom</artifactid>
        <version>${platform-bom.version}</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
      <!-- springcloud -->
      <dependency>
        <groupid>org.springframework.cloud</groupid>
        <artifactid>spring-cloud-dependencies</artifactid>
        <version>${spring-cloud-dependencies.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>

配置一些共用依赖

commons 工程 - 项目结构

SpringCloud之熔断监控Hystrix Dashboard的实现

service 工程

  ① 此工程下有三个模块:一个注册中心以及服务 a、b

  ② a 提供服务并且调用服务 b 以及 b 提供服务

registry-service(注册中心)

registry-service - pom 文件

<?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>com.zwc</groupid>
    <artifactid>springcloud-dashboard-service</artifactid>
    <version>1.0</version>
  </parent>
 
  <!-- 三坐标 -->
  <groupid>com.zwc</groupid>
  <artifactid>springcloud-dashboard-registry-service</artifactid>
  <version>1.0</version>
 
  <!-- 工程名称描述 -->
  <name>springcloud-dashboard-registry-service</name>
  <description>注册中心</description>
 
  <!-- 打包方式 -->
  <packaging>jar</packaging>
 
  <!-- 在 properties下声明相应的版本信息,然后在dependency下引用的时候用 ${} 就可以引入该版本jar包了 -->
  <properties>
 
  </properties>
 
  <!-- 加入依赖 -->
  <dependencies>
    <!-- commons工程 依赖 -->
    <dependency>
      <groupid>com.zwc</groupid>
      <artifactid>springcloud-dashboard-commons</artifactid>
      <version>1.0</version>
    </dependency>
 
    <!-- 服务注册中心 -->
    <dependency>
      <groupid>org.springframework.cloud</groupid>
      <artifactid>spring-cloud-starter-netflix-eureka-server</artifactid>
    </dependency>
  </dependencies>
 
  <!-- 插件依赖 -->
  <build>
    <plugins>
      <plugin>
        <groupid>org.springframework.boot</groupid>
        <artifactid>spring-boot-maven-plugin</artifactid>
      </plugin>
    </plugins>
  </build>
 
</project>

主要是加入 spring-cloud-starter-netflix-eureka-server 依赖

registry-service - application.yml 配置文件

# 端口
server:
 port: 8761
 
# 应用名称
spring:
 application:
  name: eureka-server
 
eureka:
 instance:
  # 使用 ip 代替实例名
  prefer-ip-address: true
  # 实例的主机名
  hostname: ${spring.cloud.client.ip-address}
  # 实例的 id 规则
  instance-id: ${spring.cloud.client.ip-address}:${spring.application.name}:${server.port}
 client:
  # 是否向注册中心注册自己
  registerwitheureka: false
  # 是否向注册中心获取注册信息
  fetchregistry: false
  serviceurl:
   # 注册中心地址
   defaultzone: http://${eureka.instance.hostname}:${server.port}/eureka/

这里使用了默认的 8761 端口,当然也可以更改,不过在发现调用服务端的注册中心地址端口要与它一致

registry-service - 启动类

package com.zwc;
 
import org.springframework.boot.springapplication;
import org.springframework.boot.autoconfigure.springbootapplication;
import org.springframework.cloud.netflix.eureka.server.enableeurekaserver;
 
@springbootapplication
@enableeurekaserver
public class springclouddashboardregistryserviceapplication {
 
  public static void main(string[] args) {
    springapplication.run(springclouddashboardregistryserviceapplication.class, args);
  }
 
}

在启动类中添加 @enableeurekaserver 注解表示此工程是注册中心registry-service - 启动项目

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

SpringCloud之熔断监控Hystrix Dashboard的实现

服务工程 a(提供者和消费者)

服务工程 a - pom 文件

<?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>com.zwc</groupid>
    <artifactid>springcloud-dashboard-a-service</artifactid>
    <version>1.0</version>
  </parent>
 
  <!-- 三坐标 -->
  <groupid>com.zwc</groupid>
  <artifactid>springcloud-dashboard-a-service-core</artifactid>
  <version>1.0</version>
 
  <!-- 工程名称描述 -->
  <name>springcloud-dashboard-a-service-core</name>
  <description>服务工程 - a 核心</description>
 
  <!-- 打包方式 -->
  <packaging>jar</packaging>
 
  <!-- 在 properties下声明相应的版本信息,然后在dependency下引用的时候用 ${} 就可以引入该版本jar包了 -->
  <properties>
 
  </properties>
 
  <!-- 加入依赖 -->
  <dependencies>
    <!-- commons工程 依赖 -->
    <dependency>
      <groupid>com.zwc</groupid>
      <artifactid>springcloud-dashboard-commons</artifactid>
      <version>1.0</version>
    </dependency>
 
    <!-- api工程 依赖 -->
    <dependency>
      <groupid>com.zwc</groupid>
      <artifactid>springcloud-dashboard-a-service-api</artifactid>
      <version>1.0</version>
    </dependency>
 
    <!-- 提供者消费者 -->
    <dependency>
      <groupid>org.springframework.cloud</groupid>
      <artifactid>spring-cloud-starter-netflix-eureka-client</artifactid>
    </dependency>
    <!-- feign -->
    <dependency>
      <groupid>org.springframework.cloud</groupid>
      <artifactid>spring-cloud-starter-openfeign</artifactid>
    </dependency>
    <!-- actuator -->
    <dependency>
      <groupid>org.springframework.boot</groupid>
      <artifactid>spring-boot-starter-actuator</artifactid>
    </dependency>
    <!-- hystrix -->
    <dependency>
      <groupid>org.springframework.cloud</groupid>
      <artifactid>spring-cloud-starter-netflix-hystrix</artifactid>
    </dependency>
    <!-- dashboard -->
    <dependency>
      <groupid>org.springframework.cloud</groupid>
      <artifactid>spring-cloud-starter-netflix-hystrix-dashboard</artifactid>
    </dependency>
  </dependencies>
 
  <!-- 插件依赖 -->
  <build>
    <plugins>
      <plugin>
        <groupid>org.springframework.boot</groupid>
        <artifactid>spring-boot-maven-plugin</artifactid>
      </plugin>
    </plugins>
  </build>
 
</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 配置文件

# 端口
server:
 port: 8090
 
# 应用名称
spring:
 application:
  name: dashboard-a
 
eureka:
 instance:
  # 使用 ip 代替实例名
  prefer-ip-address: true
  # 实例的主机名
  hostname: ${spring.cloud.client.ip-address}
  # 实例的 id 规则
  instance-id: ${spring.cloud.client.ip-address}:${spring.application.name}:${server.port}
 client:
  serviceurl:
   # 注册中心地址
   defaultzone: http://${eureka.instance.hostname}:8761/eureka/
 
management:
 endpoints:
  web:
   exposure:
    # 开启监控端点
    include: hystrix.stream
   base-path: /
  • 注意此处配置注册中心地址的端口为 8761 也就是上面注册中心工程配置的端口
  • spring.application.name:应用名称,被消费者调用时需要用到,它在消费的同时也可以被消费
  • 另一个服务工程 b 配置与此类似,只是端口不一样,不再赘述
  • 在 2.0 后需要主动开启端点 hystrix.stream,否则 404

服务工程 a -  application.properties(注意)

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

服务工程 a -  bootstrap.yml(注意)

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

服务工程 a - controller 前端控制器(提供服务)

package com.zwc.a.controller;
 
import org.springframework.beans.factory.annotation.value;
import org.springframework.web.bind.annotation.requestmapping;
import org.springframework.web.bind.annotation.restcontroller;
 
/*
 * @classname asayhellocontroller
 * @desc todo  say hello
 * @date 2019/5/20 23:24
 * @version 1.0
 */
@restcontroller
public class asayhellocontroller {
 
  /*
   * @classname asayhellocontroller
   * @desc todo  读取配置文件中的端口
   * @date 2019/5/20 23:24
   * @version 1.0
   */
  @value("${server.port}")
  private string port;
 
  /*
   * @classname asayhellocontroller
   * @desc todo  say hello
   * @date 2019/5/20 23:24
   * @version 1.0
   */
  @requestmapping("/a")
  public string a(){
    return "hello!i'm a. port:" + port;
  }
 
}

提供一个服务:输出 hello 和端口

服务工程 a - 服务调用

package com.zwc.a.api.feign;
 
import com.zwc.a.api.impl.feignapifallback;
import org.springframework.cloud.openfeign.feignclient;
import org.springframework.web.bind.annotation.requestmapping;
 
/*
 * @classname feignapi
 * @desc todo  使用 feign 调用 b - 接口
 * @date 2019/5/20 23:21
 * @version 1.0
 */
@feignclient(value = "dashboard-b" , fallback = feignapifallback.class)
public interface feignapi {
 
  /*
   * @classname feignapi
   * @desc todo  通过 dashboard-b 服务名调用 b() 方法
   * @date 2019/5/20 23:21
   * @version 1.0
   */
  @requestmapping("/b")
  string b();
 
}
  • 通过 @feignclient 注解中 value = "dashboard-b" 来指定调用哪个服务
  • dashboard-b 就是提供者的 spring.application.name:应用名称
  • 通过 @feignclient 注解中 fallback = feignapifallback.class 来指定熔断时调用的方法
  • feignapifallback 就是此类(feignapi)的实现类,对应的实现方法就是此类的熔断时调用的方法
  • b():此方法是 b 工程中提供的服务,在这里定义成接口
  • 注意要与提供者具有相同返回值,相同方法名以及相同参数

服务工程 a - fallback(feignapifallback)

package com.zwc.a.api.impl;
 
import com.zwc.a.api.feign.feignapi;
import org.springframework.stereotype.component;
 
/*
 * @classname feignapi
 * @desc todo  fallback
 * @date 2019/5/20 23:21
 * @version 1.0
 */
@component
public class feignapifallback implements feignapi {
 
  /*
   * @classname feignapifallback
   * @desc todo  调用 dashboard-b 服务中的 b() 方法失败时执行
   * @date 2019/5/20 23:31
   * @version 1.0
   */
  @override
  public string b() {
    return "hello!auseb fail";
  }
}

使用 @component 注解把此类交给 spring 管理

实现了 feignapi 接口,提供熔断时对应的方法

服务工程 a - controller 前端控制器(消费服务)

package com.zwc.a.controller;
 
import com.zwc.a.api.feign.feignapi;
import org.springframework.beans.factory.annotation.autowired;
import org.springframework.web.bind.annotation.requestmapping;
import org.springframework.web.bind.annotation.restcontroller;
 
/*
 * @classname ausebfeigncontroller
 * @desc todo  使用 feign 调用 b - 前端控制器
 * @date 2019/5/20 23:23
 * @version 1.0
 */
@restcontroller
public class ausebfeigncontroller {
 
  @autowired(required = false)
  private feignapi feignapi;
 
  /*
   * @classname feigncontroller
   * @desc todo  通过 dashboard-b 服务名调用 b() 方法
   * @date 2019/5/20 23:13
   * @version 1.0
   */
  @requestmapping("/auseb")
  public string auseb(){
    return feignapi.b();
  }
 
}

使用 @autowired 注解装配 bean,通过此 bean 中的方法调用服务

此类对外暴露接口,调用的实则是提供者的服务

服务工程 a - 启动类

package com.zwc;
 
import org.springframework.boot.springapplication;
import org.springframework.boot.autoconfigure.springbootapplication;
import org.springframework.cloud.netflix.eureka.enableeurekaclient;
import org.springframework.cloud.netflix.hystrix.enablehystrix;
import org.springframework.cloud.netflix.hystrix.dashboard.enablehystrixdashboard;
import org.springframework.cloud.openfeign.enablefeignclients;
 
@springbootapplication
@enableeurekaclient
@enablefeignclients
@enablehystrix
@enablehystrixdashboard
public class springclouddashboardaservicecoreapplication {
 
  public static void main(string[] args) {
    springapplication.run(springclouddashboardaservicecoreapplication.class, args);
  }
 
}
  • 添加 @enableeurekaclient 注解表示此工程可以向注册中心提供服务
  • 添加 @enablefeignclients 注解表示开启 feign 功能进行远程调用
  • 添加 @enablehystrix 注解表示开启熔断器
  • 添加 @enablehystrixdashboard 注解表示开启熔断监控

服务工程 a - 启动项目

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

  SpringCloud之熔断监控Hystrix Dashboard的实现

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

SpringCloud之熔断监控Hystrix Dashboard的实现

  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 中的熔断监控页面,可以看到

  SpringCloud之熔断监控Hystrix Dashboard的实现

 10. 启动服务工程 b,项目启动成功后再次访问:http://localhost:8090/auseb (调用 b 工程的服务)

 11. 输出内容:'hello!i'm b. port:8091' (如果还未调用成功,等待一会再刷新试试)

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

SpringCloud之熔断监控Hystrix Dashboard的实现

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

 14. 左边的六个数字对应着页面右上角的六个状态(success、short-circuited..) 

service 工程 - 项目结构

SpringCloud之熔断监控Hystrix Dashboard的实现

把多工程项目使用 intellij idea  打开

  • 把项目从 github 中下载到你的本地
  • 打开 intellij idea 
  • 点击 file -> open
  • 打开你下载到本地的项目目录
  • springcloud-dashboard -> springcloud-dashboard-service(选择打开此工程)
  • 打开 service 工程后
  • 再次点击 file -> project structrue
  • 选择 modules,点击 '+' 符号
  • 点击 import  module
  • 还是打开你下载到本地的项目目录
  • springcloud-dashboard -> springcloud-dashboard-commons -> pom.xml
  • 点击 ok
  • 点击 next,finish
  • 点击 apply,ok

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。