QUICKSTART.de.txt

   1 ==========
   2 00. Inhalt
   3 ==========
   4
   5 - 01. Auf dem zu überwachenden Rechner
   6 - 02. Auf dem Nagios
   7
   8
   9
  10
  11
  12 ====================================
  13 01. Auf dem zu überwachenden Rechner
  14 ====================================
  15
  16 -----------------------------------
  17 01.01. Erstellen einer "conf"-Datei
  18 -----------------------------------
  19
  20 Vorbemerkung:
  21 Zur Zeit wird ein INI-Datei ähnliches Format verwendet. Dies kann sich aber in
  22 Zukunft noch ändern!
  23
  24 Als Vorlage können die Dateien "sample-configs/conf/nagixsc_debian.conf"
  25 (Nagios mit Hilfe der Debian-Packages installiert) und
  26 "sample-configs/conf/nagixsc_usrlocal.conf" (selbst kompiliert nach
  27 /usr/local/nagios) dienen.
  28
  29 Je Rechner, der überwacht werden soll, wird ein Abschnitt in eckigen Klammern
  30 angelegt. Der Abschnittsname entspricht dabei dem Nagios-Hostname. Innerhalb
  31 des Abschnitts können nun die Service Descriptions und die auszuführenden
  32 Commands definiert werden.
  33
  34 Beginnt eine Option mit einem Unterstrich/Underscore/"_", so sind dies
  35 Nag(ix)SC-interne Definitionen und werden NICHT als Service angesehen. Bisher
  36 gibt es folgende Definitionen:
  37
  38 - "_host_name": Überschreibt den Abschnittsnamen mit dem angegebenen
  39                 Hostnamen.
  40
  41 Der Abschnitt "[nagixsc]" ist für zukünftige Erweiterungen reserviert!
  42
  43
  44 ----------------------------------------------------
  45 01.02. Ausführen der Checks, Erstellen der XML-Datei
  46 ----------------------------------------------------
  47
  48 Zum ersten Test lässt man sich das XML am Besten an der Konsole ausgeben:
  49
  50 % ./nagixsc_conf2xml.py -e plain -c sample-configs/conf/nagixsc.conf
  51
  52 Zur Lesbarkeit wird das Encoding ausgeschaltet ("-e plain"). Dies ist nicht
  53 für den Produktivbetrieb gedacht!
  54
  55 Man sollte hier bereits erkennen, wie Nag(ix)SC "intern tickt". Jetzt wäre der
  56 geeignete Zeitpunkt sich eine kleine, eigene Konfigurationsdatei zu schreiben.
  57 ;-)
  58
  59 Hat man diese (zur Not geht's natürlich auch mit den Beispielen weiter),
  60 erstellt man nun ein XML, welches zur Weiterverarbeitung geeignet ist:
  61
  62 % ./nagixsc_conf2xml.py -c sample-configs/conf/nagixsc.conf -o /tmp/nagixsc.xml
  63
  64 In der Praxis kann man diese XML-Datei auf einen Web-Server legen, damit sie
  65 direkt vom Nagios aus abrufbar ist.
  66
  67
  68 -----------------------------------------
  69 01.03. Kontrolle der erstellten XML-Datei
  70 -----------------------------------------
  71
  72 Mit Hilfe des Skripts "nagixsc_read_xml.py" kann man sich den Inhalt einer
  73 Nag(ix)SC-XML-Datei ansehen:
  74
  75 % ./nagixsc_read_xml.py -f /tmp/nagixsc.xml
  76
  77 Der Inhalt wird zuerst blockweise, dann als formatiertes Python Dict
  78 ausgegeben.
  79
  80
  81
  82
  83
  84 ==================
  85 02. Auf dem Nagios
  86 ==================
  87
  88 --------------------------------
  89 02.01. Verschiedene Übergabewege
  90 --------------------------------
  91
  92 Auf der Nagios-Seite gibt es im Moment 2 Wege an die Check-Ergebnisse
  93 heranzukommen: Entweder man sorgt manuell dafür, dass die XML-Datei irgendwo
  94 im Dateisystem lesbar ist ("-f"), oder man greift auf einen Web-Server zu
  95 ("-u"). Die Beispiele gehen von einer lokalen Datei aus.
  96
  97 Das Tool "nagixsc_xml2nagios.py" kennt 5 verschiedene Arbeitsweisen, angegeben
  98 durch den Schalter "-O":
  99
 100 - "passive": Schreibt die Ergebnisse als passive Service Checks in die Nagios
 101              Command Pipe. Es generiert keine Ausgaben und ist daher für einen
 102              Aufruf durch Cron geeignet.
 103
 104 - "passive_check": Schreibt ebenfalls passive Service Checks, die Rückgabe
 105                    erfolgt allerdings im Stil eines Nagios-Plugins (eine Zeile
 106                    Ausgabe, Exit-Code).
 107
 108 - "checkresult": Schreibt die Ergebnisse aus dem XML in das Nagios
 109                  "checkresults"-Verzeichnis. Ebenfalls für Cron geeignet.
 110
 111 - "checkresult_check": Siehe "checkresult", Verhalten wie ein Nagios-Plugin
 112                        (eine Zeile Ausgabe, Exit-Code)
 113
 114 - "active": Durchsucht ein XML nach einer Host/Service-Kombination und beendet
 115             sich wie ein Nagios-Plugin mit den gefundenen Daten.
 116
 117 Beispielaufrufe:
 118
 119 % ./nagixsc_xml2nagios.py -O passive -f /tmp/nagixsc.xml
 120 %
 121
 122 % ./nagixsc_xml2nagios.py -O passive_check -f /tmp/nagixsc.xml
 123 Nag(ix)SC OK - Check results are 25077576 seconds old
 124 %
 125
 126 % ./nagixsc_xml2nagios.py -O checkresult -f /tmp/nagixsc.xml
 127 %
 128
 129 % ./nagixsc_xml2nagios.py -O checkresult_check -f /tmp/nagixsc.xml
 130 Nag(ix)SC OK - Wrote checkresult files for 6 services
 131 %
 132
 133 % ./nagixsc_xml2nagios.py -O active -f /tmp/nagixsc.xml -D Disk_Root
 134 DISK OK - free space: / 2167 MB (22% inode=97%);| /=7353MB;8568;9044;0;9520
 135 %
 136
 137 Für einen selbstkompilierten Nagios und die Debian-Packages können die
 138 "nagios.cmd" und das "checkresults"-Verzeichnis automatische gefunden werden.
 139 Sollte dies nicht klappen, kann man sie mit "-p" (Pipe) bzw. "-r" (Resultdir)
 140 übergeben werden.
 141
 142 Will man "erstmal nur testen", so kann man "nagixsc_xm2nagios.py" mit "touch
 143 /tmp/nagixsc.cmd" und "-p /tmp/nagixsc.cmd" bzw. "mkdir /tmp/nagixsc.result"
 144 und "-r /tmp/nagixsc.result" aufrufen und die generierten External Commands
 145 bzw. Checkresult-Dateien ansehen.
 146
 147
 148 ----------------------
 149 02.02. Veraltete Daten
 150 ----------------------
 151
 152 "nagixsc_xml2nagios.py" geht davon aus, dass die Daten im XML nicht älter als
 153 vier Stunden (14400 Sekunden) sind. Sollten sie es dennoch sein, werden sie
 154 automatisch mit dem Text "Nag(ix)SC: Check result is XX(>1440) seconds old"
 155 gekennzeichnet. Dieses Verhalten kann mit zwei Optionen beeinflusst werden:
 156
 157 - "-s SEC" gibt an, nach wie vielen Sekunden Nag(ix)SC davon ausgegen soll,
 158            dass die Daten im XML veraltet sind und mit dem oben genannten
 159            Hinweis versehen werden sollen.
 160
 161 - "-m" sorgt dafür, dass nicht nur der Text ergänzt, sondern dass der Check im
 162        Nagios als UNKNOWN geführt wird.
 163
 164
 165 ------------------------
 166 02.03. Weitere Parameter
 167 ------------------------
 168
 169 - "-S": Teste die XML-Datei vor der Verarbeitung gegen die angegebene
 170         DTD-Datei. Eine DTD wird als "xml/nagixsc.dtd" mitgeliefert (ohne
 171         Gewähr ;-)
 172
 173 - "-H": Filtert die XML-Datei nach einem Hostnamen und gibt nur dessen Checks
 174         zurück. Kann mit allen Varianten kombiniert werden.
 175
 176 - "-D": Filtert die XML-Datei nach einer (Service) Description. In Kombination
 177         mit "-H" wird nach einer Host/Service-Kombination gesucht. Ist kein
 178         Host angegeben, wird der erste Host in der XML-Datei genommen.
 179