微服务监控 Spring Boot Admin

Spring Boot Admin用于管理和监控一个或者多个Spring Boot程序。分为Server端和Client端，Client端可以通过Http向Server端注册，也可以结合Spring Cloud的服务注册组件Eureka进行注册，它提供了UI界面，方便用于管理和监控。监控的内容包括Spring Boot的监控组件Actuator的各个Http节点。
本章依然使用前面讲解其他组件所建的工程，github地址。

监控Spring Cloud微服务

构建Admin Server

在之前的演示项目中创建一个Module工程，取名admin-server。

引入相关依赖，依赖和说明如下。

         <!--Admin Server-->
        <dependency>
            <groupId>de.codecentric</groupId>
            <artifactId>spring-boot-admin-server</artifactId>
            <version>1.5.1</version>
        </dependency>
        <!--Admin Server UI -->
        <dependency>
            <groupId>de.codecentric</groupId>
            <artifactId>spring-boot-admin-server-ui</artifactId>
            <version>1.5.1</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <!--eureka client -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka</artifactId>
        </dependency>
          <!--actuator的起步依赖 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <!--在管理界面需要与JMX-Beans进行交互，需要引入jolokia的依赖 -->
        <dependency>
            <groupId>org.jolokia</groupId>
            <artifactId>jolokia-core</artifactId>
        </dependency>

在配置文件中做相关配置，配置和说明如下。

server:
  port: 5000
eureka:
  client:
    service-url:
      defaultZone: http://localhost:8761/eureka/   # eureka注册中心地址
spring:
  application:
    name: admin-server
# spring boot默认开启env、metrics、dump、jolokia、info等节点，这里开启其它监控节点
  boot:
    admin:
      routes:
        endpoints: env,metrics,dump,jolokia,info,configprops,trace,logfile,refresh,flyway,liquibase,heapdump,loggers,auditevents,hystrix.stream,activiti
      turbine:
        clusters: default
        location: turbine-server
logging:
  file: "/logs/boot-admin-sample.log"  # 日志输出路径
management:
  security:
    enabled: false  # 在spring boot 1.5之后Actuator的所有API接口开启了安全认证，为了讲解方便，暂时先关闭。

配置日志管理Logback，在Resources目录下建一个logbook-spring.xml文件，代码如下

<?xml version="1.0" encoding="UTF-8" ?>
<configuration>
    <include resource="org/springframework/boot/logging/logback/base.xml"/>
    <jmxConfigurator/>
</configuration>

在程序启动类加上@EnableAdminServer注解开启Admin Server的功能，加上@EnableEurekaClient注解开启Eureka Client的功能。

@SpringBootApplication
@EnableEurekaClient
@EnableAdminServer
public class AdminServerApplication {
    public static void main(String[] args) {
        SpringApplication.run(AdminServerApplication.class, args);
    }
}

根据以上步骤一个Spring Boot Admin Server的雏形就搭建完成了。

搭建Admin Client

这里在之前的Mudule工程eureka-client基础上做改造。

添加Actuator的起步依赖，以及Jolokia的依赖。

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

        <dependency>
            <groupId>org.jolokia</groupId>
            <artifactId>jolokia-core</artifactId>
        </dependency>

在配置文件中添加日志的输出路径配置和关闭Actuator模块的安全验证。

logging:
  file: "logs/eureka-client.log"
management:
  security:
    enabled: false

依此启动eureka-server，admin-server，eureka-client。在本地localhost上访问admin-server的端口，显示的admin-server的界面如下。

image.png

APPLICATIONS选项展示了向eureka-server注册的所有客户端实例。
JOURNAL选项为服务注册、下载、剔除的时间线。
ABOUT选项是关于Spring Boot Admin的介绍。
APPLICATIONS面板的客户端实例右侧有个Detail按钮，点击可以进入客户端实例的详细界面。在详细界面可以查看客户端的实例信息、日志信息、指标信息、环境信息、日志级别的管理和JMX等。

集成Turbine

在介绍熔断器Hystrix
章节中提到，Turbine用于聚合多个Hystrix Dashboard，将多个Hystrix Dashboard组件的数据放在一个页面上展示，进行集中监控。在介绍了微服务监控Spring Boot Admin后，有人会问是不是可以把Hystrix的监控和服务的监控放在一起呢？答案是可以的。Spring Boot Admin Server中可以集成Turbine组件，这样可以让Turbine中展示的内容整合到Spring Boot Admin Server中，和服务实例一起监控，方便统一查看和管理。

改造服务实例（Eureka Client）

在介绍熔断器Hystrix时我们在eureka-ribbon-client和eureka-feign-client中已经集成了Hystrix和Hystrix DashBoard的依赖和相关操作，这里就用这两个服务实例来做改造。

在两个服务实例中添加Actuator的起步依赖。

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

这里服务实例的改造就完成了，重点是Hystrix、Hystrix DashBoard、Actuator的依赖。

构建Turbine工程

在项目中新建一个Module工程，取名为turbine-server。这个工程要提供Turbine的功能，聚合eureka-ribbon-client和eureka-feign-client的Hystrix DashBoard组件。

在pom文件中加eureka、actuator、turbine和jolokia的起步依赖。

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-turbine</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-netflix-turbine</artifactId>
        </dependency>

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

        <dependency>
            <groupId>org.jolokia</groupId>
            <artifactId>jolokia-core</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka</artifactId>
        </dependency>

在配置文件中配置turbine和eureka的相关配置。

server:
  port: 8770
spring:
  application:
    name: turbine-server
eureka:
  client:
    service-url:
      defaultZone: http://localhost:8761/eureka/    # eureka注册中心地址
turbine:
  app-config: eureka-ribbon-client,eureka-feign-client   # 聚合改造的两个服务实例的Hystrix DashBoard组件
  cluster-name-expression: new String("default")
  aggregator:
    clusterConfig: default

启动类中添加@EnableTurbine注解开启Turbine功能，@EnableEurekaClient开启eureka的功能。

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

在Admin Server中集成Turbine

在上一步已经已经实现了turbine-server来聚合Hystrix DashBoard的操作。这一步在admin-service中集成Turbine，并做与turbine-server的关联配置。

在admin-server添加Turbine和Hystrix的相关依赖如下。

        <dependency>
            <groupId>de.codecentric</groupId>
            <artifactId>spring-boot-admin-server-ui-turbine</artifactId>
            <version>1.5.1</version>
        </dependency>

        <dependency>
            <groupId>de.codecentric</groupId>
            <artifactId>spring-boot-admin-server-ui-hystrix</artifactId>
            <version>1.5.1</version>
        </dependency>

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

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

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-turbine</artifactId>
        </dependency>

在配置文件中配置turbine。

spring:
  application:
    name: admin-server
  boot:
    admin:
      routes:
        endpoints: env,metrics,dump,jolokia,info,configprops,trace,logfile,refresh,flyway,liquibase,heapdump,loggers,auditevents,hystrix.stream,activiti
      turbine:
        clusters: default
        location: turbine-server  # 配置turbine的服务名

在程序启动类加上@EnableTurbine注解开启Turbine功能,@EnableHystrix
开启Hystrix功能，@EnableHystrixDashboard开启Hystrix Dashboard的功能。

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

测试

依此启动eureka-server、eureka-ribbon-client、eureka-feign-client、turbine-server、admin-server工程。访问本地admin-server的启动端口，在右上角会多一个“TURBINE”的选项按钮。
访问eureka-feign-client，eureka-ribbon-client中的接口。点击TURBINE按钮。出现以下Hystrix的监控表明成功集成了turbine。

image.png

Spring Boot Admin添加安全登录界面

Spring Boot Admin Server的主页界面包含了太多的服务信息，如果我们不希望通过网址直接访问Spring Boot Admin Server的主页界面，此时可以添加安全登录功能。Spring Boot Admin提供了安全登录界面的组件，并且和Spring Boot Security相结合。

在admin-server中添加登录界面组件的依赖和Spring Boot Security的起步依赖。

        <dependency>
            <groupId>de.codecentric</groupId>
            <artifactId>spring-boot-admin-server-ui-login</artifactId>
            <version>1.5.0</version>
        </dependency>

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

在配置文件中创建一个security的user用户，它的用户名为admin，密码为123456。通过eureka.instance.metadate-map配置带上改security的user用户信息，这是因为在加了Spring Boot Security的起步依赖后，该项目的所有资源（包括静态的HTML、CSS、API接口等）都是受保护的，需要加上该管理员信息进行安全验证才能访问。

server:
  port: 5000
eureka:
  client:
    service-url:
      defaultZone: http://localhost:8761/eureka/
  instance:
    metadata-map:
      user.name: admin
      user.password: 123456
spring:
  application:
    name: admin-server
  boot:
    admin:
      routes:
        endpoints: env,metrics,dump,jolokia,info,configprops,trace,logfile,refresh,flyway,liquibase,heapdump,loggers,auditevents,hystrix.stream,activiti
      turbine:
        clusters: default
        location: turbine-server
logging:
  file: "/logs/boot-admin-sample.log"
management:
  security:
    enabled: false
security:
  user:
    name: admin
    password: 123456

写SecurityConfig的配置类，来配置登录信息。

public class SecurityConfig extends WebSecurityConfigurerAdapter {
    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http.formLogin().loginPage("/login.html")
                .loginProcessingUrl("/login").permitAll()
                .and()
                .logout().logoutUrl("/logout")
                .and()
                .csrf().disable()
                .authorizeRequests()
                .antMatchers("login.html","/**/**.css","/img/**","/third-party/**")
                .permitAll()
                .and()
                .authorizeRequests().antMatchers("/**").authenticated()
                .and()
                .httpBasic();
    }
}

由上所示配置了登录界面为“/login.html”,登出界面为“/logout”。这些界面以及静态资源都在引入的JAR中。给这些资源加上permitAll()方法表示不需要权限认证。除此之外的资源加上.authenticated()方法，表示需要权限认证。最后需要开启Http的基本认证，即.httpBasic()方法。

测试
重启admin-server工程。此时访问主界面会提示输入用户名和密码，输出正确后才能查看服务的监控信息。

image.png

总结

在这一章学习了微服务监控的组件 Spring Boot Admin。如何搭建一个Admin Server以及集成Turbine和设置安全登录认证。此时微服务相关的组件已经全部介绍完毕。在之后的学习中，一起学习这些组件在微服务实际开发中的应用和遇到的问题。