go-health库使用指南

go-health是一个用于Golang服务的健康检查简化插件库，它提供了一种简单的方式来监控服务的健康状况并暴露检查结果。

安装

go get github.com/InVisionApp/go-health

基本使用

1. 初始化健康检查器

import (
	"github.com/InVisionApp/go-health"
	"github.com/InVisionApp/go-health/handlers"
	"net/http"
)

func main() {
	// 创建健康检查器实例
	h := health.New()
	
	// 配置健康检查器
	err := h.Start()
	if err != nil {
		panic("Failed to start health checker")
	}
	
	// 注册HTTP处理程序
	http.HandleFunc("/healthcheck", handlers.NewJSONHandlerFunc(h, nil))
	http.ListenAndServe(":8080", nil)
}

2. 添加自定义检查项

type myCustomCheck struct{}

// 实现Checker接口
func (c *myCustomCheck) Status() (interface{}, error) {
	// 在这里实现你的健康检查逻辑
	// 返回nil表示健康，返回error表示不健康
	return nil, nil
}

func addCustomCheck(h health.IHealth) {
	// 创建检查配置
	check := &health.Config{
		Name:     "database-check",
		Checker:  &myCustomCheck{},
		Interval: time.Duration(5) * time.Second,
		Fatal:    true, // 如果此项检查失败，整个服务视为不健康
	}
	
	// 添加检查项
	if err := h.AddCheck(check); err != nil {
		panic("Failed to add health check")
	}
}

3. 完整示例

package main

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

// 数据库健康检查
type DBCheck struct{}

func (c *DBCheck) Status() (interface{}, error) {
	// 这里模拟数据库检查
	// 实际应用中应该执行真正的数据库查询
	if time.Now().Unix()%2 == 0 {
		return nil, fmt.Errorf("database connection failed")
	}
	return map[string]interface{}{"connections": 10}, nil
}

// 外部API健康检查
type APICheck struct{}

func (c *APICheck) Status() (interface{}, error) {
	// 模拟外部API检查
	if time.Now().Unix()%3 == 0 {
		return nil, fmt.Errorf("API timeout")
	}
	return "ok", nil
}

func main() {
	// 初始化健康检查器
	h := health.New()
	
	// 添加数据库检查
	dbCheck := &health.Config{
		Name:     "database",
		Checker:  &DBCheck{},
		Interval: time.Duration(2) * time.Second,
		Fatal:    true,
	}
	
	// 添加API检查
	apiCheck := &health.Config{
		Name:     "external-api",
		Checker:  &APICheck{},
		Interval: time.Duration(3) * time.Second,
		Fatal:    false,
	}
	
	if err := h.AddChecks([]*health.Config{dbCheck, apiCheck}); err != nil {
		panic(err)
	}
	
	// 启动健康检查器
	if err := h.Start(); err != nil {
		panic(err)
	}
	
	// 设置HTTP路由
	http.HandleFunc("/health", handlers.NewJSONHandlerFunc(h, nil))
	http.HandleFunc("/health/basic", handlers.NewBasicHandlerFunc(h))
	
	fmt.Println("Server started at :8080")
	http.ListenAndServe(":8080", nil)
}

高级功能

1. 自定义响应格式

http.HandleFunc("/health/custom", func(w http.ResponseWriter, r *http.Request) {
	state, details, err := h.State()
	if err != nil {
		w.WriteHeader(http.StatusServiceUnavailable)
		fmt.Fprintf(w, "Service Unhealthy: %v", err)
		return
	}
	
	if !state {
		w.WriteHeader(http.StatusServiceUnavailable)
	}
	
	// 自定义响应格式
	fmt.Fprintf(w, "Status: %v\nDetails: %+v", state, details)
})

2. 监听健康状态变化

h.AddListener(&health.StateListener{
	Name: "my-listener",
	OnStateChange: func(name string, state health.State) {
		fmt.Printf("Check '%s' changed state to %v\n", name, state)
	},
})

3. 动态添加/移除检查

// 动态添加检查
newCheck := &health.Config{
	Name:     "new-check",
	Checker:  &APICheck{},
	Interval: time.Duration(10) * time.Second,
}
h.AddCheck(newCheck)

// 动态移除检查
h.RemoveCheck("database")

最佳实践

1. 关键组件检查：为数据库、缓存、外部API等关键依赖项添加健康检查
2. 合理设置检查间隔：根据组件特性设置适当的检查频率
3. 区分致命与非致命检查：使用Fatal标记区分服务核心组件和非核心组件
4. 提供详细信息：在检查器的Status()方法中返回有用的诊断信息
5. 监控健康状态：使用监听器记录健康状态变化，便于问题排查

go-health库简化了服务健康检查的实现，通过简单的API即可构建全面的健康监控系统，非常适合微服务架构中的服务健康管理。