|
此版本仍在开发中，尚未视为稳定版。如需最新稳定版本，请使用 Spring Boot 4.0.4！ |
健康状况（health）
health 端点提供有关应用程序健康状况的详细信息。
检索应用程序的健康状态
要获取应用程序的健康状况，请向 GET 发送一个 /actuator/health 请求，如下列基于 curl 的示例所示：
$ curl 'http://localhost:8080/actuator/health' -i -X GET \
-H 'Accept: application/json'生成的响应类似于以下内容：
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 823
{
"status" : "UP",
"components" : {
"broker" : {
"status" : "UP",
"components" : {
"us1" : {
"status" : "UP",
"details" : {
"version" : "1.0.2"
}
},
"us2" : {
"status" : "UP",
"details" : {
"version" : "1.0.4"
}
}
}
},
"db" : {
"status" : "UP",
"details" : {
"database" : "H2",
"validationQuery" : "isValid()"
}
},
"diskSpace" : {
"status" : "UP",
"details" : {
"total" : 154894188544,
"free" : 121214513152,
"threshold" : 10485760,
"path" : "/home/runner/work/spring-boot/spring-boot/spring-boot-project/spring-boot-actuator-autoconfigure/.",
"exists" : true
}
}
}
}响应结构
响应包含应用程序健康状况的详细信息。 下表描述了响应的结构：
| 路径 | 类型 | <description> </description> |
|---|---|---|
|
|
应用程序的总体状态。 |
|
|
构成健康状况的组件。 |
|
|
应用程序特定部分的状态。 |
|
|
构成健康状况的嵌套组件。 |
|
|
应用程序特定部分的健康状况详情。其显示与否由 |
上述响应字段适用于 V3 API。
如果您需要返回 V2 JSON，应使用 Accept 请求头或 application/vnd.spring-boot.actuator.v2+json |
检索组件的健康状态
要获取应用程序健康状况中某个特定组件的健康信息，请向 GET 发送一个 /actuator/health/{component} 请求，如下列基于 curl 的示例所示：
$ curl 'http://localhost:8080/actuator/health/db' -i -X GET \
-H 'Accept: application/json'生成的响应类似于以下内容：
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 101
{
"status" : "UP",
"details" : {
"database" : "H2",
"validationQuery" : "isValid()"
}
}检索嵌套组件的健康状态
如果某个特定组件包含其他嵌套组件（如上面示例中的 broker 指示器），可以通过向 GET 发送 /actuator/health/{component}/{subcomponent} 请求来获取该嵌套组件的健康状态，如下列基于 curl 的示例所示：
$ curl 'http://localhost:8080/actuator/health/broker/us1' -i -X GET \
-H 'Accept: application/json'生成的响应类似于以下内容：
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 66
{
"status" : "UP",
"details" : {
"version" : "1.0.2"
}
}应用程序健康状况的组件可根据应用程序的健康指标及其分组方式，任意深度地嵌套。
健康端点支持在 URL 中使用任意数量的 /{component} 标识符，以便获取任意深度组件的健康状况。