Actuator
Actuator是Springboot提供的用来对应用系统进行自省和监控的功能模块,借助于Actuator开发者可以很方便地对应用系统某些监控指标进行查看、统计等。本文将通过示例来对如何在Springboot中使用Actuator监控做一个简单介绍,更多内容请移步官方文档。
添加依赖与配置
- 在工程POM文件中引入
spring-boot-starter-actuator
依赖即可。
<!-- 引入Actuator监控依赖 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
- 同时,
application.properties
的配置文件中,添加management.security.enabled=false
配置。
说明:
如果在配置文件中未添加management.security.enabled=false
配置, 将会导致监控地址访问受限,报401未授权
Actuator 监控项
如下:包含了Actuator 提供的主要监控项
请求方式 | 请求路径 | 描述 | 鉴权 |
---|---|---|---|
GET | /autoconfig | 查看自动配置的使用情况 | true |
GET | /configprops | 显示一个所以 @ConfigurationProperties 的整理列表 | true |
GET | /beans | 显示一个应用中所有 Spring Beans 的完整列表 | true |
GET | /dump | 打印线程栈 | true |
GET | /env | 查看所有环境变量 | true |
GET | /env/{name} | 查看具体环境变量 | true |
GET | /health | 查看应用健康指标 | false |
GET | /info | 查看应用信息 | false |
GET | /mappings | 查看所有url映射 | true |
GET | /metrics | 查看应用基本指标 | true |
GET | /metrics/{name} | 查看具体指标 | true |
POST | /shutdown | 允许应用以优雅的方式关闭(默认情况下不启用) | true |
GET | /trace | 查看基本追踪信息 | true |
优雅关闭应用
/shutdown
是一个POST请求,用来关闭应用,由于操作比较敏感,默认情况下该请求是被禁止的,若要开启需在配置文件中添加以下配置:
endpoints.shutdown.enabled: true
测试
Post
请求测试验证优雅停机 curl -X POST http://localhost:8080/zzsj/actuator/shutdown
成功!!