Add script 'traffic-peak-monitor.sh'.

conf/traffic-peak-monitor-IFACE.conf.sample

@@ -0,0 +1,107 @@
+# ============================================================================
+# traffic-peak-monitor-IFACE.conf.sample
+# ============================================================================
+#
+# Beispiel-/Vorlagen-Konfiguration fuer traffic-peak-monitor.sh
+#
+# VERWENDUNG:
+#   1. Diese Datei kopieren und "IFACE" im Dateinamen durch den echten
+#      Namen des zu ueberwachenden Netzwerk-Interfaces ersetzen.
+#      Der Dateiname MUSS folgendem Schema entsprechen:
+#
+#         traffic-peak-monitor-<interface>.conf
+#
+#      Beispiele:
+#        cp traffic-peak-monitor-IFACE.conf.sample traffic-peak-monitor-lan4.conf
+#        cp traffic-peak-monitor-IFACE.conf.sample traffic-peak-monitor-lan4.11.conf
+#
+#   2. Werte unten an die tatsaechlichen Gegebenheiten anpassen.
+#
+#   3. Die Endung ".sample" ist wichtig: Dateien mit dieser Endung werden
+#      vom Launcher-Modus des Scripts NICHT eingelesen (nur echte
+#      *.conf Dateien werden gesucht) - diese Datei hier kann also
+#      gefahrlos als Vorlage im conf/-Verzeichnis liegen bleiben, ohne
+#      selbst einen Monitoring-Prozess auszuloesen.
+#
+# HINWEIS:
+#   Diese Datei wird von "traffic-peak-monitor.sh" per "source" eingelesen,
+#   d.h. es ist technisch gesehen ein kleines Bash-Script. Nur einfache
+#   Variablenzuweisungen verwenden (VARIABLE=wert), keine Leerzeichen um
+#   das "=", keine Shell-Kommandos einfuegen.
+#
+# ============================================================================
+
+
+# ----------------------------------------------------------------------
+# INTERVAL - Messintervall in Sekunden
+# ----------------------------------------------------------------------
+# Legt fest, wie oft der Byte-Zaehler des Interfaces ausgelesen wird, um
+# daraus die aktuelle Uebertragungsrate zu berechnen.
+#
+# Je KLEINER der Wert, desto GENAUER werden kurze Lastspitzen erfasst -
+# ein Peak, der nur 1-2 Sekunden dauert, wird bei INTERVAL=10 evtl. gar
+# nicht oder nur stark abgeschwaecht sichtbar, weil er "weggemittelt" wird.
+#
+# Je KLEINER der Wert, desto MEHR (minimale) Last erzeugt die Messung
+# selbst, da haeufiger Dateien gelesen und Berechnungen durchgefuehrt
+# werden. Fuer ein einzelnes Interface ist das i.d.R. vernachlaessigbar.
+#
+# Empfehlung:
+#   2   = guter Kompromiss aus Genauigkeit und Overhead (Standard)
+#   1   = sehr genau, minimal mehr Last
+#   5-10 = grober, reicht z.B. bei eher traegen/gleichmaessigen Leitungen
+#
+# Default im Script, falls hier nicht gesetzt: 2
+INTERVAL=2
+
+
+# ----------------------------------------------------------------------
+# LINE_SPEED_IN_MBIT - Download-Kapazitaet der Leitung in Mbit/s
+# ----------------------------------------------------------------------
+# Die maximale EINGEHENDE (rx) Bandbreite der Leitung, an der dieses
+# Interface haengt - also das, was z.B. im Vertrag mit dem Provider als
+# "Download-Geschwindigkeit" angegeben ist.
+#
+# Wird verwendet, um die gemessenen rx-Spitzenwerte als Prozentwert der
+# verfuegbaren Kapazitaet auszugeben (z.B. "45.2%" bedeutet: die Spitze
+# hat 45,2 % der theoretisch moeglichen Download-Rate ausgenutzt).
+#
+# WICHTIG: Angabe in Mbit/s (Megabit), NICHT MByte/s (Megabyte).
+# Netzwerk-Bandbreiten werden ueblicherweise in Bit/s angegeben - genau
+# wie es auch im Vertrag beim Provider steht (z.B. "100 Mbit/s Download").
+#
+# Beispiel-Werte gaengiger Anschluesse:
+#   DSL 50/10   -> LINE_SPEED_IN_MBIT=50
+#   DSL 100/40  -> LINE_SPEED_IN_MBIT=100
+#   Kabel 500/50 -> LINE_SPEED_IN_MBIT=500
+#   Glasfaser 1000/500 -> LINE_SPEED_IN_MBIT=1000
+#
+# Default im Script, falls hier nicht gesetzt: 100
+LINE_SPEED_IN_MBIT=100
+
+
+# ----------------------------------------------------------------------
+# LINE_SPEED_OUT_MBIT - Upload-Kapazitaet der Leitung in Mbit/s
+# ----------------------------------------------------------------------
+# Die maximale AUSGEHENDE (tx) Bandbreite der Leitung - also die
+# "Upload-Geschwindigkeit" laut Vertrag.
+#
+# Viele Anschluesse sind ASYMMETRISCH, d.h. Download- und Upload-Rate
+# unterscheiden sich deutlich (z.B. DSL 100/40 = 100 Mbit/s Download,
+# aber nur 40 Mbit/s Upload). Deshalb wird dieser Wert getrennt von
+# LINE_SPEED_IN_MBIT angegeben - eine gemeinsame Prozentrechnung ueber
+# einen einzigen Wert wuerde bei asymmetrischen Anschluessen falsche
+# bzw. irrefuehrende Prozentzahlen liefern.
+#
+# Beispiel-Werte gaengiger Anschluesse (Fortsetzung von oben):
+#   DSL 50/10   -> LINE_SPEED_OUT_MBIT=10
+#   DSL 100/40  -> LINE_SPEED_OUT_MBIT=40
+#   Kabel 500/50 -> LINE_SPEED_OUT_MBIT=50
+#   Glasfaser 1000/500 -> LINE_SPEED_OUT_MBIT=500
+#
+# Bei SYMMETRISCHEN Anschluessen (z.B. manche Glasfaser-Vertraege mit
+# z.B. 1000/1000) einfach den gleichen Wert wie bei LINE_SPEED_IN_MBIT
+# eintragen.
+#
+# Default im Script, falls hier nicht gesetzt: 100
+LINE_SPEED_OUT_MBIT=100