EaseProbe: Golang轻量级健康状态检测与多协议通知插件库

EaseProbe是一个用Go语言编写的轻量级健康状态检测工具，支持多协议通知功能。下面我将详细介绍它的使用方法和示例代码。

主要特性

1. 多协议支持：HTTP/HTTPS/TCP/SSH/Shell命令等多种检测方式
2. 多通知渠道：支持Slack/Telegram/Email/Discord/Webhook等多种通知方式
3. 轻量级：资源占用低，适合容器化部署
4. 配置简单：YAML格式配置文件，易于使用

安装方法

go get github.com/megaease/easeprobe

或者直接下载预编译二进制文件：

wget https://github.com/megaease/easeprobe/releases/latest/download/easeprobe
chmod +x easeprobe

基本使用示例

1. 简单HTTP检测

package main

import (
	"github.com/megaease/easeprobe/probe"
	"github.com/megaease/easeprobe/notify"
)

func main() {
	// 创建一个HTTP探针
	httpProbe := probe.HTTPProbe{
		Name:    "Example Website",
		URL:     "https://example.com",
		Timeout: 5 * time.Second,
	}

	// 创建Slack通知
	slackNotify := notify.Slack{
		WebhookURL: "https://hooks.slack.com/services/...",
		Channel:    "#alerts",
	}

	// 配置EaseProbe
	easeProbe := probe.NewEaseProbe()
	easeProbe.AddProbe(&httpProbe)
	easeProbe.AddNotifier(&slackNotify)

	// 启动检测
	easeProbe.Start()
}

2. 完整配置文件示例

更常见的用法是通过YAML配置文件：

# easeprobe.yaml

# 全局设置
settings:
  name: "EaseProbe Demo"
  interval: 1m
  log:
    file: "/var/log/easeprobe.log"
    level: "info"

# 探针配置
probes:
  - name: "Google HTTP"
    type: "http"
    url: "https://www.google.com"
    timeout: 5s

  - name: "MySQL Database"
    type: "tcp"
    host: "mysql.example.com:3306"
    timeout: 3s

  - name: "Disk Usage"
    type: "shell"
    command: "df -h"
    args: []
    timeout: 10s
    threshold:
      failure: 90
      warning: 80

# 通知配置
notify:
  - name: "Slack Alert"
    type: "slack"
    webhook: "https://hooks.slack.com/services/..."
    channel: "#alerts"
    dry: false

  - name: "Email Notification"
    type: "email"
    server: "smtp.example.com:587"
    username: "user@example.com"
    password: "password"
    to: "admin@example.com"

高级功能示例

1. 自定义检测逻辑

package main

import (
	"time"
	"github.com/megaease/easeprobe/probe"
)

type CustomProbe struct {
	probe.DefaultProbe
	CustomField string
}

func (p *CustomProbe) Config(g probe.ProbeConfig) error {
	p.DefaultProbe.Config(g)
	// 自定义初始化逻辑
	return nil
}

func (p *CustomProbe) DoProbe() (bool, string) {
	// 自定义检测逻辑
	if p.CustomField == "expected" {
		return true, "All good"
	}
	return false, "Custom condition not met"
}

func main() {
	customProbe := &CustomProbe{
		DefaultProbe: probe.DefaultProbe{
			Name:    "Custom Probe",
			Timeout: 10 * time.Second,
		},
		CustomField: "expected",
	}

	easeProbe := probe.NewEaseProbe()
	easeProbe.AddProbe(customProbe)
	easeProbe.Start()
}

2. 多通知渠道组合

package main

import (
	"github.com/megaease/easeprobe/probe"
	"github.com/megaease/easeprobe/notify"
)

func main() {
	// 创建多个通知渠道
	slack := &notify.Slack{
		WebhookURL: "https://hooks.slack.com/services/...",
		Channel:    "#alerts",
	}
	
	email := &notify.Email{
		Server:   "smtp.example.com:587",
		Username: "user@example.com",
		Password: "password",
		To:       "admin@example.com",
	}
	
	// 创建通知链
	notifier := notify.NewChainNotifier()
	notifier.AddNotifier(slack)
	notifier.AddNotifier(email)
	
	// 配置探针
	httpProbe := &probe.HTTPProbe{
		Name:    "Example Service",
		URL:     "https://example.com",
		Timeout: 5 * time.Second,
		Notifier: notifier,
	}
	
	// 启动
	easeProbe := probe.NewEaseProbe()
	easeProbe.AddProbe(httpProbe)
	easeProbe.Start()
}

最佳实践

1. 合理设置检测间隔：根据服务重要性设置不同的检测频率
2. 分级通知：对关键服务和非关键服务使用不同的通知渠道
3. 设置阈值：对资源使用类检测设置合理的告警阈值
4. 日志记录：保留检测日志用于故障排查
5. 容器化部署：使用Docker或Kubernetes部署，方便扩展和管理

EaseProbe是一个功能强大但使用简单的工具，特别适合需要轻量级监控解决方案的场景。通过灵活的配置和扩展能力，可以满足大多数健康检测和告警需求。