Spring Boot Admin 的使用详解

发布时间 - 2026-01-11 03:25:14    点击率:

一、前言

Spring Boot Admin 用于监控基于 Spring Boot 的应用。官方文档在这里(v1.3.4):《Spring Boot Admin Reference Guide》

实践的过程中,感觉这个 User Guide 结构上还是说的不太明白。所以我就大概写一遍我的实践过程与理解。

阅读此文前提条件是:

  • 使用过 Maven。
  • 你跑过基于 Spring Boot 的 hello world 程序。
  • 第三节需要你会点 Spring Cloud 的 Eureka Server 配置。

二、在 Spring Boot 项目中配置

这种配置中,Spring Boot Admin 作为 Server,其他 Spring Boot 应用作为 Client,Client 把自身的信息“注册”到 Server,我们就能在 Server 上看到“注册”的 Spring Boot 应用的状态信息了。

2.1、Server 端

新建一个项目

2.1.1、添加依赖

pom.xml

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

2.1.2、开启监控

添加 @EnableAdminServer 注解开启监控

@Configuration
@EnableAutoConfiguration
@EnableAdminServer
public class SpringBootAdminApplication {
  public static void main(String[] args) {
    SpringApplication.run(SpringBootAdminApplication.class, args);
  }
}

这里未指定 Server 运行的端口,默认是 8080,如果要指定,则需要在 application.properties 文件中设置:
application.properties

server.port=8080

2.2、Client 端

2.2.1、添加依赖

pom.xml

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

这里的 spring-boot-admin-starter-client 会自动依赖 jolokia-core,jolokia是用于 JMX-bean 管理的。

2.2.2、触发自动配置、指明 Server 注册地址

application.properties

spring.boot.admin.url=http://localhost:8080

上面 3.1.2 中 Server 端我们使用默认的 8080 端口,所以这里声明 Server 的地址为:http://localhost:8080

2.3、开始管理

至此,启动 Server 端和 Client 端,在浏览器输入 Server 的地址:http://localhost:8080 就能看到“注册”进来的 Spring Boot 应用信息了。

2.4、显示应用版本

为了在 Spring Boot Admin 的应用管理列表显示被管理应用的版本号,你需要设置 info.version,例如使用 maven filtering:
application.properties

info.version=@project.version@

这里设置显示的版本号为 Maven pom.xml 中的构建版本号。

2.5、JMX-bean管理

JMX-bean 管理需要使用第三方的 jolokia ,因为 spring-boot-admin-starter-client 会自动依赖 jolokia-core,所以这里不需要显示依赖了,第三节的基于 Eureka 注册发现的配置中,就需要显示地依赖:

pom.xml

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

2.6、Loglevel 管理

当前日志级别管理仅限 Logback,通过 JMX 实现,所以需要依赖 jolokia 。同时,还需要配置 Logback 的 JMXConfigurator:
logback.xml

<configuration>
  <include resource="org/springframework/boot/logging/logback/base.xml"/>
  <jmxConfigurator/>
</configuration>

这个 logback.xml 放在与 application.properties 同级的目录就可以了,如果不配置 Logback,那么 Spring Boot Admin 就无法管理应用的日志级别。

2.7、Server 端监控自己

以上的配置,基本就可以很好工作了。

但是有一个问题,我们没有监控作为 Server 端的 Spring Boot Admin 自身。如果要监控到 Server 自己,把 Server 端也当作是 Client 一样来配置就可以实现了:把 2.2.1、2.2.2、2.4、2.6 的步骤在 Server 端也配置一遍。

三、在 Spring Cloud 项目的 Eureka 中配置

这里示例的 Spring Cloud 项目是使用 Eureka 来做注册/发现的,官方 Github 示例里有基于 Consul 和 Zookeper 的配置。

配置好之后,Spring Boot Admin 就可以管理所有注册到 Eureka Server 的应用了,包括 Spring Boot Admin 自己(因为自己也会注册到 Eureka Server)。

3.1、一个简单的 Eureka Server

关于 Eureka Server 这里不做详细介绍,只列一下配置经过:

pom.xml

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

Eureka Server 启动类

@SpringBootApplication
@EnableEurekaServer
public class EurekaServerApplication {

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

application.properties

spring.application.name=eureka-server
server.port=8761

在 application.properties 同级目录下新建 bootstrap.properties 文件: bootstrap.properties

eureka.instance.hostname=localhost
eureka.client.registerWithEureka=false
eureka.client.fetchRegistry=false
eureka.client.serviceUrl.defaultZone=http://${eureka.instance.hostname}:${server.port}/eureka/

此文件作用与 application.properties 几乎样,只是但是作用在 application context 启动时期。原话是:like application.properties but for the bootstrap phase of an application context 。

以上配置表明,我们的 Eureka Server 运行在 8761 端口。服务注册地址是:http://localhost:8761/eureka/

3.2、Server 端

官方示例:spring-boot-admin-sample-eureka

3.2.1、添加 spring-cloud-starter-eureka 依赖

pom.xml

<dependency>
  <groupId>de.codecentric</groupId>
  <artifactId>spring-boot-admin-server</artifactId>
  <version>1.3.4</version>
</dependency>
<dependency>
  <groupId>de.codecentric</groupId>
  <artifactId>spring-boot-admin-server-ui</artifactId>
  <version>1.3.4</version>
</dependency>
<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-eureka</artifactId>
</dependency>

3.2.2、添加 @EnableDiscoveryClient 开启发现

@Configuration
@EnableAutoConfiguration
@EnableDiscoveryClient
@EnableAdminServer
public class SpringBootAdminApplication {
  public static void main(String[] args) {
    SpringApplication.run(SpringBootAdminApplication.class, args);
  }
}

3.2.3、指明去哪注册

application.properties

eureka.instance.client.serviceUrl.defaultZone: http://localhost:8761/eureka/

也就是我们在 3.1 中配置的 Eureka Server 服务地址。

这个配置我测试时并不成功,改为 eureka.client.serviceUrl.defaultZone: http://localhost:8761/eureka/ 才可以,不知为何。

3.2.4、官方未说明的

3.2.1 ~ 3.2.3 的配置,会把 Server 注册到 Eureka Server,也就是说 Spring Boot Admin 也可以管理自身,但现在的 Server 配置还不全面(比如自身还缺的配置有:版本信息、 JMX 管理和 Loglevel 管理)。加上以下配置: application.properties

info.version=@project.version@

pom.xml

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

logback.xml

<configuration>
  <include resource="org/springframework/boot/logging/logback/base.xml"/>
  <jmxConfigurator/>
</configuration>

3.3、Client 端

Client 端的配置主要是把自己注册到 Eureka Server 中就可以被 Spring Boot Admin 管理了,免去了手工配置 Spring Boot Admin 服务地址的操作(即 2.2.2 节操作)。

3.3.1、依赖

pom.xml

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

注意要添加 spring-boot-starter-actuator 依赖,因为获取应用信息是通过 actuator 中的相关 endpoints 获取的。

之所以 Server 端不需要添加此依赖,是因为 spring-boot-admin-server 依赖于 spring-boot-admin-starter-client ,而 spring-boot-admin-starter-client 依赖于 spring-boot-starter-actuator 。

3.3.2、启动类

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

添加 @EnableDiscoveryClient 或 @EnableEurekaClient 注解到启动类上,将自己注册到 Erueka Server。

3.3.3、指明去哪注册

bootstrap.properties

eureka.client.serviceUrl.defaultZone: http://localhost:8761/eureka/

3.3.4、其他项配置

application.properties

info.version=@project.version@

logback.xml

<configuration>
  <include resource="org/springframework/boot/logging/logback/base.xml"/>
  <jmxConfigurator/>
</configuration>

pom.xml

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

四、通知

官方提供好几种通知方式,这里贴一下邮件通知的配置,其他 Pagerduty、Hipchat 、Slack 和 Reminder 的通知配置请参见官方文档。

使用 spring-boot-starter-mail 依赖配置 JavaMailSender

pom.xml

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

application.properties

spring.mail.host=smtp.example.com
spring.boot.admin.notify.mail.to=admin@example.com

表格:邮件配置选项

 

Property name Description Default value 中文说明
spring.boot.admin.notify.mail.enabled Enable mail notifications true 默认启用
spring.boot.admin.notify.mail.ignore-changes Comma-delimited list of status changes to be ignored. Format: “:”. Wildcards allowed. “UNKNOWN:UP” 需要忽略的状态改变通知,逗号分隔
spring.boot.admin.notify.mail.to Comma-delimited list of mail recipients “root@localhost” 接收通知的邮箱地址,逗号分隔
spring.boot.admin.notify.mail.cc Comma-delimited list of carbon-copy recipients 抄送
spring.boot.admin.notify.mail.from Mail sender 发送人
spring.boot.admin.notify.mail.subject Mail subject. SpEL-expressions are supported “#{application.name} (#{application.id}) is #{to.status}” 主题
spring.boot.admin.notify.mail.text Mail body. SpEL-expressions are supported “#{application.name} (#{application.id})\nstatus changed from #{from.status} to #{to.status}\n\n#{application.healthUrl}” 内容

五、附:Spring Boot Admin Server 配置说明

表格:Spring Boot Admin Server 配置选项

 

Property name Description Default value 中文说明
spring.boot.admin.context-path The context-path prefixes the path where the Admin Server's statics assets and API should be served. Relative to the Dispatcher-Servlet. Admin Server 保留的静态访问和API的前缀(当你在业务应用中使用而不是单独使用时就很有必要了)
spring.boot.admin.monitor.period Time interval in ms to update the status of applications with expired status-informations. 10.000 更新应用信息的频率,单位毫秒
spring.boot.admin.monitor.status-lifetime Lifetime of application statuses in ms. The applications /health-endpoint will not be queried until the lifetime has expired. 10.000 被监控的应用信息的过期时间,单位毫秒

5.1、Spring Cloud 对自动发现的支持

来自被发现的应用的状态信息是经过 ServiceInstanceConverter 转换过的,自动配置时,使用了 Spring Boot Admin 自带的 Eureka 转换实现。你也可以实现相关接口并并添加到上下文以替换默认的。

表格:注册发现配置选项

Property name Description Default value 中文说明
spring.boot.admin.discovery.enabled Enables the DiscoveryClient-support for the admin server. true 默认开启
spring.boot.admin.discovery.converter.management-context-path Will be appended to the service-url of the discovered service when the managment-url is converted by the DefaultServiceInstanceConverter.
spring.boot.admin.discovery.converter.health-endpoint Will be appended to the management-url of the discovered service when the health-url is converted by the DefaultServiceInstanceConverter. “health”
spring.boot.admin.discovery.ignored-services This services will be ignored when using discovery and not registered as application.

六、附:Spring Boot Admin Client 配置说明

Spring Boot Admin Client 注册到 Spring Boot Admin Server,Client 定期地发送 Http Post 到 admin 提供自己的应用信息。如果需要管理 loglevels 或 JMX-beans ,则要在依赖中添加 Jolokia ,使得 JMX-beans 也可以通过 http 访问。

表格:Spring Boot Admin Client配置选项

Property name Description Default value 中文说明
spring.boot.admin.client.enabled Enables the Spring Boot Admin Client. true 默认开启
spring.boot.admin.url List of URLs of the Spring Boot Admin server to register at. This triggers the AutoConfiguration. Mandatory. admin server 的地址列表,此设置会触发自动配置,必须
spring.boot.admin.api-path Http-path of registration endpoint at your admin server. “api/applications” 注册到 admin server 端点的 Http-path
spring.boot.admin.username spring.boot.admin.password Username and password for http-basic authentication. If set the registration uses http-basic-authentication when registering at the admin server. 注册到 admin server 的账号密码
spring.boot.admin.period Interval for repeating the registration (in ms). 10.000 重试注册的间隔时间
spring.boot.admin.auto-registration If set to true the periodic task to register the application is automatically scheduled after the application is ready. true 应用启动后自动执行周期性的注册任务
spring.boot.admin.auto-deregistration Switch to enable auto-deregistration at Spring Boot Admin server when context is closed. false 当应用关闭时,自动取消注册
spring.boot.admin.client.health-url Client-health-url to register with. Can be overridden in case the reachable URL is different (e.g. Docker). Must be unique in registry. Guessed based on management-url and endpoints.health.id.
spring.boot.admin.client.management-url Client-management-url to register with. Can be overridden in case the reachable url is different (e.g. Docker). Guessed based on service-url, server.servlet-path, management.port and management.context-path.
spring.boot.admin.client.service-url Client-service-url to register with. Can be overridden in case the reachable url is different (e.g. Docker). Guessed based on hostname, server.port and server.context-path.
spring.boot.admin.client.name Name to register with. ${spring.application.name} if set, “spring-boot-application” otherwise. 注册时的名字
spring.boot.admin.client.prefer-ip Use the ip-address rather then the hostname in the guessed urls. If server.address / management.address is set, it get used. Otherwise the IP address returned from InetAddress.getLocalHost() gets used. false

七、问答

这部分我也啰嗦一下翻译出来。

我可以把 spring-boot-admin 添加到我的业务应用中吗?

答:可以,但不应该这么做。你可以设置 spring.boot.admin.context-path 来改变 admin server 保留的 UI 和 REST-API 的访问,取决于你的应用复杂性,你可能会陷入困境。另一方面,当你的应用挂掉后,你的监控也一起挂掉,那么要监控有什么用呢?

该怎么自定义 UI ?

答:修改 UI 你仅可以复制并修改 spring-boot-admin-ui,并添加你自己的模块到 classpath 中。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。


# Spring  # Boot  # Admin  # Admin使用  # SpringBoot Admin的简单使用的方法步骤  # Spring Boot Admin的使用详解(Actuator监控接口)  # Spring Boot集群管理工具KafkaAdminClient使用方法解析  # 详解使用spring boot admin监控spring cloud应用程序  # 使用spring-boot-admin对spring-boot服务进行监控的实现方法  # SpringBoot Admin 使用指南(推荐)  # 详解Spring boot Admin 使用eureka监控服务  # Spring Boot Admin 环境搭建与基本使用详解  # 就可以  # 自己的  # 不需要  # 一遍  # 第三节  # 注册地址  # 我也  # 我就  # 文档  # 在这里  # 很好  # 是因为  # 也会  # 去了  # 你可以  # 就能  # 你会  # 不太  # 你也  # 还不 


相关栏目: 【 网站优化151355 】 【 网络推广146373 】 【 网络技术251813 】 【 AI营销90571


相关推荐: 做企业网站制作流程,企业网站制作基本流程有哪些?  如何在不使用负向后查找的情况下匹配特定条件前的换行符  Python企业级消息系统教程_KafkaRabbitMQ高并发应用  Midjourney怎么调整光影效果_Midjourney光影调整方法【指南】  Laravel路由怎么定义_Laravel核心路由系统完全入门指南  如何在橙子建站上传落地页?操作指南详解  Laravel如何使用Guzzle调用外部接口_Laravel发起HTTP请求与JSON数据解析【详解】  canvas 画布在主流浏览器中的尺寸限制详细介绍  HTML透明颜色代码怎么让下拉菜单透明_下拉菜单透明背景指南【技巧】  湖南网站制作公司,湖南上善若水科技有限公司做什么的?  WEB开发之注册页面验证码倒计时代码的实现  如何在局域网内绑定自建网站域名?  Laravel怎么使用artisan命令缓存配置和视图  家族网站制作贴纸教程视频,用豆子做粘帖画怎么制作?  bing浏览器学术搜索入口_bing学术文献检索地址  原生JS实现图片轮播切换效果  如何快速查询网站的真实建站时间?  javascript中对象的定义、使用以及对象和原型链操作小结  Laravel软删除怎么实现_Laravel Eloquent SoftDeletes功能使用教程  Laravel中间件如何使用_Laravel自定义中间件实现权限控制  Python自动化办公教程_ExcelWordPDF批量处理案例  Laravel如何实现模型的全局作用域?(Global Scope示例)  Laravel如何设置自定义的日志文件名_Laravel根据日期或用户ID生成动态日志【技巧】  微信小程序 input输入框控件详解及实例(多种示例)  北京网站制作的公司有哪些,北京白云观官方网站?  Laravel API路由如何设计_Laravel构建RESTful API的路由最佳实践  🚀拖拽式CMS建站能否实现高效与个性化并存?  极客网站有哪些,DoNews、36氪、爱范儿、虎嗅、雷锋网、极客公园这些互联网媒体网站有什么差异?  EditPlus中的正则表达式实战(6)  历史网站制作软件,华为如何找回被删除的网站?  如何在IIS7上新建站点并设置安全权限?  网站优化排名时,需要考虑哪些问题呢?  jQuery validate插件功能与用法详解  制作电商网页,电商供应链怎么做?  如何在服务器上三步完成建站并提升流量?  Laravel如何使用Sanctum进行API认证?(SPA实战)  Laravel事件监听器怎么写_Laravel Event和Listener使用教程  Win11怎么更改系统语言为中文_Windows11安装语言包并设为显示语言  HTML5打空格有哪些误区_新手常犯的空格使用错误【技巧】  Linux虚拟化技术教程_KVMQEMU虚拟机安装与调优  安克发布新款氮化镓充电宝:体积缩小 30%,支持 200W 输出  如何挑选最适合建站的高性能VPS主机?  Laravel如何获取当前登录用户信息_Laravel Auth门面使用与Session用户读取【技巧】  Laravel的辅助函数有哪些_Laravel常用Helpers函数提高开发效率  PHP怎么接收前端传的文件路径_处理文件路径参数接收方法【汇总】  Laravel如何创建自定义Artisan命令?(代码示例)  Laravel Blade模板引擎语法_Laravel Blade布局继承用法  Laravel集合Collection怎么用_Laravel集合常用函数详解  公司网站制作价格怎么算,公司办个官网需要多少钱?  如何在阿里云域名上完成建站全流程?