cmaster11/overseer

Overseer

Overseer是一个简单且可扩展的基于Golang的远程协议测试器，用于监控网络状态及运行在其上的服务。作为"远程协议测试器"，它能验证远程服务是否正常运行，并内置对多种协议的测试支持。

核心功能和特性

支持的协议

Overseer内置支持以下协议的测试：

• DNS服务器（测试A、AAAA、MX、NS和TXT记录查询）
• Finger
• FTP
• HTTP & HTTPS（支持基本认证、多种请求方法、SSL证书验证和过期警告）
• IMAP & IMAPS
• Kubernetes服务端点检查
• MySQL
• NNTP
• ping / ping6
• POP3 & POP3S
• Postgres
• Redis
• rsync
• SMTP
• SSH
• SSL
• Telnet
• VNC
• XMPP

测试定义格式

测试通过简单的文本格式定义，基本形式为：

$TARGET must run $SERVICE [with $OPTION_NAME $VALUE] ..

其他特性

• 透明支持IPv4和IPv6测试，可全局禁用任一地址族
• 分布式架构，支持水平扩展测试能力
• 测试失败重试机制，避免因临时故障导致的误报
• 结果去重功能，防止重复告警
• metrics导出支持，可集成到碳服务器

使用场景和适用范围

• 网络服务可用性监控
• 多协议服务健康检查
• 分布式系统的服务状态验证
• 网络设备和应用的定期测试
• 故障告警和恢复通知

安装与部署

本地安装

bash
git clone https://github.com/cmaster11/overseer
cd overseer
go install

Kubernetes部署

示例部署文件位于example-kubernetes目录下，详细说明请参考该目录下的README.md。

依赖要求

Overseer需要Redis服务器，用于：

• 解析后的作业存储队列
• 测试结果存储队列

使用方法

测试执行流程

测试执行分为两步：

1. 将测试解析并插入Redis队列
2. 从队列中拉取并执行测试

1. 将测试入队

bash
overseer enqueue \
  -redis-host=queue.example.com:6379 [-redis-pass='secret.here'] \
  test.file.1 test.file.2 .. test.file.N

2. 启动工作节点执行测试

bash
overseer worker -verbose \
  -redis-host=queue.example.com:6379 [-redis-pass='secret']

并行执行测试

通过启动多个worker实例实现并行测试，可在同一主机或不同主机上运行。

自动运行配置

systemd目录下提供了示例服务文件：

• 启动单个worker的服务（假设Redis运行在本地）
• 定期填充测试队列的服务和定时器

平滑测试失败

为避免因临时网络/主机故障导致的误报，失败的测试会自动重试。可通过命令行标志禁用重试：

bash
overseer worker -retry=false

通知系统

结果存储

每个测试结果以JSON对象形式发布到overseer.results集合，通知程序应从中读取结果并生成告警，以防止集合无限增长。

结果JSON格式

示例桥接器

仓库中包含示例"桥接器"，用于从Redis拉取结果并转发到其他系统：

• webhook-bridge：转发结果到通用URL（如Notify17）
• email-bridge：通过邮件发送测试失败通知
• purppura-bridge：转发结果到purppura主机

告警去重

通过with dedup 5m规则或启动worker时使用-dedup=5m标志启用告警去重：

• 错误告警：基于输入规则计算唯一哈希，若在指定时间内已触发则不重复告警
• 恢复通知：测试成功后，生成recovered=true的告警

指标收集

Overseer支持将指标导出到远程碳服务器，包括：

• 系统自身指标（通过go-metrics包）
• 测试执行指标（测试时间、DNS查询时间、重试次数等）

启用方法：启动worker前设置环境变量：

bash
export METRICS=metrics-host.example.com

Redis使用细节

队列实现

Redis通过列表原语模拟队列：

• 入队：使用rpush命令
• 出队：使用blpop命令

主要队列

• overseer.jobs：存储待执行的测试作业
• overseer.results：存储测试结果

队列状态检查

bash
# 查看待执行作业数
redis-cli llen overseer.jobs

# 查看待通知结果数
redis-cli llen overseer.results

# 查看具体队列内容
redis-cli lrange overseer.jobs 0 -1
redis-cli lrange overseer.results 0 -1