Spring Boot Admin

本文将介绍如何使用 SpringBoot Admin 对 SpringBoot 应用进行监控。

一、SpringBoot Actuator

SpringBoot Actuator

二、什么是 SpringBoot Admin ？

虽然 Actuator 能够实现对 SpringBoot 应用的监控，但它仍有以下问题：

  • 需要调用接口来查看信息
  • 返回的 JSON 格式的信息不便于运营人员的理解

在这种背景下，诞生了另一个开源的监控工具：SpringBoot Admin。

它基于 SpringBoot Actuator，提供了简洁明了的可视化界面。

三、说明

SpringBoot Admin 分为两个部分：

  • Server 端：用于展示监控信息的服务端，应该是一个单独的 SpringBoot 应用，专门用于展示监控信息
  • Client 端：被监控的对象，需要引入依赖，并在配置文件中配置相关信息即可

四、基本使用

1. 服务端

(1) 添加依赖

依赖版本过低可能导致启动错误，请前往 mavan 仓库查看版本

在 pom.xml 中添加：

1
2
3
4
5
6
7
8
9
10
<dependency>
    <groupId>de.codecentric</groupId>
    <artifactId>spring-boot-admin-starter-server</artifactId>
    <version>2.5.4</version>
</dependency>

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

(2) 配置

在配置文件中添加信息如下：

1
server.port=端口

为 SpringBoot Admin 服务端指定端口号。

(3) 添加注解

为 SpringBoot 的启动类添加 @EnableAdminServer 注解。

(4) 访问服务端

2. 客户端

(1) 添加依赖

依赖版本过低可能导致启动错误，请前往 mavan 仓库查看版本

在 pom.xml 中添加：

1
2
3
4
5
6
7
8
9
10
<dependency>
    <groupId>de.codecentric</groupId>
    <artifactId>spring-boot-admin-starter-client</artifactId>
    <version>2.5.4</version>
</dependency>

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

(2) 配置

在配置文件中添加信息如下：

1
2
3
4
5
6
7
8
# 指定客户端的运行端口
server.port=端口
# 指定客户端名
spring.application.name=Admin Client
# 指定服务端的地址
spring.boot.admin.client.url=http://localhost:8000
# 指定Actuator监控开放哪些端口
management.endpoints.web.exposure.include=*

3. 查看监控效果

启动服务端和客户端，重新访问服务端，便可以在网页中查看到客户端的各种信息：

参考