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