微服务监控：Spring Boot Admin

目录

1 Admin Server

1.1 pom.xml

1.2 application.properties

1.3 启动类

2 Admin Client

2.1 pom.xml

2.2 application.properties

3 运行及结果

---

虽然Spring Boot Actuator提供了对单个Spring Boot项目的监控，但是它是通过访问URL的方式来进行查看的，对于一个包含十几个乃至数十个微服务的微服务架构项目来说，每个微服务都需要调用不同的URL来查看监控信息，操作起来非常麻烦。而且监控的信息是json格式的，不方便运营人员查看。

而Spring Boot Admin是一个管理和监控Spring Boot应用程序的开源软件，它是在Spring Boot Actuator的基础上提供简洁的可视化WEB UI。在Spring Boot Admin体系中，每个应用都是一个客户端，通过HTTP或者使用Eureka注册到Admin Server中进行展示，而Spring Boot Admin UI则使用VueJs将数据展示在前端。Spring Boot Admin主要提供了如下数据展示功能：

• 展示客户端的健康状况
• 展示应用的一些详细信息，例如JVM运行状况、内存使用情况、数据库使用情况以及缓存情况等
• 展示项目构建信息
• 查看项目运行日志
• 查看Spring Boot配置信息
• 查看JVM和环境信息
• 支持Spring Cloud的postable /env- 和/refresh-endpoint
• 容易的日志级别管理
• 可以方便的与JMX-beans进行交互
• 查看线程堆栈
• 查看HTTP追踪信息
• 查看auditevents、http-endpoints、定时任务、数据库迁移
• 下载headump
• 邮件报警
• 等等…

笔者使用的Java版本是jdk-8u201，IDE使用的是IntelliJ IDEA 2019.3 x64，Spring Boot的版本是2.1.7.RELEASE，Spring Cloud的版本是Greenwich.SR2，Spring Boot Admin的版本是2.1.6。同时本文所使用的项目代码沿用笔者之前写过的文章《Spring Cloud链路跟踪：Sleuth+Zipkin》中的项目代码，并在此基础上进行继续开发。

---

1 Admin Server

创建一个Spring Boot项目，命名为admin-server。

1.1 pom.xml

<?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 https://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.7.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.hys</groupId>
    <artifactId>admin-server</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>admin-server</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
        <spring-boot-admin.version>2.1.6</spring-boot-admin.version>
        <spring-cloud.version>Greenwich.SR2</spring-cloud.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>de.codecentric</groupId>
            <artifactId>spring-boot-admin-starter-server</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</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>
            <dependency>
                <groupId>de.codecentric</groupId>
                <artifactId>spring-boot-admin-dependencies</artifactId>
                <version>${spring-boot-admin.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>

1.2 application.properties

spring.application.name=admin-server
eureka.client.service-url.defaultZone=http://peer1:1111/eureka/,http://peer2:1112/eureka/,http://peer3:1113/eureka/
management.endpoints.web.exposure.include=*

其中最后一行配置是为了暴露所有的监控端点。

1.3 启动类

import de.codecentric.boot.admin.server.config.EnableAdminServer;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@EnableAdminServer
@SpringBootApplication
public class AdminServerApplication {

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

}

在启动类上加上@EnableAdminServer注解，表示开启 AdminServer。

---

2 Admin Client

这里改造之前写过的hello-service及feign-consumer项目代码，以此来支持Spring Boot Admin Client。

2.1 pom.xml

以下以hello-service的pom文件为例，feign-consumer项目代码的改造也类似，只是添加了Spring Boot Admin Client依赖而已：

<?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.7.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.hys</groupId>
    <artifactId>hello-service</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>hello-service</name>
    <description>Demo project for Spring Cloud</description>

    <properties>
        <java.version>1.8</java.version>
        <spring-boot-admin.version>2.1.6</spring-boot-admin.version>
        <spring-cloud.version>Greenwich.SR2</spring-cloud.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-sleuth</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-zipkin</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>de.codecentric</groupId>
            <artifactId>spring-boot-admin-starter-client</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>
            <dependency>
                <groupId>de.codecentric</groupId>
                <artifactId>spring-boot-admin-dependencies</artifactId>
                <version>${spring-boot-admin.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>

2.2 application.properties

配置文件继续沿用之前的代码，并且加上以下的配置：

management.endpoints.web.exposure.include=*

和AdminServer端一样,暴露所有端口信息。

---

3 运行及结果

依次启动eureka-server、admin-server、hello-service和feign-consumer，启动成功后访问http://localhost:8080/，以此来查看Spring Boot Admin的UI监控界面，如下所示：

也能看到一些日志信息以及详细的运行数据：