3efa0ee423
Aenderungen an Codeberg-Issues landeten bisher erst beim naechsten Lauf des sync-Services auf dem Board (MONITOR_SYNC_INTERVAL, Default 600s). Neu meldet Codeberg jede Aenderung aktiv per Webhook, der Weg aufs Board dauert damit wenige Sekunden (Webhook -> Sync -> SSE-Push ans Frontend). POST /api/v1/webhooks/codeberg wertet den Payload bewusst nicht aus, sondern fordert nur einen regulaeren Sync an - CodebergSyncService bleibt die einzige Stelle, die Issues auf Tickets abbildet, und ein verpasster Webhook ist folgenlos, weil der periodische Lauf denselben Stand ohnehin nachholt. Der Sync passiert nicht im Request: Forgejo bricht die Zustellung nach wenigen Sekunden ab (DELIVER_TIMEOUT, Default 5s), ein Sync macht aber mehrere Requests nach codeberg.org. Der Endpunkt setzt daher nur eine Trigger-Datei im gemeinsamen ./api-Volume (Sync\SyncTrigger) und antwortet sofort mit 202; der sync-Service laeuft jetzt im Watch-Modus und greift sie im Sekundentakt auf. Authentifiziert wird per HMAC-SHA256 ueber den rohen Request-Body (X-Forgejo-Signature bzw. X-Gitea-Signature) - Codeberg kennt unsere API-Keys nicht. Ohne gesetztes CODEBERG_WEBHOOK_SECRET weist der Endpunkt grundsaetzlich mit 401 ab, damit ein vergessenes Secret keinen offenen Sync-Ausloeser im Internet hinterlaesst. Request traegt dafuer neu den unveraenderten rawBody. Anders als der sync-Service braucht der api-Service damit eine eingehende Freigabe in Proxy und Firewall (POST /api/v1/webhooks/codeberg). Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
74 lines
3.9 KiB
Markdown
74 lines
3.9 KiB
Markdown
# 🖥️ monitor
|
|
|
|
**monitor** überwacht mehrere Systeme (per Ping und/oder per REST-API-Meldungen entfernter
|
|
Agenten) und zeigt den Zustand als interaktive **Büro-Visualisierung** (Kanban-Board +
|
|
Monitor-Wand mit Agenten an Schreibtischen).
|
|
|
|
Der vollständige Umbauplan steht in [Visualization.md](Visualization.md) (Roadmap Phase 0-7),
|
|
die dazugehörigen Klärungen in [Detailfragen.md](Detailfragen.md) und
|
|
[Detailantworten.md](Detailantworten.md).
|
|
|
|
---
|
|
|
|
## 🚀 Features
|
|
|
|
- REST-API (`api/`, siehe [API.md](API.md)) für Tickets, Events, Systeme, KPIs und
|
|
Agenten-Aktivität, mit statischen API-Keys pro Agent
|
|
- Büro-Visualisierung (`html/office.html`) als Vanilla-SVG-Szene: Kanban-Board, Monitor-Wand
|
|
(Events/Systeme/KPIs), 8 Schreibtische - zeigt live die Daten aus der REST-API (Push per
|
|
Server-Sent Events, Polling-Fallback), Klick auf Board/Monitore öffnet Detail-Modals,
|
|
Agenten laufen animiert zwischen Schreibtisch/Board/Monitor-Wand/Kaffee-Ecke (Phase 3-5,
|
|
siehe Visualization.md Abschnitt 9). Ist die API nicht erreichbar, zeigt die Szene
|
|
ersatzweise Demo-Daten — kenntlich gemacht durch einen roten Banner „API nicht erreichbar!".
|
|
Die Basis-URL der API kommt aus `MONITOR_API_BASE` (siehe `.env.example`).
|
|
- Codeberg-Sync als Dauerläufer (Compose-Service `sync`): füllt Backlog und Done automatisch
|
|
aus den Issues des konfigurierten Codeberg-Repos — periodisch alle `MONITOR_SYNC_INTERVAL`
|
|
Sekunden und, wenn ein Webhook eingerichtet ist, innerhalb von Sekunden nach jeder
|
|
Issue-Änderung (`POST /api/v1/webhooks/codeberg`, HMAC-signiert per
|
|
`CODEBERG_WEBHOOK_SECRET`). Siehe [API.md](API.md) Abschnitt „Codeberg-Sync" —
|
|
dort steht auch die Einrichtung im Codeberg-Repo.
|
|
- Weiterhin: klassische Ping-Überwachung (`check_fds.sh`, `hosts.conf`, `mail_fds.py`) als
|
|
eine Datenquelle für den System-Monitor; die alte tabellarische Statusseite ist mit
|
|
Phase 7 entfallen (F16), `status.txt` speist weiterhin den System-Monitor
|
|
|
|
---
|
|
|
|
## 📁 Projektstruktur
|
|
|
|
- `api/` — REST-API (PHP, SQLite), siehe [api/README.md](api/README.md)
|
|
- `html/` — Frontend: `office.html` (Büro-Visualisierung), `js/`, `css/`
|
|
- `tests/frontend/` — Node-Tests für die Frontend-Layoutlogik (`node --test`)
|
|
- `check_fds.sh`, `mail_fds.py`, `hosts-sample.conf` — bestehende Ping-Überwachung
|
|
- `docker-compose.yml` — komplette Entwicklungsumgebung (siehe unten)
|
|
- `update.sh` — holt die neueste Version vom konfigurierten Git-Remote und aktualisiert die
|
|
Docker-Compose-Umgebung (Abhängigkeiten, Images, Dienste, Tests)
|
|
- `register-agent.sh` — Hilfsskript, um einen neuen Agenten per `POST /api/v1/agents` zu
|
|
registrieren (siehe [API.md](API.md) Abschnitt "Agenten")
|
|
|
|
---
|
|
|
|
## 🐳 Entwicklung (nur Docker, kein lokales PHP/Node nötig)
|
|
|
|
Analog zum NC-Gantt-Projekt läuft die gesamte Ausführung (Bauen, Entwickeln, Testen) in
|
|
Docker-Compose-Containern; auf dem Host muss nichts installiert werden.
|
|
|
|
```bash
|
|
cp .env.example .env # einmalig, MONITOR_ADMIN_API_KEY anpassen
|
|
|
|
docker compose up --build # API auf :8091, Buero-Visualisierung auf :8090, Sync
|
|
docker compose run --rm api composer test # PHPUnit (API)
|
|
docker compose run --rm frontend # Node-Tests (Frontend-Layoutlogik)
|
|
docker compose logs -f sync # Codeberg-Sync mitlesen
|
|
```
|
|
|
|
Der Browser erreicht die API nicht über das Compose-Netzwerk, sondern über die in
|
|
`MONITOR_API_BASE` (`.env`) hinterlegte URL — der Default `http://localhost:8091/api/v1` passt
|
|
zum Port-Mapping oben. **Wer die Ports in `docker-compose.yml` ändert oder das System hinter
|
|
einem Reverse Proxy betreibt, muss `MONITOR_API_BASE` entsprechend nachziehen**, sonst zeigt
|
|
die Szene den Banner „API nicht erreichbar!" und fällt auf Demo-Daten zurück. Der Webserver
|
|
liefert den Wert zur Laufzeit als `/config.js` aus (`docker/nginx/default.conf.template`), ein
|
|
Build-Schritt ist dafür nicht nötig.
|
|
|
|
Details zur API: [api/README.md](api/README.md). Details zu den Endpunkten: [API.md](API.md).
|
|
|
|
|