Spring Boot Admin，贼好使！

怼烎@ 2023-10-01 12:59 7阅读 0赞

![d8975943091ab7db2d413ca3b2c047aa.png][]

作者 | 磊哥

来源 | Java中文社群（ID：javacn666）

转载请联系授权（微信ID：GG\_Stone）

Spring Boot Admin（SBA）是一个开源的社区项目，用于管理和监控 Spring Boot 应用程序。应用程序可以通过 http 的方式，或 Spring Cloud 服务发现机制注册到 SBA 中，然后就可以实现对 Spring Boot 项目的可视化管理和查看了。

Spring Boot Admin 可以监控 Spring Boot 单机或集群项目，它提供详细的健康 （Health）信息、内存信息、JVM 系统和环境属性、垃圾回收信息、日志设置和查看、定时任务查看、Spring Boot 缓存查看和管理等功能。接下来我们一起来搭建和使用吧。

它最终的展示效果如下：

![5b47ba451705ec0341db00c21efcc4d2.png][]

### 1.搭建SBA监控端 ###

我们需要创建一个 Spring Boot Admin 项目，用来监控和管理我们的 Spring Boot 项目，搭建的方式和创建普通的 Spring Boot 项目类似，具体步骤如下。使用 Idea 创建一个 Spring Boot 项目：![8f328c65f23ebd9efd5b8275106f4f9f.png][]![dca2868f8dee6e512ddff533ca9e6862.png][]这里需要注意，需要添加 Spring Boot Admin（Server）服务端框架的支持，如下图所示：![96409e51dacfc673f4e4753ce48a8f58.png][]也就是创建的 Spring Boot 项目需要添加以下两个重要的框架支持：

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

#### 1.1 开启SBA服务 ####

创建完项目之后，需要在启动类上开启 SBA 服务：

import de.codecentric.boot.admin.server.config.EnableAdminServer;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @EnableAdminServer // 添加此行代码
    @SpringBootApplication 
    public class SbaserverApplication {
        public static void main(String[] args) {
            SpringApplication.run(SbaserverApplication.class, args);
        }
    }

#### 1.2 配置SBA端口号 ####

在 application.properties 中配置一个项目的端口号就可以直接启动了，我配置的端口号是 9001：

server.port=9001

> PS：配置端口号的主要目的是为了不和其他 Spring Boot 项目冲突，如果 SBA 是单独部署此步骤可以忽略。

启动项目之后，就可以看到 SBA 的主页了，如下图所示：![ec605f6357e7c058d68e10008d222f72.png][]此时 SBA 中还没有添加任何需要监控的项目，接下来我们再创建一个 Spring Boot 项目，加入到 SBA 中来进行监控和管理吧。

### 2.创建一个普通SpringBoot项目 ###

首先，我们需要创建一个普通的 Spring Boot 项目，具体的创建步骤这里就不演示了。当创建好 Spring Boot 项目之后，需要在这个 Spring Boot 项目中需要添加 SBA 客户端框架的支持，也就是在 pom.xml 中配置如下内容：

<dependency>
      <groupId>de.codecentric</groupId>
      <artifactId>spring-boot-admin-starter-client</artifactId>
    </dependency>

然后在 application.properties 文件中配置 SBA 服务器端地址，也就是咱们第一步创建 SBA 项目的地址，配置内容如下：

# 当前项目端口号
    server.port=8080
    # Spring Boot Admin 监控服务器端地址
    spring.boot.admin.client.url=http://localhost:9001

其中“spring.boot.admin.client.url”为 SBA 监控地址。

### 3.SpringBootAdmin监控总览 ###

配置完以上信息之后，此时查看 Spring Boot Admin 页面中就有被监控的 Spring Boot 项目了，如下图所示：![3868e6d0dd0fbb524c059be38ecacb5d.png][]也可以点击“应用墙”查看 Spring Boot Admin 中所有被监控的 Spring Boot 项目，如下图所示：![91a337616e88f86c85ef2f501a9c13f0.png][]点击应用进入详情页面，如下图所示：![b1b0390dd0ba1322af4a771895afabed.png][]![4b4a9a9792f7fc3f20a67d8931833cb8.png][]事件日志中包含 Spring Boot 各种状态的展示（UP 为正常、OFFLINE 为异常）和发生的时间，如下图所示：![c48bc13a5ac74d666e4d4cc52da95323.png][]

### 4.SpringBoot异常监控 ###

当我们手动把被监控的 Spring Boot 项目停止之后，在 Spring Boot Admin 中就可以查看到一个应用已经被停掉了，如下图所示：![1b53449b05fa1f2725bc1a39058bccab.png][]我们也可以通过事件日志查看 Spring Boot 宕机的具体时间，如下图所示：![8130c1057c5b1391b9dbb4aa4def030c.png][]

### 5.配置查看更多监控项 ###

通过上面的内容我们可以看出，监控的 Spring Boot 选项还是比较少的，怎么才能查看更多的监控项呢？要解决这个问题，我们需要在被监控的 Spring Boot 项目中添加 spring-boot-starter-actuator 框架的支持，并开启查看所有监控项的配置才行，最终展示效果如下：![ec644cd8d6a547eb1b5d4809b3f2df18.png][]接下来我们来配置一下这些监控项。

#### 5.1 添加actuator框架支持 ####

在被监控的 Spring Boot 项目中添加 actuator 框架支持，也就是在 pom.xml 中添加以下配置：

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

手动点击 Maven 导入依赖包（如果开启了自动导入，此步骤可忽略）。

#### 5.2 配置开放所有监控项 ####

在被监控的 Spring Boot 项目中添加以下配置：

# 开启监控所有项
    management.endpoints.web.exposure.include=*

以上的配置是开放监控所有选项，配置完之后，重启此 Spring Boot 项目，然后再刷新 Spring Boot Admin 更多的监控项就展示出来了，如下图所示：![12538fd13797e5aad4fc54e265c9c3cf.png][]

#### 5.3 监控项目预览 ####

将 Spring Boot 的所有监控项都开启之后，通过 SBA 就可以查看以下内容了：

*  启动时间、累计运行时间；
 *  进程和线程数量和占用的 CPU 资源；
 *  垃圾回收详情信息，回收次数和花费时间；
 *  JVM 线程转储、内存转储详情和对应的文件下载；
 *  可以查看和配置 Spring Boot 项目中的日志级别；
 *  查看 Spring Boot 项目性能监控；
 *  查看 Spring Boot 运行环境信息；
 *  查看 Spring Boot 所有类信息；
 *  查看 Spring Boot 中的定时任务；
 *  查看和管理 Spring Boot 项目中的所有缓存。

以下是几个重要页面的截图，我们一起来看。

##### 5.3.1 查看运行环境 #####

![be95c3340589a62ab65b80e5c83a63b7.png][]![e7a0f8484c7fdbd4059ab600f1af6c79.png][]

##### 5.3.2 查看定时任务 #####

![b1643019dd156e992043a4c6c219ece1.png][] image.png

##### 5.3.3 项目日志级别配置 #####

![6fe43a20dd145ab53b214202da1b953b.png][]我们可以通过 Spring Boot Admin 来动态的配置项目中的日志级别。

##### 5.3.4 JVM线程和内存查看 #####

![62d72fd7edc8348a4474c6af010cceb3.png][] image.png

##### 5.3.5 查看SpringBoot所有缓存 #####

![934006d94d43ebb4526e7f924c28296c.png][]当然我们还可以对这些缓存进行删除操作。

### 6.查看项目实时日志 ###

想要查看监控项目中的日志信息，有一个前提条件，前提条件是你被监控的 Spring Boot 项目，必须配置了日志的保存路径或者日志保存文件名，只有配置这两项中的任意一项，你的 Spring Boot 项目才会将日志保存到磁盘上，这样才能通过 SBA 查看到，我配置的是日志路径，在 Spring Boot 的 application.properties 配置文件中添加以下配置：

# 设置日志保存路径
    logging.file.path=C:\\work\\log

设置完成之后，重启你的 Spring Boot 项目，然后刷新 SBA 页面，最终展示效果如下：![1bbe88be7a30e08e33b2a0bb43bfdcf4.png][]此时我们就可以查看实时的日志信息了，当然你也可以随时下载日志，如果需要的话。

### 总结 ###

Spring Boot Admin（SBA）是一个社区开源项目，用于管理和监视 Spring Boot 应用程序，它提供详细的健康 （Health）信息、内存信息、JVM 系统和环境属性、垃圾回收信息、日志设置和查看、定时任务查看、Spring Boot 缓存查看和管理等功能。

我们需要创建一个 SBA 服务器端用来监控一个或多个 Spring Boot 项目，被监控的 Spring Boot 项目要添加 SBA Client 框架的支持，且添加 actuator 框架和相应的配置，就可以实现对 Spring Boot 项目的完美监控了。

> 是非审之于己，毁誉听之于人，得失安之于数。
> 
> 公众号：Java面试真题解析

![a958e2941a8c543fb134a3d4e4453fc9.gif][]

往期推荐

![60c2bc6afd46efa3e08a4f2cec737fd6.png][]

Bean放入Spring容器，你知道几种方式？

![9690a0d420446cac376643bd788587e7.png][]

SpringBoot 热部署神器快速重启的秘密！

![fac5e2d09ed7b11b08fb545478d378c0.png][]

查询MySQL字段注释的 5 种方法！

[d8975943091ab7db2d413ca3b2c047aa.png]: https://img-blog.csdnimg.cn/img_convert/d8975943091ab7db2d413ca3b2c047aa.png
[5b47ba451705ec0341db00c21efcc4d2.png]: https://img-blog.csdnimg.cn/img_convert/5b47ba451705ec0341db00c21efcc4d2.png
[8f328c65f23ebd9efd5b8275106f4f9f.png]: https://img-blog.csdnimg.cn/img_convert/8f328c65f23ebd9efd5b8275106f4f9f.png
[dca2868f8dee6e512ddff533ca9e6862.png]: https://img-blog.csdnimg.cn/img_convert/dca2868f8dee6e512ddff533ca9e6862.png
[96409e51dacfc673f4e4753ce48a8f58.png]: https://img-blog.csdnimg.cn/img_convert/96409e51dacfc673f4e4753ce48a8f58.png
[ec605f6357e7c058d68e10008d222f72.png]: https://img-blog.csdnimg.cn/img_convert/ec605f6357e7c058d68e10008d222f72.png
[3868e6d0dd0fbb524c059be38ecacb5d.png]: https://img-blog.csdnimg.cn/img_convert/3868e6d0dd0fbb524c059be38ecacb5d.png
[91a337616e88f86c85ef2f501a9c13f0.png]: https://img-blog.csdnimg.cn/img_convert/91a337616e88f86c85ef2f501a9c13f0.png
[b1b0390dd0ba1322af4a771895afabed.png]: https://img-blog.csdnimg.cn/img_convert/b1b0390dd0ba1322af4a771895afabed.png
[4b4a9a9792f7fc3f20a67d8931833cb8.png]: https://img-blog.csdnimg.cn/img_convert/4b4a9a9792f7fc3f20a67d8931833cb8.png
[c48bc13a5ac74d666e4d4cc52da95323.png]: https://img-blog.csdnimg.cn/img_convert/c48bc13a5ac74d666e4d4cc52da95323.png
[1b53449b05fa1f2725bc1a39058bccab.png]: https://img-blog.csdnimg.cn/img_convert/1b53449b05fa1f2725bc1a39058bccab.png
[8130c1057c5b1391b9dbb4aa4def030c.png]: https://img-blog.csdnimg.cn/img_convert/8130c1057c5b1391b9dbb4aa4def030c.png
[ec644cd8d6a547eb1b5d4809b3f2df18.png]: https://img-blog.csdnimg.cn/img_convert/ec644cd8d6a547eb1b5d4809b3f2df18.png
[12538fd13797e5aad4fc54e265c9c3cf.png]: https://img-blog.csdnimg.cn/img_convert/12538fd13797e5aad4fc54e265c9c3cf.png
[be95c3340589a62ab65b80e5c83a63b7.png]: https://img-blog.csdnimg.cn/img_convert/be95c3340589a62ab65b80e5c83a63b7.png
[e7a0f8484c7fdbd4059ab600f1af6c79.png]: https://img-blog.csdnimg.cn/img_convert/e7a0f8484c7fdbd4059ab600f1af6c79.png
[b1643019dd156e992043a4c6c219ece1.png]: https://img-blog.csdnimg.cn/img_convert/b1643019dd156e992043a4c6c219ece1.png
[6fe43a20dd145ab53b214202da1b953b.png]: https://img-blog.csdnimg.cn/img_convert/6fe43a20dd145ab53b214202da1b953b.png
[62d72fd7edc8348a4474c6af010cceb3.png]: https://img-blog.csdnimg.cn/img_convert/62d72fd7edc8348a4474c6af010cceb3.png
[934006d94d43ebb4526e7f924c28296c.png]: https://img-blog.csdnimg.cn/img_convert/934006d94d43ebb4526e7f924c28296c.png
[1bbe88be7a30e08e33b2a0bb43bfdcf4.png]: https://img-blog.csdnimg.cn/img_convert/1bbe88be7a30e08e33b2a0bb43bfdcf4.png
[a958e2941a8c543fb134a3d4e4453fc9.gif]: https://img-blog.csdnimg.cn/img_convert/a958e2941a8c543fb134a3d4e4453fc9.gif
[60c2bc6afd46efa3e08a4f2cec737fd6.png]: https://img-blog.csdnimg.cn/img_convert/60c2bc6afd46efa3e08a4f2cec737fd6.png
[9690a0d420446cac376643bd788587e7.png]: https://img-blog.csdnimg.cn/img_convert/9690a0d420446cac376643bd788587e7.png
[fac5e2d09ed7b11b08fb545478d378c0.png]: https://img-blog.csdnimg.cn/img_convert/fac5e2d09ed7b11b08fb545478d378c0.png