Spring Boot Actuator Health Endpoint 中的“描述”字段是什么

Question

我目前正在开发一个在 Spring Boot 2.7.5 上运行的应用程序，并正在研究 Actuator 端点。

当我致电

/actuator/health

时，我得到以下回复：

{
  "description":"",
  "status":"DOWN"
}

我一生都无法弄清楚“描述”字段从何而来以及如何修改甚至隐藏它。我已经尝试查看文档和其他 StackOverflow 线程。

有人知道它可能来自哪里吗？

Answer 1

包含空描述的健康 API 响应可能是默认行为。这可能是没有有关状态的详细信息，或者根据配置，由于安全原因未公开状态。

如果您想在健康执行器 API 的响应中设置描述，您有两种选择：

1. 实现自定义

   HealthIndicator

   （org.springframework.boot.actuate.health.HealthIndicator）。实现

   health()

   方法并返回适当的状态和详细信息字段。然后注册自定义

   HealthIndicator

   。
2. 使用

   HealthEndpointCustomizer

   （org.springframework.boot.actuate.health.HealthEndpointCustomizer）。重写

   customize()

   方法，然后重写

   HealthContributor

   的 health() 方法以返回适当的状态和详细信息字段。

根据这些提示，请搜索代码示例并继续。