Spring Boot Actuator是一个用于监控和管理Spring Boot应用的子项目,它提供了一组REST端点和命令行工具, 用于查看应用的运行状态、性能指标和健康状况等。Actuator还支持应用度量数据的导出,以及自定义端点和安全控制等功能。通过使用Spring Boot Actuator,开发人员可以更加方便地了解应用的运行状况,及时发现和解决问题。
随着微服务架构的普及,Spring Boot 已经成为JAVA开发人员的首选框架。然而,随着应用的规模不断扩大, 如何有效地监控和管理这些应用成为一个重要的问题。Spring Boot Actuator的出现,为开发人员提供了一个解决方案。本文将详细介绍Spring Boot Actuator的功能、工作原理、使用场景以及应用示例,帮助读者更好地理解和掌握这一工具。
服务端点 |
描述 |
auditevents |
公开当前应用程序的审核事件信息。 |
beans |
显示应用程序中所有Spring bean的完整列表。 |
caches |
公开可用的缓存 |
conditions |
显示在配置和自动配置类上评估的条件以及它们匹配或不匹配的原因。 |
configprops |
显示所有@ConfigurationProperties的有序列表。 |
env |
公开Spring的ConfigurableEnvironment中的属性 |
flyway |
显示已应用的任何Flyway数据库迁移。 |
health |
显示应用健康信息。 |
httptrace |
显示HTTP跟踪信息(默认情况下,最后100个HTTP请求 – 响应交换)。 |
info |
显示任意应用信息。 |
integrationgraph |
显示Spring集成图。 |
loggers |
显示和修改应用程序中日志记录器的配置。 |
liquibase |
显示已应用的任何Liquibase数据库迁移。 |
metrics |
显示当前应用程序的“指标”信息。 |
mAppings |
显示所有@RequestMapping路径的有序列表。 |
scheduledtasks |
显示应用程序中的计划任务。 |
sessions |
允许从Spring Session支持的会话存储中检索和删除用户会话。使用Spring Session对响应式Web应用程序的支持时不可用。 |
shutdown |
允许应用程序正常关闭。 |
http://localhost:8080/actuator
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
management:
endpoints:
web:
exposure:
# [health, info]
include: "*"
监控端点相关注解:
自定义一个端点服务:
@Endpoint(id = "custom")
public class CustomEndpoint {
/**
* /actuator/custom
*/
@ReadOperation
public Map custom() {
return new HashMap();
}
/**
* /actuator/custom/{name}?value={value}
*/
@ReadOperation
public Map name(@Selector String name, @Nullable String value) {
return new HashMap();
}
}
Spring-Actuator主要实现数据的采集,以及提供REST API以及JMX的访问渠道,那么数据具体如何友好地显示出来?这时我们需要对应的UI,其中spring-boot-admin就是这样一款工具。
http://localhost:8080/applications
<dependency>
<groupId>de.codecentric</groupId>
<artifactId>spring-boot-admin-starter-server</artifactId>
</dependency>
@EnableAdminServer
public class Application{ }
<dependency>
<groupId>de.codecentric</groupId>
<artifactId>spring-boot-admin-starter-client</artifactId>
<version>2.6.2</version>
</dependency>
客户端配置
spring:
boot:
admin:
client:
url: http://localhost:8080
上面说到,Actuator除了采集指标,提供访问API外,还提供了“应用度量数据的导出”的功能,这样就能将我们采集到的指标输出到指定的存储服务或终端以便进一步分析。其中Prometheus就是这样一个应用。
<dependency>
<groupId>io.micrometer</groupId>
<artifactId>micrometer-registry-prometheus</artifactId>
</dependency>
management:
endpoints:
web:
exposure:
include: "*"
metrics:
export:
prometheus:
enabled: true
prometheus:
enabled: true
scrape_configs:
- job_name: 'spring-boot-actuator'
metrics_path: '/actuator/prometheus'
static_configs:
- targets: ['localhost:8080'] # 使用你的Spring Boot应用程序的实际主机和端口替换
prometheus.exe --config.file=prometheus.yml
grafana-server.exe
由于篇幅有限,关于Grafana如何集成Prometheus,网上有很多具体实践,这里不重复赘述...
由于项目使用spring-boot版本为2.3.7.RELEASE,而spring-boot-admin-starter-server版本设置设置为2.7.x版本时,UI相关配置一直无法加载,通过源码可以看到
在2.6.x版本中对应spring-boot-admin-server-ui存在META-INspring.factories文件
org.springframework.boot.autoconfigure.EnableAutoConfiguration=
de.codecentric.boot.admin.server.ui.config.AdminServerUiAutoConfiguration
而在2.7.x版本中,spring.factories删除了且改为了 META-INFspringorg.springframework.boot.autoconfigure.AutoConfiguration.imports
de.codecentric.boot.admin.server.ui.config.AdminServerUiAutoConfiguration
因此如果需要使用2.7.x版本的spring-boot-admin,记得把spring-boot升级到2.7.x
参数名称被解析为arg0,导致请求匹配失败。通过下面的配置保证编译后的文件通过反射获取的参数名称不变
<plugin>
<groupId>org.Apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.11.0</version>
<configuration>
<debug>false</debug>
<!-- 防止方法参数名解析为arg0... -->
<compilerArgs>
<arg>-parameters</arg>
</compilerArgs>
</configuration>
</plugin>
如果使用Idea,你可以在应用启动后,Actuator功能面板的Mappings中看到服务地址的变化
服务监控是为了更好的了解服务运行状况,及时发现服务可能出现的问题,并在出现故障时能够有效的定位问题产生的原因。更大层面解决系统运行过程中的维护 成本。关于监控相关的应用还有一些,比如SkyWalking、Zipkin、Elastic APM等等。