Spring Boot 端点

Actuator

Maven 依赖

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

Endpoint

例如：发送 /metrics 请求

控制端点

关闭 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 请求

配置 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 请求

开启 Actuator 文档插件

添加依赖

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

发送 /docs 请求

参考来源

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