|
|
@@ -1,17 +1,38 @@
|
|
|
# nodes2grafana
|
|
|
|
|
|
+## Über diese Software
|
|
|
+
|
|
|
nodes2grafana ist ein Konverter für `nodes.json` -> prometheus Textformat. Mit dem erforderlichen Drumrum, incl. grafana Dashboards.
|
|
|
|
|
|
-Benötigt wird außer den üblichen verdächtigen Un*x-utilities nur [SML/NJ](http://www.smlnj.org/).
|
|
|
+### Herunterladen
|
|
|
+
|
|
|
+Den Inhalt dieses repository's kann man sich hier als tarball herunterladen: <https://git.ffdo.de/altlast/nodes2grafana/archive/master.tar.gz>.
|
|
|
+
|
|
|
+Nach erfolgreichem `make` (s.u.) findet sich der tarball in `dist/nodes2grafana.txz`. Hat man lokale Modifikationen an der Software vorgenommen, so sind sie im tarball enthalten, sofern man `dist/Makefile.in` ggf. angepasst hat.
|
|
|
+
|
|
|
+## Installation
|
|
|
+
|
|
|
+### Benötigte Software
|
|
|
+
|
|
|
+Benötigt wird außer den üblichen verdächtigen Un*x-utilities nur [SML/NJ](http://www.smlnj.org/). Das smlnj package sollte vollständig sein, d.h. auch `ml-build` und `heap2exec` enthalten. Dies ist beim FreeBSD port lang/smlnj der Fall.
|
|
|
+
|
|
|
+### Konfiguration
|
|
|
|
|
|
Zwecks Konfigurationsanpassung (Pfade, Metriknamen) die Datei `conf/substitutions.conf.default` nach `/etc/nodes2grafana.conf` kopieren und die zu ändernden Werte anpassen.
|
|
|
Zeilen, die gegenüber der substitutions.conf.default nicht geändert wurden, können auch weggelassen werden.
|
|
|
|
|
|
+Will man nicht gleich im /etc herumschreiben sondern erstmal ausprobieren, kann man `conf/substitutions.conf.local` verwenden.
|
|
|
+
|
|
|
Anschließend:
|
|
|
|
|
|
+### Bauen
|
|
|
+
|
|
|
cd conf && make && cd .. && make
|
|
|
# make install
|
|
|
- make clean
|
|
|
+ # make clean
|
|
|
+ # rm Makefile
|
|
|
+
|
|
|
+Nach einem erfolgreichen `make` befinden sich im Verzeichnis `test/tmp` die Ergebnisse des Testlaufs (cd test && make).
|
|
|
|
|
|
# TODO
|
|
|
|
