Actuator

Maven依赖

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

Endpoint

Endpoint Description
autoconfig 获取自动配置信息
beans 获取Spring Bean基本信息
configprops 获取配置项信息
dump 获取当前线程基本信息
env 获取环境变量信息
health 获取健康检查信息
info 获取应用基本信息
metrics 获取性能指标信息
mappings 获取请求映射信息
trace 获取请求调用信息

例如:发送 /metrics 请求
!82002A01-34C8-4267-BB2E-85F1006B91BE.png(http://storage.blog.ikyxxs.com/a652497404744b92aec11066e4688d31.png)

控制端点

关闭 metrics 端点

endpoints.metrics.enabled=false

在浏览器上访问 metrics 端点时,将不会看到任何信息,只是一个“Whitelabel Error Page”的错误页面,对应的HTTP状态码为 404(Not Found)。

关闭所有端点,仅开启 metrics 端点

endpoints.enabled=false
endpoints.metrics.enabled=true

现在只有 metrics 端点是启用的,访问其他端点会报错。

修改 metrics 端点的名称

endpoints.metrics.id=performance

这样我们就可以通过 /performance 请求来访问以前的 metrics 端点了,此时继续发送 /metrics 请求将会看到报错信息。

修改 metrics 端点的请求路径

endpoints.metrics.pat=/endpoints/metrics

通过以上配置,我们需要在发送 /endpoints/metrics 请求后才能访问 metrics 的端点。

HATEOAS

Maven依赖

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

发送 /actuator 请求

!FB68E48E-5F28-43D2-8281-E693C886613A.png(http://storage.blog.ikyxxs.com/036ad0b5114e4c97a513d6232555d1d2.png)

配置 actuator 端点

禁用 actuator 端点

endpoints.actuator.enabled=false

设置 actuator 端点的路径

endpoints.actuator.path=/endpoints/actuator

HAL Browser 图形化工具

添加依赖

<dependency>
    <groupId>org.webjars</groupId>
    <artifactId>hal-browser</artifactId>
</dependency>

发送 /actuator 请求

!0F03515E-9EAF-483D-85D2-B47653D7B0A8.png(http://storage.blog.ikyxxs.com/0d0893b5cc2f49d2869dc705824f2027.png)

开启 Actuator 文档插件

添加依赖

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

发送 /docs 请求

!203C2802-3B9E-413C-8B7A-DD90ABE7C735.png(http://storage.blog.ikyxxs.com/de9ee74d2c454a54b4840572b46adc07.png)

参考来源

《轻量级微服务架构(上册)》 黄勇