coco/upp-aggregate-healthcheck

upp-aggregate-healthcheck

概述

该服务用于聚合Kubernetes集群中服务和Pod的健康检查结果，提供服务与Pod健康状态查询、不健康服务确认及粘性分类管理等功能。

核心功能

获取服务健康状态

服务健康的判定条件为其所有Pod均健康，通过查询每个Pod的__health端点评估Pod状态。服务按分类分组，支持指定分类查询；未指定分类时返回所有服务健康状态。

获取服务的Pod健康状态

通过查询Pod内应用的__health端点评估Pod健康状态。若Pod中至少一项检查失败，根据失败检查的严重级别，Pod状态判定为警告或严重。

确认服务

服务不健康时可确认警告状态。确认所有不健康服务后，聚合健康检查的整体状态将变为健康（并提示有“n”个服务已确认）。

粘性分类

分类可设为粘性，即若分类中任一服务不健康，该分类将被禁用（状态变为不健康），直至手动重新启用，提供启用分类的端点。

本地运行

依赖准备

本地运行前需获取项目依赖，执行以下命令：

shell
go build

功能限制

本地环境功能有限（需访问集群内Pod），仅支持以下功能：

• 添加/移除服务确认
• 启用/禁用粘性分类

构建与部署

Docker镜像构建使用仓库：https://hub.docker.com/r/coco/upp-aggregate-healthcheck/

服务配置要求

服务需满足以下条件才能被聚合健康检查纳入监控：

• Kubernetes服务必须添加标签：__hasHealthcheck: "true"
• 容器需配置Kubernetes readinessProbe（就绪探针），检查应用的__gtg端点

分类配置

分类通过Kubernetes ConfigMap定义，模板如下：

yaml
kind: ConfigMap
apiVersion: v1
metadata:
  name: category.CATEGORY-NAME # 分类名称
  labels:
    healthcheck-categories-for: aggregate-healthcheck # 聚合健康检查服务识别标签
data:
  category.name: CATEGORY-NAME # 分类名称
  category.services: serviceName1, serviceName2, serviceName3 # 分类包含的服务列表
  category.refreshrate: "60" # 缓存刷新间隔（秒，默认60）
  category.issticky: "false" # 是否为粘性分类（默认false）
  category.enabled: "true" # 是否启用分类（默认true）

端点说明

支持两种响应格式：

• JSON格式：请求头添加"Accept: application/json"
• HTML格式：默认响应格式

通用参数说明

• pathPrefix：路径前缀，默认为空。以下示例假设pathPrefix为__health

服务端点详情

__gtg（健康就绪端点）

• 功能：检查服务健康就绪状态
• 参数：
  • categories：指定分类（多个分类用逗号分隔）
  • cache：是否使用缓存（默认true，设为false时实时检查）
• 返回状态：
  • 503 Service Unavailable：至少一个指定分类被禁用，或至少一个服务不健康
  • 200 OK：其他情况
• 示例：localhost:8080/__gtg?cache=false&categories=read,publish

<pathPrefix>/__health 或 <pathPrefix>（服务健康检查端点）

• 功能：执行服务健康检查
• 参数：
  • categories：指定分类（多个分类用逗号分隔）
  • cache：是否使用缓存（默认true）
• 示例：localhost:8080/__health?cache=false&categories=read,publish

<pathPrefix>/__pods-health（Pod健康检查端点）

• 功能：查询指定服务的Pod健康状态
• 参数：
  • service-name：服务名称（必填）
• 示例：localhost:8080/__health/__pods-health?service-name=api-policy-component

<pathPrefix>/__pod-individual-health（单个Pod健康检查端点）

• 功能：查询指定Pod的健康状态
• 参数：
  • pod-name：Pod名称（必填）
• 示例：localhost:8080/__health/__pod-individual-health?pod-name=api-policy-component2912-12341

<pathPrefix>/add-ack（确认服务端点，POST方法）

• 功能：确认不健康服务
• 参数：
  • service-name：服务名称（必填）
• 请求体：ack-msg：确认消息
• 示例：localhost:8080/__health/add-ack?service-name=api-policy-component（请求体：ack-msg=这是确认消息）

<pathPrefix>/rem-ack（取消确认端点）

• 功能：取消服务确认状态
• 参数：
  • service-name：服务名称（必填）
• 示例：localhost:8080/__health/rem-ack?service-name=api-policy-component

<pathPrefix>/enable-category（启用分类端点）

• 功能：启用被禁用的粘性分类
• 参数：
  • category-name：分类名称（必填）
• 示例：localhost:8080/__health/enable-category?category-name=read

<pathPrefix>/disable-category（禁用分类端点）

• 功能：禁用分类（故障转移时使用）
• 参数：
  • category-name：分类名称（必填）
• 示例：localhost:8080/__health/disable-category?category-name=read