1. 为什么需要健康检查接口
在云原生和微服务架构中,健康检查接口是确保服务可靠性的关键组件。我经历过多次线上事故,都是因为缺少有效的健康检查机制,导致流量持续打到已经异常的服务实例上。Kubernetes等编排系统正是通过定期调用这些端点来决定容器的生命周期。
健康检查主要分为两类:
- Liveness(存活检查):告诉系统应用是否在运行
- Readiness(准备就绪检查):指示应用是否准备好接收流量
2. 基础实现方案
2.1 使用标准库实现
最简单的实现方式是使用net/http包:
package main import ( "net/http" ) func livenessHandler(w http.ResponseWriter, r *http.Request) { w.WriteHeader(http.StatusOK) w.Write([]byte("OK")) } func readinessHandler(w http.ResponseWriter, r *http.Request) { // 添加你的依赖检查逻辑 w.WriteHeader(http.StatusOK) w.Write([]byte("OK")) } func main() { http.HandleFunc("/healthz", livenessHandler) http.HandleFunc("/ready", readinessHandler) http.ListenAndServe(":8080", nil) }2.2 添加依赖检查
真正的readiness检查应该包含关键依赖状态验证:
func readinessHandler(w http.ResponseWriter, r *http.Request) { // 检查数据库连接 if err := checkDatabase(); err != nil { w.WriteHeader(http.StatusServiceUnavailable) w.Write([]byte("Database unavailable")) return } // 检查缓存连接 if err := checkCache(); err != nil { w.WriteHeader(http.StatusServiceUnavailable) w.Write([]byte("Cache unavailable")) return } w.WriteHeader(http.StatusOK) w.Write([]byte("OK")) }3. 高级实现技巧
3.1 使用中间件封装
对于大型项目,建议使用中间件模式:
type HealthCheck struct { DB *sql.DB Cache *redis.Client } func (h *HealthCheck) Liveness() http.HandlerFunc { return func(w http.ResponseWriter, r *http.Request) { w.WriteHeader(http.StatusOK) w.Write([]byte("OK")) } } func (h *HealthCheck) Readiness() http.HandlerFunc { return func(w http.ResponseWriter, r *http.Request) { if err := h.DB.Ping(); err != nil { respondUnhealthy(w, "database") return } if _, err := h.Cache.Ping().Result(); err != nil { respondUnhealthy(w, "cache") return } w.WriteHeader(http.StatusOK) w.Write([]byte("OK")) } } func respondUnhealthy(w http.ResponseWriter, service string) { w.WriteHeader(http.StatusServiceUnavailable) w.Write([]byte(fmt.Sprintf("%s unavailable", service))) }3.2 添加指标和日志
在生产环境中,应该记录检查失败的情况:
func (h *HealthCheck) Readiness() http.HandlerFunc { return func(w http.ResponseWriter, r *http.Request) { logger := log.WithField("endpoint", "readiness") if err := h.DB.Ping(); err != nil { logger.WithError(err).Error("Database health check failed") respondUnhealthy(w, "database") return } // 其他检查... } }4. Kubernetes集成实践
4.1 配置Deployment
在K8s部署文件中需要明确定义检查端点:
apiVersion: apps/v1 kind: Deployment spec: template: spec: containers: - name: my-app livenessProbe: httpGet: path: /healthz port: 8080 initialDelaySeconds: 15 periodSeconds: 20 readinessProbe: httpGet: path: /ready port: 8080 initialDelaySeconds: 5 periodSeconds: 104.2 重要参数说明
initialDelaySeconds: 容器启动后等待多长时间开始检查periodSeconds: 检查间隔时间timeoutSeconds: 检查超时时间failureThreshold: 连续失败多少次才认为不健康
5. 性能优化建议
5.1 避免频繁的昂贵检查
对于数据库等重型依赖,不要每次readiness检查都执行完整验证:
var lastDBCheck time.Time var dbHealthy bool func (h *HealthCheck) checkDB() bool { now := time.Now() if now.Sub(lastDBCheck) < 30*time.Second { return dbHealthy } dbHealthy = h.DB.Ping() == nil lastDBCheck = now return dbHealthy }5.2 实现渐进式检查
根据系统负载动态调整检查频率:
func (h *HealthCheck) shouldRunFullCheck() bool { if load := getSystemLoad(); load > 0.8 { return false } return true }6. 常见问题排查
6.1 检查端点返回慢
可能原因:
- 同步锁竞争
- 垃圾回收停顿
- 检查逻辑过于复杂
解决方案:
- 使用缓存检查结果
- 将检查移到后台goroutine
- 简化检查逻辑
6.2 Kubernetes频繁重启容器
典型配置问题:
livenessProbe: failureThreshold: 1 # 太敏感 periodSeconds: 1 # 太频繁建议值:
livenessProbe: failureThreshold: 3 periodSeconds: 107. 安全注意事项
7.1 端点保护
健康检查端点应该:
- 限制访问IP(如果是内部使用)
- 不记录敏感信息
- 考虑添加简单认证
7.2 信息暴露控制
避免在响应中暴露:
- 内部IP地址
- 敏感配置信息
- 详细的错误堆栈
8. 测试策略
8.1 单元测试示例
func TestLivenessHandler(t *testing.T) { req := httptest.NewRequest("GET", "/healthz", nil) w := httptest.NewRecorder() livenessHandler(w, req) resp := w.Result() if resp.StatusCode != http.StatusOK { t.Errorf("Expected status OK, got %v", resp.StatusCode) } }8.2 集成测试建议
- 模拟依赖故障测试readiness变化
- 测试并发访问下的正确性
- 验证K8s探针配置的实际效果
9. 高级模式
9.1 分级健康状态
除了简单的OK/Not OK,可以实现状态分级:
type HealthStatus struct { Status string `json:"status"` // "healthy", "degraded", "unhealthy" Details map[string]string `json:"details"` Since time.Time `json:"since"` }9.2 健康状态订阅
允许其他服务订阅健康状态变化:
type HealthEvent struct { Service string Status string Time time.Time } var healthSubscribers []chan<- HealthEvent func notifySubscribers(service, status string) { event := HealthEvent{ Service: service, Status: status, Time: time.Now(), } for _, ch := range healthSubscribers { select { case ch <- event: default: // 避免阻塞 } } }10. 生产环境经验
在实际部署中,我发现几个关键点:
初始延迟:
initialDelaySeconds应该大于应用实际启动时间,特别是需要预热的应用检查超时:默认1秒可能太短,对于有冷启动的服务应该适当延长
日志级别:健康检查失败应该记录为错误级别,但频繁检查成功应该用debug级别
状态持久化:考虑将健康状态持久化,方便故障排查时查看历史记录
版本兼容:当健康检查API变更时,确保旧版本客户端能够继续工作