Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

--- technik:software:ffsnodealarm [14.09.2019 - 17:43] – nrb
+++ technik:software:ffsnodealarm [15.02.2023 - 17:52] (aktuell) – Flip
@@ Zeile 1: / Zeile 1: @@
 ====== FfsNodeAlarm ======
-FfsNodeAlarm prüft ob Freifunk Stuttgart Nodes online ist. Für jeden zu überwachenden Node muss in FfsNodeAlarm ein Task angelegt werden welcher dann in einem bestimmten Intervall ausgeführt wird.
+Der [[https://nodealarm.freifunk-stuttgart.de|NodeAlarm]] ist ein Tool welches kontinuierlich überprüft ob Freifunk Stuttgart Nodes (auch allgemeinsprachlich Router genannt) online sind und alarmiert über E-Mail, sollte der Router offline bzw wieder online gehen.
-Sollte ein entsprechender Node offline sein wird der Benutzer via E-Mail informiert.
+\\
+\\
+Für die Nutzung muss ein Account mit einer gültigen E-Mail Adresse [[https://nodealarm.freifunk-stuttgart.de/sign-up|angelegt]] werden. An diese E-Mails werden dann auch die entsprechend eingestellten Alarme gesendet.
-Der NodeAlarm greift auf die Datenbasis von http://netinfo.freifunk-stuttgart.de/json/nodes.json zurück die jede 5 Minuten abgeglichen wird. Als Intervall macht es also keinen Sinn diesen für unter 10 Minuten zu definieren.
+Nach der Registrierung oder Login kann im Menü über //Monitoring tasks// die Tasks angezeigt werden:
+{{:technik:software:nodealarm-tasks.png?200|}}
+\\
+\\
+Ein Task besteht aus einem Node und einem Intervall. Der Nodealarm prüft dann in dem definierten Intervall den Status des jeweiligen Nodes. Ein Intervall sollte mindestens 10 Minuten betragen, da die Informationen der Nodes jede 5 Minuten aggregiert werden.
-https://nodealarm.freifunk-stuttgart.de/
+{{:technik:software:nodealarm-createtask.png?1000|}}
+\\
+\\
+===== Technischer Hintergrund =====
+Der NodeAlarm greift auf die Datenbasis von http://netinfo.freifunk-stuttgart.de/json/nodes.json zurück und gleicht diese jede 5 Minuten ab.
+Mit dieser Abtastrate macht es somit keinen Sinn, ein Task mit einem Intervall unter 10 Minuten zu definieren.
+URL: https://nodealarm.freifunk-stuttgart.de
 Code: https://github.com/Philhil/FfsNodeAlarm
+Server: [[technik:proxmox|VM on ffs11]]
+\\
+\\
+**API**
+Der Nodealarm besitzt eine mini API. Hierüber lässt sich der Status auf Smartwatches, Hausautomatisierung etc. anzeigen.
+Die API ist über die URL [[https://nodealarm.freifunk-stuttgart.de/api/]] erreichbar und ist über HTTP Get nutzbar. Das Output-Format ist immer JSON.
+Folgende routen sind über ein HTTP GET nutzbar:
+  * //{mac}// Alle Informationen des Nodes.
+  * //{mac}/clientcount// Anzahl der Clients/Nutzer des jeweiligen Nodes.
+  * //{mac}/isonline// Online Status des Nodes.