|
|
@@ -1,12 +1,12 @@
|
|
|
# Über nodes2grafana
|
|
|
|
|
|
-nodes2grafana umfasst einen Konverter (namens `nodes2prom`), der die Statusdaten von FF-Routern aus der `nodes.json` in das [Prometheus Textformat](http://prometheus.io/docs/instrumenting/exposition_formats/) umwandelt, sowie dazu passende Grafana-Dashboards zur Visualisierung.
|
|
|
+nodes2grafana umfasst zwei Konverter (namens `nodes2prom` und `graph2prom`), welche die Statusdaten von FF-Routern aus `nodes.json` bzw. `graph.json` in das [Prometheus Textformat](http://prometheus.io/docs/instrumenting/exposition_formats/) umwandeln, sowie dazu passende Grafana-Dashboards zur Visualisierung.
|
|
|
|
|
|
Damit aus den konvertierten Statusdaten bunte Bildchen werden, die alle FreifunkerInnen begeistern, braucht es zusätzlich die daemons node_exporter, prometheus und grafana-server. Hinweise dazu finden sich weiter unten.
|
|
|
|
|
|
-nodes2grafana läuft zZ in Dortmund im Probebetrieb, s. die Dashboards [FF-DO-status](http://vm23.free.de:3000/dashboard/file/FF-DO-status.json) und [FF-DO-status-group](http://vm23.free.de:3000/dashboard/file/FF-DO-status-group.json). Sowie die Wiki-Seite zum FF-DO-[Status](http://url.free.de/ffdo/Technik/Netzinfrastruktur/Status).
|
|
|
+nodes2grafana läuft zZ in Dortmund im Probebetrieb, s. die Dashboards [FF-DO-status](http://vm23.free.de:3000/dashboard/file/FF-DO-status.json), [FF-DO-status-group](http://vm23.free.de:3000/dashboard/file/FF-DO-status-group.json) und [FF-DO-status-mesh](http://vm23.free.de:3000/dashboard/file/FF-DO-status-mesh.json). Sowie die Wiki-Seite zum FF-DO-[Status](http://url.free.de/ffdo/Technik/Netzinfrastruktur/Status).
|
|
|
|
|
|
-nodes2grafana ist aber nicht spezifisch für die Dorfmunder FF-Community, sondern kann durch Editieren einer Konfigurationsdatei (s.u.) von anderen Communities umge*brand*et werden:-) Zumindest, wenn die dortige `nodes.json` die gleiche Struktur hat wie in Dortmund. Ansonsten müsste der Konverter (`src/nodes2prom.sml`) angepasst werden, d.h. z.Z.: umprogrammiert.
|
|
|
+nodes2grafana ist aber nicht spezifisch für die Dorfmunder FF-Community, sondern kann durch Editieren einer Konfigurationsdatei (s.u.) von anderen Communities umge*brand*et werden:-) Zumindest, wenn die dortigen `nodes.json` und `graph.json` die gleiche Struktur haben wie in Dortmund. Ansonsten müssten die Konverter (`src/nodes2prom.sml` und `src/graph2prom.sml`) angepasst werden, d.h. z.Z.: umprogrammiert.
|
|
|
|
|
|
# Installation
|
|
|
|
|
|
@@ -22,7 +22,7 @@ Benötigt wird außer FreeBSD oder GNU/Linux sowie den dort üblichen verdächti
|
|
|
|
|
|
- Das `smlnj` package sollte vollständig sein, d.h. muss auch `ml-build` enthalten.
|
|
|
- Wenn `heap2exec` vorhanden ist (wie beim FreeBSD port lang/smlnj), dann wird es zur Erstellung der executables genutzt. Ansonsten wird ein Hilfsscript installiert, das einen heap mittels der SML/NJ runtime ausführt.
|
|
|
-- Für auf Debian basierende Distributionen benötigt man außer dem `smlnj` package auch das `ml-lpt` package.
|
|
|
+- Auf Debian basierende Distributionen benötigen außer dem `smlnj` package auch das `ml-lpt` package.
|
|
|
|
|
|
## Konfiguration
|
|
|
|
|
|
@@ -93,9 +93,11 @@ Außerdem wird die utility `json-pp` (JSON pretty printer) nach *BIN_DIR* instal
|
|
|
|
|
|
# Betrieb
|
|
|
|
|
|
+Wie die Daemons genau gestartet werden, hängt vom verwendeten Betriebssystem ab. Bei FreeBSD s. /etc/rc.conf, bei Debian et al. s. systemd.
|
|
|
+
|
|
|
## nodes2prom
|
|
|
|
|
|
-Das script `nodes2prometheus.sh` besorgt die aktuelle `nodes.json` von der angegebenen *NODES_URL* und konvertiert sie mit `nodes2prom` zu einer .prom-Datei nach *EXPORT_DIR*. `nodes2prometheus.sh` sollte also im Betrieb periodisch ausgeführt werden. S. `etc/crontab` und `/etc/crontab` bzw. die entsprechende cron-Mechanik des verwendeten Betriebssystems.
|
|
|
+Das script `nodes2prometheus.sh` besorgt die aktuellen `nodes.json` und `graph.json` von der angegebenen *NODES_URL* bzw. *GRAPH_URL* und konvertiert sie mit `nodes2prom` bzw. `graph2prom` zu einer .prom-Datei nach *EXPORT_DIR*. `nodes2prometheus.sh` sollte also im Betrieb periodisch ausgeführt werden. S. `etc/crontab` und `/etc/crontab` bzw. die entsprechende cron-Mechanik des verwendeten Betriebssystems.
|
|
|
|
|
|
## node_exporter
|
|
|
|
|
|
@@ -134,6 +136,8 @@ Für unsere Zwecke benötigen wir in der `grafana.conf` folgenden Konfigurations
|
|
|
|
|
|
Dadurch werden die von nodes2grafana nach *DASHBOARD_DIR* installierten Dashboards freigeschaltet. Dabei muss der `path` in der grafana.conf natürlich mit dem Wert von *DASHBOARD_DIR* in unserer `conf/substitutions.conf` übereinstimmen.
|
|
|
|
|
|
+Damit auch Tortengrafiken in den Dashboards funktionieren, benötigt man das [Pie-Chart-Panel Plugin](https://grafana.com/plugins/grafana-piechart-panel), s. [Installationsanleitung](https://grafana.com/plugins/grafana-piechart-panel/installation).
|
|
|
+
|
|
|
Startparameter zB:
|
|
|
|
|
|
grafana-server -config=/usr/local/etc/grafana.conf -homepath=/usr/local/share/grafana/
|
|
|
@@ -143,7 +147,6 @@ Nun ist Grafana über <http://localhost:3000/> erreichbar, und man kann darüber
|
|
|
# TODO
|
|
|
|
|
|
- Auch für GNU/Linux gängig machen: heap2exec. (Problem: 32bit runtime und ld auf 64bit Maschine)
|
|
|
-- `graph.json` -> grafana
|
|
|
- Bei Bedarf: Aus einer textuellen Spezifikation der Struktur der `nodes.json` den passenden Konverter generieren. (Sportlich, aber wenn man eh' schon mit [SML](http://www.smlnj.org/sml.html) unterwegs ist ... :)
|
|
|
- Doku:-)
|
|
|
|
