abali/janitor

Janitor

概述

Janitor是一款独立工具，专注于监控物联网设备的可用性，在设备失联或停止传输数据时发出告警。它特别适用于拥有多个传感器（可能硬件或连接不稳定）的场景，帮助用户及时发现设备问题并监控设备稳定性。Janitor不旨在替代家庭自动化软件（如HASS），而是专注于监控告警功能，以保持简单高效。

核心功能

监控方法

• MQTT：订阅预定义MQTT主题并监控消息。系统会为每个通道计算平均传输频率，若在配置时间内未收到新消息（阈值可设为平均频率的倍数或绝对数值）则触发告警。适用于通过MQTT定期提交数据的传感器（如温度传感器）。

• Ping：以预定义频率（可按主机配置）ping指定主机，若连续未收到回复超过配置阈值则告警。适用于各类物联网设备（如传感器、摄像头）。

• HTTP：向指定地址发送HTTP GET请求，检查回复及可选的特定字符串。连续请求失败超过配置阈值则告警，频率和超时可按地址单独配置。适用于具有Web界面的服务（如API、托管服务）。

• Exec：执行预配置命令并检查退出码，连续执行失败超过配置阈值则告警，频率和超时可自定义。适用于需自定义监控逻辑的场景。

告警方法

• *****：向预定义*频道发送告警消息。

• Gotify：向Gotify服务器发送推送消息。

• MQTT：向指定MQTT服务器的主题发布JSON格式告警消息，适用于自动化场景（如HASS集成）。

• Exec：执行预配置命令，支持自定义告警逻辑扩展。

Web界面与API

提供Web界面，可查看设备状态、历史数据、删除监控目标、调整超时/间隔/阈值参数及重新加载配置文件。同时包含JSON API端点：

• /api/data：返回所有监控数据快照
• /api/stats：返回监控目标正常/异常状态的数量统计

使用场景

适用于以下场景：

• 管理多个传感器（如温度、湿度传感器）的物联网网络
• 监控网络设备（摄像头、网关）的在线状态
• 确保API服务、Web界面等服务的可用性
• 自定义脚本或命令的执行状态监控

使用方法

配置文件

Janitor使用YAML格式配置文件，包含监控目标和告警方式的设置。多数参数为可选，具有默认值。

最小配置示例（Web界面默认端口8080）：

yaml
monitor:
  mqtt:
    server: mymqtt.server
    targets:
      - topic: "/sensors/#"
alert:
  gotify:
    server: "http://mygotify.server:1234"
    token: gotify_token

运行命令

创建配置文件后，通过以下命令启动：

bash
janitor path/to/your/configfile.yml

日志输出到标准输出，同时可在Web界面查看。Janitor不会后台运行，建议创建systemd服务以实现持续运行。

Docker部署

使用Docker Hub镜像

最新版本镜像为abali/janitor，需将本地配置文件映射到容器内/janitor/config.yml：

bash
docker run -v $(pwd)/config.yml:/janitor/config.yml -p 8080:8080 abali/janitor

手动构建镜像

bash
git clone https://github.com/a-bali/janitor.git
cd janitor
docker build . -t janitor
docker run -v $(pwd)/config.yml:/janitor/config.yml -p 8080:8080 janitor

注意事项

• 配置文件修改后，可通过Web界面重新加载，无需重启服务。
• 支持通过Web界面查看日志、删除监控目标及调整参数。
• 可通过Exec监控/告警方法扩展自定义逻辑。