5.3 健康检查

背景

健康检查的目的是获取应用在生命周期中的状态，包括：运维阶段和运行阶段的状态，以便用户根据该状态做决策。例如：如果发现应用状态为 DOWN，则表示应用存在故障，用户可以重启或替换机器。

在单应用情况下，健康检查比较简单：

运维阶段状态：
- 如果正在启动，则为 UNKNOWN；
- 如果启动失败，则为 DOWN；
- 如果启动成功，则为 UP。
运行阶段状态：
- 如果应用各健康检查点健康，则为 UP；
- 如果应用各健康检查点不健康，则为 DOWN。

在多应用场景下，情况会复杂得多。我们需要考虑多应用在运维阶段和运行阶段的状态对整体应用健康状态的影响。在设计健康检查时，我们需要考虑以下2个问题：

在模块运维阶段，模块启动状态是否应该影响整体应用健康状态？
在不同运维场景下，用户的期望是不同的。 koupleless 中模块运维有三种场景：

场景	模块对整体应用健康状态的影响
模块热部署	提供配置，让用户自行决定模块热部署结果是否影响应用整体健康状态（默认配置为：不影响整体应用原本的健康状态）
静态合并部署	模块部署发生在基座启动时，模块启动状态应该直接影响整体应用的健康状态
模块回放	模块回放发生在基座启动时，模块启动状态应该直接影响整体应用的健康状态

在模块运行阶段，模块运行状态是否应该影响整体应用健康状态？
模块运行阶段的状态应该直接影响应用整体健康状态。

在此背景下，我们设计了多应用下的健康检查方案。

使用

前置条件

koupleless 版本 >= 1.2.1
sofa-ark 版本 >= 2.2.9

获取应用整体健康状态

基座的健康状态有 3 类：

状态	含义
UP	健康，表示已就绪（readiness）
UNKNOWN	正在启动中
DOWN	不健康（可能是启动失败，也可能是运行状态不健康）

由于 Koupleless 支持热部署模块，因此用户在获取应用整体健康状态时，可能希望模块部署是否成功影响整体应用健康状态，或不影响。

模块启动是否成功不影响整体应用健康状态（默认）

特点：对于健康的基座，如果模块安装失败，不会影响整体应用健康状态。
使用：和普通 Spring Boot 应用的配置一致，在基座的 application.properties 中配置：

# 或者不配置 management.endpoints.web.exposure.include
management.endpoints.web.exposure.include=health
# 如果需要展示所有信息，则配置以下内容
management.endpoint.health.show-components=always
management.endpoint.health.show-details=always

访问：{baseIp:port}/actuator/health
结果：

{
    // 应用整体健康状态
    "status": "UP",
    "components": {
        // 模块聚合健康状态
        "arkBizAggregate": {
            "status": "UP",
            "details": {
                "biz1:0.0.1-SNAPSHOT": {
                    "status": "UP",
                    // 可以看到模块中所有生效的 HealthIndicator 的健康状态
                    "details": {
                        "diskSpace": {
                          "status": "UP",
                          "details": {
                            "total": 494384795648,
                            "free": 272435396608,
                            "threshold": 10485760,
                            "exists": true
                            }
                        },
                        "pingHe": {
                          "status": "UP",
                          "details": {}
                        }
                    }
                }
            }
        },
        // 启动健康状态
        "masterBizStartUp": {
            "status": "UP",
            // 包括每一个模块的启动状态
            "details": {
                "base:1.0.0": {
                    "status": "UP"
                },
                "biz1:0.0.1-SNAPSHOT": {
                    "status": "UP"
                },
                "biz2:0.0.1-SNAPSHOT": {
                    "status": "DOWN"
                }
            }
        }
    }
}

不同场景下的整体健康状态

场景1：无模块基座启动

状态	含义
UP	基座健康
UNKNOWN	基座正在启动中
DOWN	基座不健康

场景2：基座启动时，静态合并部署

状态	含义
UP	基座和模块都健康
UNKNOWN	基座正在启动中/模块正在启动中
DOWN	基座启动失败/基座不健康/模块启动失败/模块不健康

场景3：基座启动后，热部署

提供配置，让用户自行决定模块热部署结果是否影响应用整体健康状态（默认配置为：不影响整体应用原本的健康状态）

默认配置：热部署场景下，模块是否安装成功不影响应用整体健康状态，如下：

状态	含义
UP	基座和模块都健康
UNKNOWN	基座正在启动中
DOWN	基座启动失败/基座不健康/模块不健康

场景4：基座运行中

状态	含义
UP	基座和模块都健康
UNKNOWN	-
DOWN	基座不健康或模块不健康

场景5：基座启动后，模块回放

模块回放是指在基座启动后，自动拉取模块基线，并安装模块。

目前未支持模块回放。

模块启动是否成功影响整体应用健康状态

特点：对于健康的基座，如果模块安装失败，整体应用健康状态也会为失败。
使用：在上述配置之外，需要配置 koupleless.healthcheck.base.readiness.withAllBizReadiness=true，即在基座的 application.properties 中配置：

# 或者不配置 management.endpoints.web.exposure.include
management.endpoints.web.exposure.include=health
# 如果需要展示所有信息，则配置以下内容
management.endpoint.health.show-components=always
management.endpoint.health.show-details=always
# 不忽略模块启动状态
koupleless.healthcheck.base.readiness.withAllBizReadiness=true

访问：{baseIp:port}/actuator/health
结果：

{
    // 应用整体健康状态
    "status": "UP",
    "components": {
        // 模块聚合健康状态
        "arkBizAggregate": {
            "status": "UP",
            "details": {
                "biz1:0.0.1-SNAPSHOT": {
                    "status": "UP",
                    // 可以看到模块中所有生效的 HealthIndicator 的健康状态
                    "details": {
                        "diskSpace": {
                          "status": "UP",
                          "details": {
                            "total": 494384795648,
                            "free": 272435396608,
                            "threshold": 10485760,
                            "exists": true
                            }
                        },
                        "pingHe": {
                          "status": "UP",
                          "details": {}
                        }
                    }
                }
            }
        },
        // 启动健康状态
        "masterBizStartUp": {
            "status": "UP",
            // 包括每一个模块的启动状态
            "details": {
                "base:1.0.0": {
                    "status": "UP"
                },
                "biz1:0.0.1-SNAPSHOT": {
                    "status": "UP"
                }
            }
        }
    }
}

不同场景下的整体健康状态

场景1：无模块基座启动

状态	含义
UP	基座健康
UNKNOWN	基座正在启动中
DOWN	基座不健康

场景2：基座启动时，静态合并部署

状态	含义
UP	基座和模块都健康
UNKNOWN	基座正在启动中/模块正在启动中
DOWN	基座启动失败/基座不健康/模块启动失败/模块不健康

场景3：基座启动后，热部署

提供配置，让用户自行决定模块热部署结果是否影响应用整体健康状态（默认配置为：不影响整体应用原本的健康状态）

当设置为 koupleless.healthcheck.base.readiness.withAllBizReadiness=true

状态	含义
UP	基座和模块都健康
UNKNOWN	基座正在启动中/模块正在启动中
DOWN	基座启动失败/模块启动失败/基座不健康/模块不健康

场景4：基座运行中

状态	含义
UP	基座和模块都健康
UNKNOWN	-
DOWN	基座不健康或模块不健康

场景5：基座启动后，模块回放

模块回放是指在基座启动后，自动拉取模块基线，并安装模块。

目前未支持模块回放。

获取单个模块的健康状态

使用：和普通 springboot 的健康检查配置一致，开启 health 节点，即：在模块的 application.properties 中配置：

# 或者不配置 management.endpoints.web.exposure.include
management.endpoints.web.exposure.include=health

访问：{baseIp:port}/{bizWebContextPath}/actuator/info
结果：

{
    "status": "UP",
    "components": {
        "diskSpace": {
            "status": "UP",
            "details": {
                "total": 494384795648,
                "free": 270828220416,
                "threshold": 10485760,
                "exists": true
            }
        },
        "ping": {
            "status": "UP"
        }
    }
}

获取基座、模块和插件信息

使用：和普通 springboot 的健康检查配置一致，开启 info 节点，即：在基座的 application.properties 中配置：

# 注意：如果用户自行配置了 management.endpoints.web.exposure.include，则需要将 health 节点配置上，否则无法访问 health 节点
management.endpoints.web.exposure.include=health,info

访问：{baseIp:port}/actuator/info
结果：

{
    "arkBizInfo": [
      {
        "bizName": "biz1",
        "bizVersion": "0.0.1-SNAPSHOT",
        "bizState": "ACTIVATED",
        "webContextPath": "biz1"
      },
      {
        "bizName": "base",
        "bizVersion": "1.0.0",
        "bizState": "ACTIVATED",
        "webContextPath": "/"
      }
    ],
    "arkPluginInfo": [
        {
            "pluginName": "koupleless-adapter-log4j2",
            "groupId": "com.alipay.sofa.koupleless",
            "artifactId": "koupleless-adapter-log4j2",
            "pluginVersion": "1.0.1-SNAPSHOT",
            "pluginUrl": "file:/Users/lipeng/.m2/repository/com/alipay/sofa/koupleless/koupleless-adapter-log4j2/1.0.1-SNAPSHOT/koupleless-adapter-log4j2-1.0.1-SNAPSHOT.jar!/",
            "pluginActivator": "com.alipay.sofa.koupleless.adapter.Log4j2AdapterActivator"
        },
        {
            "pluginName": "web-ark-plugin",
            "groupId": "com.alipay.sofa",
            "artifactId": "web-ark-plugin",
            "pluginVersion": "2.2.9-SNAPSHOT",
            "pluginUrl": "file:/Users/lipeng/.m2/repository/com/alipay/sofa/web-ark-plugin/2.2.9-SNAPSHOT/web-ark-plugin-2.2.9-SNAPSHOT.jar!/",
            "pluginActivator": "com.alipay.sofa.ark.web.embed.WebPluginActivator"
        },
        {
            "pluginName": "koupleless-base-plugin",
            "groupId": "com.alipay.sofa.koupleless",
            "artifactId": "koupleless-base-plugin",
            "pluginVersion": "1.0.1-SNAPSHOT",
            "pluginUrl": "file:/Users/lipeng/.m2/repository/com/alipay/sofa/koupleless/koupleless-base-plugin/1.0.1-SNAPSHOT/koupleless-base-plugin-1.0.1-SNAPSHOT.jar!/",
            "pluginActivator": "com.alipay.sofa.koupleless.plugin.ServerlessRuntimeActivator"
        }
    ]
}

Feedback

Was this page helpful?

Welcome propose feedback to community!

Welcome propose feedback to community, or improve this document directly.。

最后修改 2024.14.11: Update module-startup.md (39aeb80)