Balerter - 自托管脚本化告警管理工具

Balerter 是一个用 Go 语言编写的自托管脚本化告警管理工具，它允许您使用 Lua 脚本编写自定义告警逻辑，并支持多种通知渠道。

主要特性

1. 轻量级且易于部署
2. 使用 Lua 脚本编写告警逻辑
3. 支持多种数据源和通知渠道
4. 内置 HTTP API 和 Web 界面
5. 可扩展的架构

安装与运行

使用 Docker 运行

docker run -d -p 1323:1323 -v /path/to/config:/etc/balerter balerter/balerter

从源码编译

git clone https://github.com/balerter/balerter.git
cd balerter
go build -o balerter main.go
./balerter

基本配置示例

创建 config.yml 配置文件：

storage:
  sqlite:
    path: "./balerter.db"

scripts:
  path: "./scripts"

channels:
  telegram:
    token: "YOUR_TELEGRAM_BOT_TOKEN"
    chat_id: "YOUR_CHAT_ID"

logging:
  level: "info"

编写告警脚本

在 scripts 目录下创建 Lua 脚本文件（如 cpu_check.lua）：

-- 定义一个定时任务，每分钟执行一次
job("cpu_check", function()
    -- 模拟获取 CPU 使用率
    local cpu_usage = math.random(0, 100)
    
    -- 如果 CPU 使用率超过 90%，发送告警
    if cpu_usage > 90 then
        alert({
            title = "High CPU Usage",
            text = "CPU usage is " .. cpu_usage .. "%",
            level = "critical"
        })
    end
end)

完整 Go 集成示例

以下是如何在 Go 应用中集成 Balerter 的示例：

package main

import (
	"log"
	"net/http"

	"github.com/balerter/balerter"
)

func main() {
	// 创建 Balerter 实例
	b, err := balerter.New("./config.yml")
	if err != nil {
		log.Fatal(err)
	}

	// 启动 Balerter
	go func() {
		if err := b.Run(); err != nil {
			log.Fatal(err)
		}
	}()

	// 添加自定义 HTTP 端点用于触发告警
	http.HandleFunc("/trigger", func(w http.ResponseWriter, r *http.Request) {
		// 调用 Balerter 的 API 发送告警
		resp, err := http.Post("http://localhost:1323/api/v1/alert", "application/json", 
			strings.NewReader(`{
				"title": "Manual Alert",
				"text": "This alert was triggered manually",
				"level": "warning"
			}`))
		if err != nil {
			http.Error(w, err.Error(), http.StatusInternalServerError)
			return
		}
		defer resp.Body.Close()
		
		w.WriteHeader(http.StatusOK)
		w.Write([]byte("Alert triggered"))
	})

	// 启动 HTTP 服务器
	log.Println("Starting server on :8080")
	log.Fatal(http.ListenAndServe(":8080", nil))
}

高级功能

数据源集成

Balerter 支持多种数据源，如 Prometheus、MySQL 等。以下是配置 Prometheus 数据源的示例：

datasources:
  prometheus:
    - name: "main"
      url: "http://prometheus:9090"

然后在 Lua 脚本中使用：

job("check_http_errors", function()
    local result, err = prometheus("main", 'sum(rate(http_requests_total{status=~"5.."}[5m])) by (service)')
    
    if err ~= nil then
        error(err)
    end
    
    for _, row in ipairs(result) do
        if row.value > 10 then
            alert({
                title = "High HTTP 5xx Errors - " .. row.metric.service,
                text = "5xx error rate is " .. row.value .. " for service " .. row.metric.service,
                level = "warning"
            })
        end
    end
end)

多通知渠道

Balerter 支持多种通知渠道，如 Slack、Telegram、Email 等：

channels:
  slack:
    - name: "alerts"
      webhook: "https://hooks.slack.com/services/..."
  
  email:
    - name: "admin"
      from: "alerts@example.com"
      to: "admin@example.com"
      smtp_host: "smtp.example.com"
      smtp_port: 587
      smtp_username: "user"
      smtp_password: "pass"

监控与管理

Balerter 提供了内置的监控 API：

// 查询活跃告警
resp, err := http.Get("http://localhost:1323/api/v1/alerts")
if err != nil {
    log.Fatal(err)
}
defer resp.Body.Close()

body, _ := io.ReadAll(resp.Body)
fmt.Println("Active alerts:", string(body))

最佳实践

1. 为不同类型的告警创建单独的脚本文件
2. 使用适当的告警级别（critical, warning, info）
3. 实现告警抑制逻辑避免告警风暴
4. 定期审查和优化告警规则
5. 为关键告警设置多种通知渠道

Balerter 是一个灵活且强大的工具，特别适合需要自定义告警逻辑的场景。通过 Lua 脚本，您可以实现几乎任何类型的监控和告警需求，而 Go 语言的强大性能保证了系统的高效运行。