diff --git a/README.md b/README.md index 89b21ae..57cdffe 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,61 @@ -# zabbix-rustdesk-server +# RustDesk Server OSS Monitoring for Zabbix +Мониторинг [RustDesk Server OSS](https://rustdesk.com/) через **Zabbix Agent 2**. + +Проект предназначен для Docker-инсталляции RustDesk Server с контейнерами `hbbs` и `hbbr`. + +Мониторинг позволяет получать: + +- количество зарегистрированных RustDesk peers; +- IP зарегистрированных peers; +- автоматическое обнаружение peers через Zabbix LLD; +- количество активных TCP-соединений `hbbr`; +- количество активных relay-сессий; +- список IP активных relay-клиентов; +- JSON со сводной информацией. + +## Возможности + +| Метрика | Zabbix key | Тип | +|---|---|---| +| Registered peers | `rustdesk.peers` | Numeric | +| Peer IP | `rustdesk.peer.ip[ID]` | Text | +| Peer discovery | `rustdesk.discovery` | LLD | +| Relay connections | `rustdesk.relay.connections` | Numeric | +| Relay sessions | `rustdesk.relay.sessions` | Numeric | +| Active relay IPs | `rustdesk.relay.ips` | Text | +| Summary JSON | `rustdesk.json` | Text | + +## Архитектура + +```text + ┌──────────────────────┐ + │ Zabbix Server │ + └──────────┬───────────┘ + │ + │ Zabbix Agent 2 + ▼ + ┌──────────────────────┐ + │ Linux RustDesk │ + │ Server │ + └──────────┬───────────┘ + │ + ┌─────────────┴─────────────┐ + │ │ + ▼ ▼ + ┌──────────────┐ ┌──────────────┐ + │ hbbs │ │ hbbr │ + │ RustDesk ID │ │ Relay Server │ + └──────┬───────┘ └──────┬───────┘ + │ │ + ▼ ▼ + db_v2.sqlite3 TCP :21117 + │ │ + │ network namespace + │ │ + └──────────┬───────────────┘ + ▼ + rustdesk-monitor.sh + │ + ▼ + Zabbix UserParameter \ No newline at end of file