Go-Health: Golang异步依赖健康检查库

go-health是一个用于Golang的轻量级健康检查库，它允许你异步监控各种依赖项（如数据库、外部API等）的健康状态。下面我将详细介绍如何使用这个库。

安装

go get github.com/InVisionApp/go-health

基本使用

1. 初始化健康检查器

package main

import (
	"fmt"
	"time"
	
	"github.com/InVisionApp/go-health"
	"github.com/InVisionApp/go-health/checkers"
	"github.com/InVisionApp/go-health/handlers"
)

func main() {
	// 创建健康检查实例
	h := health.New()
	
	// 添加检查器配置
	checkerConfig := &health.Config{
		Name:     "redis-check",
		Checker:  checkers.NewRedisChecker(&checkers.RedisConfig{
			Host: "localhost",
			Port: 6379,
		}),
		Interval: time.Duration(5) * time.Second,
		Fatal:   true,
	}
	
	// 添加检查器
	if err := h.AddChecks([]*health.Config{checkerConfig}); err != nil {
		fmt.Printf("Unable to add healthcheck: %s", err.Error())
	}
	
	// 启动健康检查器
	if err := h.Start(); err != nil {
		fmt.Printf("Unable to start healthcheck: %s", err.Error())
	}
	
	// 注册HTTP处理器
	http.HandleFunc("/health", handlers.NewJSONHandlerFunc(h, nil))
	http.ListenAndServe(":8080", nil)
}

2. 自定义检查器

你可以创建自定义检查器来实现特定的健康检查逻辑：

type myCustomChecker struct{}

func (c *myCustomChecker) Status() (interface{}, error) {
	// 实现你的健康检查逻辑
	// 返回nil表示健康
	// 返回error表示不健康
	
	// 示例：模拟一个有时会失败的外部服务
	if time.Now().Second()%2 == 0 {
		return nil, fmt.Errorf("service is down")
	}
	return map[string]interface{}{"status": "ok"}, nil
}

func main() {
	h := health.New()
	
	customChecker := &myCustomChecker{}
	
	config := &health.Config{
		Name:     "custom-service",
		Checker:  customChecker,
		Interval: time.Duration(2) * time.Second,
		Fatal:   false,
	}
	
	if err := h.AddChecks([]*health.Config{config}); err != nil {
		fmt.Printf("Error adding check: %v", err)
	}
	
	if err := h.Start(); err != nil {
		fmt.Printf("Error starting healthcheck: %v", err)
	}
	
	// 可以定期获取状态
	for {
		state, err := h.State()
		if err != nil {
			fmt.Printf("Error getting state: %v", err)
		} else {
			fmt.Printf("Current health state: %+v\n", state)
		}
		time.Sleep(5 * time.Second)
	}
}

3. 内置检查器

go-health提供了一些内置检查器：

• HTTP检查器：检查HTTP端点
• Redis检查器：检查Redis连接
• PostgreSQL检查器：检查PostgreSQL连接
• MySQL检查器：检查MySQL连接

// HTTP检查器示例
httpChecker, err := checkers.NewHTTPChecker(
	"http-service",
	"http://example.com/health",
	"GET",
	nil,
	nil,
	time.Duration(1)*time.Second,
)
if err != nil {
	// 处理错误
}

httpConfig := &health.Config{
	Name:     "http-service-check",
	Checker:  httpChecker,
	Interval: time.Duration(5) * time.Second,
	Fatal:   false,
}

// 数据库检查器示例
pgChecker, err := checkers.NewPostgreSQLChecker(&checkers.PostgreSQLConfig{
	Host:     "localhost",
	Port:     5432,
	Username: "postgres",
	Password: "password",
	Database: "testdb",
})
if err != nil {
	// 处理错误
}

pgConfig := &health.Config{
	Name:     "postgres-check",
	Checker:  pgChecker,
	Interval: time.Duration(10) * time.Second,
	Fatal:   true,
}

4. 状态监听器

你可以添加状态监听器来响应健康状态的变化：

type myStateListener struct{}

func (l *myStateListener) HealthCheckStateChanged(name string, state health.State) {
	fmt.Printf("Health check '%s' state changed: %+v\n", name, state)
}

func main() {
	h := health.New()
	
	// 添加状态监听器
	h.AddListener(&myStateListener{})
	
	// 添加检查器和启动代码...
}

高级特性

1. 自定义HTTP响应

http.HandleFunc("/custom-health", func(w http.ResponseWriter, r *http.Request) {
	state, err := h.State()
	if err != nil {
		w.WriteHeader(http.StatusServiceUnavailable)
		fmt.Fprintf(w, `{"error": "%s"}`, err.Error())
		return
	}
	
	// 自定义响应格式
	response := map[string]interface{}{
		"timestamp": time.Now().UTC().Format(time.RFC3339),
		"status":    "ok",
		"details":   state,
	}
	
	json.NewEncoder(w).Encode(response)
})

2. 动态添加/移除检查器

// 动态添加检查器
newChecker := &myCustomChecker{}
newConfig := &health.Config{
	Name:     "dynamic-check",
	Checker:  newChecker,
	Interval: time.Duration(3) * time.Second,
}

if err := h.AddCheck(newConfig); err != nil {
	fmt.Printf("Error adding dynamic check: %v", err)
}

// 动态移除检查器
if err := h.RemoveCheck("dynamic-check"); err != nil {
	fmt.Printf("Error removing check: %v", err)
}

3. 优雅关闭

// 创建可以取消的context
ctx, cancel := context.WithCancel(context.Background())
defer cancel()

// 启动健康检查
if err := h.StartWithContext(ctx); err != nil {
	fmt.Printf("Error starting healthcheck: %v", err)
}

// 在程序退出时
cancel()

最佳实践

1. 关键依赖使用Fatal标记：对于应用必须的依赖项，设置Fatal: true，这样当这些依赖项不健康时，整个健康检查状态会反映出来。

2. 合理设置检查间隔：根据依赖项的重要性和响应时间设置适当的检查间隔，避免过于频繁的检查导致性能问题。

3. 组合使用内置和自定义检查器：充分利用内置检查器，同时为特殊需求创建自定义检查器。

4. 实现状态监听：对于关键服务，实现状态监听器以便快速响应服务状态变化。

5. 提供丰富的HTTP端点：除了基本的健康检查端点，可以提供更详细的诊断信息端点。

go-health是一个灵活且强大的库，可以帮助你构建健壮的应用程序健康检查系统。通过异步检查和状态监控，你可以及时发现并响应依赖项的问题，提高系统的可靠性。