Golang健康检查插件库health使用指南

health是一个简单灵活的Go应用健康检查库，可以帮助你监控应用的各种健康指标。下面我将详细介绍它的使用方法。

安装

go get github.com/alexliesenfeld/health

基本使用

创建健康检查器

package main

import (
	"github.com/alexliesenfeld/health"
	"net/http"
	"time"
)

func main() {
	// 创建健康检查器
	checker := health.NewChecker(
		// 设置检查名称
		health.WithName("my-service"),
		// 设置检查超时时间
		health.WithTimeout(5*time.Second),
		// 添加自定义检查项
		health.WithCheck(health.Check{
			Name: "database",
			Check: func() error {
				// 这里实现数据库连接检查
				return nil // 返回nil表示健康
			},
		}),
	)

	// 创建HTTP健康检查端点
	http.Handle("/health", health.NewHandler(checker))
	http.ListenAndServe(":8080", nil)
}

内置检查项

health提供了一些内置的检查项：

checker := health.NewChecker(
	// 检查HTTP服务
	health.WithHTTPCheck(health.HTTPCheckConfig{
		Name:       "api-service",
		URL:        "http://localhost:8080/api",
		Timeout:    3 * time.Second,
		StatusCode: 200,
	}),
	
	// 检查TCP连接
	health.WithTCPCheck(health.TCPCheckConfig{
		Name:    "redis",
		Address: "localhost:6379",
		Timeout: 2 * time.Second,
	}),
	
	// 检查DNS解析
	health.WithDNSCheck(health.DNSCheckConfig{
		Name:      "dns",
		Host:      "example.com",
		Timeout:   2 * time.Second,
	}),
)

高级功能

自定义响应格式

checker := health.NewChecker(
	health.WithName("custom-service"),
	health.WithCustomDetails(map[string]interface{}{
		"version": "1.0.0",
		"env":     "production",
	}),
)

http.Handle("/health", health.NewHandler(
	checker,
	health.WithResultWriter(&health.JSONResultWriter{
		PrettyPrint: true,
	}),
))

周期性检查

checker := health.NewChecker(
	health.WithPeriodicCheck(15*time.Second, 5*time.Second, health.Check{
		Name: "background-job",
		Check: func() error {
			// 实现周期性检查逻辑
			return nil
		},
	}),
)

组合多个检查器

mainChecker := health.NewChecker(
	health.WithName("main-service"),
)

dbChecker := health.NewChecker(
	health.WithName("database"),
	health.WithCheck(health.Check{
		Name: "connection",
		Check: func() error {
			// 数据库连接检查
			return nil
		},
	}),
)

// 将dbChecker作为子检查器
mainChecker.AddChecker("db", dbChecker)

完整示例

package main

import (
	"database/sql"
	"fmt"
	"github.com/alexliesenfeld/health"
	_ "github.com/lib/pq"
	"net/http"
	"time"
)

func main() {
	// 初始化数据库连接
	db, _ := sql.Open("postgres", "user=postgres dbname=test sslmode=disable")
	
	// 创建健康检查器
	checker := health.NewChecker(
		health.WithName("order-service"),
		health.WithVersion("1.2.3"),
		health.WithTimeout(10*time.Second),
		health.WithCustomDetails(map[string]interface{}{
			"commit":  "a1b2c3d",
			"deployed": time.Now().Format(time.RFC3339),
		}),
		
		// 数据库检查
		health.WithCheck(health.Check{
			Name: "postgres",
			Check: func() error {
				return db.Ping()
			},
		}),
		
		// 外部API检查
		health.WithHTTPCheck(health.HTTPCheckConfig{
			Name:       "payment-api",
			URL:        "http://payment-service:8080/health",
			Timeout:    3 * time.Second,
			StatusCode: 200,
		}),
		
		// 周期性检查后台任务
		health.WithPeriodicCheck(30*time.Second, 5*time.Second, health.Check{
			Name: "background-processor",
			Check: func() error {
				// 检查后台处理是否正常
				return nil
			},
		}),
	)
	
	// 添加HTTP健康检查端点
	http.Handle("/health", health.NewHandler(checker))
	
	// 添加就绪检查端点(只包含关键检查项)
	http.Handle("/ready", health.NewHandler(
		health.NewChecker(
			health.WithCheck(health.Check{
				Name: "postgres",
				Check: func() error {
					return db.Ping()
				},
			}),
		),
	))
	
	fmt.Println("Server started at :8080")
	http.ListenAndServe(":8080", nil)
}

最佳实践

1. 区分健康检查和就绪检查：

   • 健康检查(/health)：检查应用所有组件
   • 就绪检查(/ready)：只检查关键依赖项

2. 为检查项设置合理的超时时间

3. 在Kubernetes部署中：

   livenessProbe:
     httpGet:
       path: /health
       port: 8080
     initialDelaySeconds: 15
     periodSeconds: 10
     
   readinessProbe:
     httpGet:
       path: /ready
       port: 8080
     initialDelaySeconds: 5
     periodSeconds: 5
   

health库提供了简单而强大的健康检查功能，可以帮助你构建可靠的微服务应用。