文章目录
Actuator
actuator是Spring Boot项目中非常强大的一个功能,有助于对应用程序进行监控和管理,通过Restful API请求来监管、审计、收集应用的运行情况,针对微服务而言它是必不可少的一个环节。
Endpoints
Endpoints(端点)是actuator的核心部分,它用来监视应用程序及交互,spring-boot-actuator中已经内置了非常多的Endpoints(health、info、beans、httptrace、shutdown)等等,同时也允许我们自己扩展自己的端点
spring boot 2.0中的端点和之前版本有较大不同,使用时需要注意。另外端点的监控机制也有很大不同,启用了不代表可以直接访问,还需要将其暴露出来,传统的management.security管理已被标记为不推荐。
内置Endpoints
id | desc | Sensitive |
---|---|---|
auditevents |
显示当前应用程序的审计事件信息 | Yes |
beans |
显示应用Spring Beans的完整列表 | Yes |
caches |
显示可用缓存信息 | Yes |
conditions |
显示自动装配类的状态及及应用信息 | Yes |
configprops |
显示所有 @ConfigurationProperties 列表 | Yes |
env |
显示 ConfigurableEnvironment 中的属性 | Yes |
flyway |
显示 Flyway 数据库迁移信息 | Yes |
health |
显示应用的健康信息(未认证只显示status ,认证显示全部信息详情) |
No |
info |
显示任意的应用信息(在资源文件写info.xxx即可) | No |
liquibase |
展示Liquibase 数据库迁移 | Yes |
metrics |
展示当前应用的 metrics 信息 | Yes |
mappings |
显示所有 @RequestMapping 路径集列表 | Yes |
scheduledtasks |
显示应用程序中的计划任务 | Yes |
sessions |
允许从Spring会话支持的会话存储中检索和删除用户会话。 | Yes |
shutdown |
允许应用以优雅的方式关闭(默认情况下不启用) | Yes |
threaddump |
执行一个线程dump | Yes |
httptrace |
显示HTTP跟踪信息(默认显示最后100个HTTP请求 - 响应交换) | Yes |
应用
pom配置
在pom.xml中添加spring-boot-starter-actuator的依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
如果需要访问info接口来获取maven中的属性内容请记得添加如下内容
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<executions>
<execution>
<goals>
<goal>build-info</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
application.yml
在application.yml文件中配置actuator的相关配置,其中info开头的属性,就是访问info端点中显示的相关内容,值得注意的是spring boot2.x中,默认只开放了info、health两个端点,其余的需要自己通过配置management.endpoints.web.exposure.include属性来加载(有include自然就有exclude)。如果想单独操作某个端点可以使用management.endpoint.端点.enabled属性进行启用或者禁用。
info:
head: head
body: body
management:
endpoints:
web:
exposure:
# 加载所有的端点,默认只加载了info、health
include: '*'
endpoint:
health:
show-details: always
# 可以关闭指定的端点
shutdown:
enabled: false
测试
启动项目,浏览器输入:http://localhost:8080/actuator/info
{
"head":"head","body":