微服務監控: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監控界面,如下所示:

也能看到一些日誌信息以及詳細的運行數據:

發佈了65 篇原創文章 · 獲贊 86 · 訪問量 9萬+
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章