Watcher-Agent hinzugefügt

2025-10-04 00:12:53 +02:00
parent 7fbc7d48e0
commit 35079ba996

61
Watcher-Agent.-.md Normal file

@@ -0,0 +1,61 @@
#Schnittstellen
## Server Registrierung
Endpoint: /monitoring/register
Beim Start des Agent, überprüft dieser, ob er bereits eine ID vom Watcher-Server zugewiesen bekommen hat.
## Hardware Info
Endpoint: /monitoring/hardware-info
Ist der Agent erfolgreich registriert, schickt er einmalig beim starten seine Hardwareinformationen an den Server.
Übergebene Werte:
| eingehender Wert | | Einheit |
| --- | --- | --- |
| CpuType| Typ-Bezeichnung des eingebauten CPU |
| CpuCores | Anzahl an CPU-Kernen |
| GpuType| Typ-Bezeichnung der eingebauten Grafikkarte |
| RamSize | Größe des verfügbaren Arbeitsspeichers |
## Server Metrics
Endpoint: /monitoring/metric
Im Serverweiten Tick-Rythmus von 30 Sekunden schickt der Agent einen Metric-Payload an den Server. Dieser Payload beinhaltet die folgenden Werte:
| Metric | eingehender Wert | umgerechneter Wert |
| --- | --- | --- |
| CPU_LOAD | prozentual | keine Umrechnung|
| CPU_TEMP | °C | keine Umrechnung |
| RAM_LOAD | prozentual | keine Umrechnung |
| RAM_SIZE | Byte | GigaByte |
| GPU_LOAD | prozentual | keine Umrechnung |
| GPU_TEMP | °C | keine Umrechnung|
| GPU_VRAM_LOAD | prozentual | keine Umrechnung |
| GPU_VRAM_SIZE | Bytes | GigaByte |
| NET_RX | Bytes/s | Megabit/s |
| NET_TX | Bytes/s | Megabit/s |
| DISK_USAGE | Bytes | Gigabyte |
| DISK_SIZE | Bytes | Gigabyte |
| DISK_TEMP | °C | keine Umrechnung |
## Service Discovery
Beim Start schickt der Agent eine Liste aller auf seinem Host laufenden Container:
| Attribut | Beschreibung | Docker Variable |
| --- | --- | --- |
| ServerId | ID des Hosts auf dem der Container läuft | # |
| ContainerId | ID des Containers auf dem Host | ? |
| Image | Image, das der Container verwendet | image |
| Name | Name den der Container auf dem Host hat| container_name |
Diese Daten werden einmalig gesendet und können über einen manuellen refresh aktualisert werden (kommt irgendwann).
## Service Metrics
tbd