Golang高性能并发健康检查HTTP处理器插件库healthcheck使用指南

healthcheck是一个轻量级、高性能的Go库，用于为HTTP服务添加健康检查端点。它支持并发检查多个依赖项，并提供简洁的API来定义自定义检查逻辑。

安装

go get github.com/tavsec/healthcheck

基本使用

1. 创建健康检查处理器

package main

import (
	"fmt"
	"net/http"
	
	"github.com/tavsec/healthcheck"
)

func main() {
	// 创建健康检查配置
	config := healthcheck.Config{
		ResultWriter: healthcheck.NewJSONResultWriter(),
		CacheDuration: 5 * time.Second, // 缓存结果5秒
	}

	// 创建健康检查处理器
	handler := healthcheck.New(config)

	// 添加简单的健康检查
	handler.AddCheck("simple-check", healthcheck.Check{
		Timeout: 2 * time.Second,
		Check: func() error {
			// 模拟检查逻辑
			return nil // 返回nil表示健康
		},
	})

	// 注册HTTP处理器
	http.Handle("/health", handler.Handler())
	
	fmt.Println("Server started at :8080")
	http.ListenAndServe(":8080", nil)
}

2. 检查HTTP服务

// 添加HTTP服务检查
handler.AddCheck("api-service", healthcheck.Check{
	Timeout: 3 * time.Second,
	Check: func() error {
		resp, err := http.Get("https://api.example.com/health")
		if err != nil {
			return err
		}
		defer resp.Body.Close()
		
		if resp.StatusCode != http.StatusOK {
			return fmt.Errorf("unexpected status code: %d", resp.StatusCode)
		}
		return nil
	},
})

3. 数据库健康检查示例

import (
	"database/sql"
	_ "github.com/lib/pq"
)

func main() {
	// ... 前面的配置代码 ...
	
	db, err := sql.Open("postgres", "postgres://user:pass@localhost/dbname")
	if err != nil {
		panic(err)
	}
	
	// 添加数据库健康检查
	handler.AddCheck("postgres-db", healthcheck.Check{
		Timeout: 2 * time.Second,
		Check: func() error {
			return db.Ping()
		},
	})
	
	// ... 启动服务器代码 ...
}

高级功能

1. 自定义结果格式

// 自定义JSON输出格式
type CustomResultWriter struct{}

func (w *CustomResultWriter) Write(result healthcheck.Result) ([]byte, error) {
	status := "OK"
	if !result.Healthy {
		status = "ERROR"
	}
	
	custom := struct {
		Status  string            `json:"status"`
		Details map[string]string `json:"details"`
	}{
		Status:  status,
		Details: make(map[string]string),
	}
	
	for name, check := range result.Checks {
		if check.Error != nil {
			custom.Details[name] = check.Error.Error()
		} else {
			custom.Details[name] = "healthy"
		}
	}
	
	return json.Marshal(custom)
}

// 使用自定义结果写入器
config := healthcheck.Config{
	ResultWriter: &CustomResultWriter{},
}

2. 并发检查配置

config := healthcheck.Config{
	ResultWriter:   healthcheck.NewJSONResultWriter(),
	CacheDuration:  5 * time.Second,
	MaxConcurrency: 10, // 最大并发检查数
}

3. 中间件集成

// Gin框架中间件
func HealthCheckMiddleware(handler *healthcheck.Healthcheck) gin.HandlerFunc {
	return func(c *gin.Context) {
		if c.Request.URL.Path == "/health" {
			handler.Handler().ServeHTTP(c.Writer, c.Request)
			c.Abort()
			return
		}
		c.Next()
	}
}

// 在Gin中使用
r := gin.Default()
r.Use(HealthCheckMiddleware(handler))

性能优化建议

1. 合理设置缓存时间：根据业务需求设置CacheDuration，避免频繁执行检查
2. 控制超时时间：为每个检查设置合理的Timeout，防止长时间阻塞
3. 限制并发数：通过MaxConcurrency控制最大并发检查数
4. 避免复杂逻辑：检查逻辑应尽量简单，复杂检查可以拆分为多个简单检查

响应示例

健康响应:

{
  "healthy": true,
  "checks": {
    "simple-check": {
      "healthy": true,
      "error": null,
      "duration": "123.456µs"
    },
    "api-service": {
      "healthy": true,
      "error": null,
      "duration": "45.678ms"
    }
  }
}

不健康响应:

{
  "healthy": false,
  "checks": {
    "simple-check": {
      "healthy": true,
      "error": null,
      "duration": "123.456µs"
    },
    "api-service": {
      "healthy": false,
      "error": "unexpected status code: 503",
      "duration": "1.234s"
    }
  }
}

healthcheck库提供了灵活而强大的健康检查功能，适合在微服务架构和云原生应用中使用，帮助监控系统健康状况。