# Neues in PNP 0.6.x

Die Arbeit an der Version 0.6.x ist in vollem Gange.

Mit Version 0.6.x steigen wir von Subversion auf GIT um. Der Sourcecode ist bereits auf Sourceforge erhältlich.

http://pnp4nagios.git.sourceforge.net

Bisher umgesetzte Funktionen:

- Webfrontend basiert auf Kohana
- Webfrontend basiert auf jQuery Themes
- Javascript-Funktionen über jQuery Plugins
- process_perfdata.pl wird in der Lage sein, pro Datenreihe eine eigene RRD-Datenbank zu verwenden.
- Installer weiter verbessert. Angabe von Directory-Layouts über –with-layout
- RRDtool-Fehler werden als Bild dargestellt. Keine fehlenden Bilder mehr.
- PNP-Templates können keine internen Variablen mehr überschreiben.
- PNP-Templates der Version 0.4.x können weiter verwendet werden.
- PDF-Funktionen neu umgesetzt.
- Template default.php optimiert.
- Export aus den RRD-Datenbanken im XML,CSV und JSON Format über die RRDtool “xport” Funktion.
- Page-Funktionen neu umgesetzt.
- Fehlerseiten verweisen auf online FAQ-Artikel.
- Mouseover Popup im Nagios-Frontend über jQuery.clueTip Plugin
- Volle Unterstützung des rrdcached.

zurück zur Übersicht | Anforderungen

de:pnp-0.6:new-features

# Über PNP

## Anforderungen an Plugins

PNP benötigt zwingend gültige Performancedaten von Nagios-Plugins.

Was sind also diese Performancedaten?

Die Ausgabe eines Nagios Plugins darf bis Nagios 2.x maximal eine Zeile betragen. Diese Ausgabe wird, wenn das Plugin Performancedaten liefert, in zwei Teile zerlegt. Als Trennzeichen dient dabei das Pipe “|” Symbol.

Beispiel check_icmp :

     OK - 127.0.0.1: rta 2.687ms, lost 0% | rta=2.687ms;3000.000;5000.000;0; pl=0%;80;100;;

daraus ergibt sich der Output auf der linken Seite des Pipe-Symbols

     OK - 127.0.0.1: rta 2.687ms, lost 0%

und die Performancedaten

      rta=2.687ms;3000.000;5000.000;0; pl=0%;80;100;;

Wie man unschwer erkennt, sind die Performancedaten auf die maschinelle Verarbeitung ausgelegt. Das Format ist in den Developer Guidelines festgelegt (einen Auszug davon gibt es an dieser Stelle), es soll aber hier noch einmal kurz erläutert werden.

      rta=2.687ms;3000.000;5000.000;0;
       |    |  |    |         |     | |
       |----|--|----|---------|-----|-|----- * Label
            |--|----|---------|-----|-|----- * Aktueller Wert
               |----|---------|-----|-|----- Einheit ( UOM = UNIT of Measurement )
                    |---------|-----|-|----- Warning Schwellwert
                              |-----|-|----- Critical Schwellwert
                                    |-|----- Minimum Wert
                                      |----- Maximum Wert

Mit * gekennzeichnete Werte müssen vorhanden sein. Alle anderen Werte sind optional.

Mehrere Datenreihen werden durch Leerzeichen getrennt. Die eigentlichen Daten dürfen also keine Leerzeichen enthalten. Soll das Label Leerzeichen enthalten, so müssen diese in einfache Hochkomma eingeschlossen werden.

## Benötigte Software

- Perl >= 5.x ohne besondere Module
- RRDtool ab 1.x; besser 1.2, aber nicht zwingend.
  Achtung: wird RRDtool ohne Paket-Manager installiert, fehlen anschließend möglicherweise die dejavu-Fonts. Das äußert sich z.B. durch fehlende Schriften in den Grafiken
- PHP >= 5.1.6 für das Webfrontend basierend auf Kohana
- Nagios >= 2.x oder Icinga
- für Kohana muss außerdem das Modul “mod_rewrite” in der Web-Server-Konfiguration aktiviert sein. Einzelheiten sind in der Web-Server-Dokumentation der entsprechenden Distribution nachzulesen.

## Lizenz

PNP ist unter der GPL 2 lizensiert.

## Download

Die Entwicklung von PNP wird auf Sourceforge.Net organisiert. PNP ist dort unter dem Projektnamen “PNP4Nagios” registriert.

Die jeweils aktuelle (stabile) Version findet ihr im Downloadbereich.

Wer noch aktueller sein möchte, kann auch die jeweils letzte Entwickler-Version benutzen.

Mit der Version 0.6.x wurde von SVN auf GIT zum Verwalten des Sourcecodes gewechselt.

Die aktuelle Entwicklung ist jederzeit unter http://pnp4nagios.git.sourceforge.net/ einzusehen. Beim Klicken auf PNP Devel Version wird ein Archiv mit der letzten Version heruntergeladen.

## Support

VOR dem Stellen von Support-Anfragen sollte sichergestellt werden, dass die unter http://docs.pnp4nagios.org/de/pnp-0.6/verify genannten Punkte geprüft wurden.

Die Entwickler und Helfer sind im Nagios-Portal unter http://www.nagios-portal.org vertreten. Dort gibt es einen eigenen Bereich zum Thema PNP.
Bei Support-Anfragen bitte das Betriebssystem und die PNP-Version angeben. Außerdem ist es wichtig, ob PNP aus den Sourcen erstellt oder ein vorgefertigtes Paket verwendet wurde.

Erfolgreich gelöste Probleme bitte mit einem [solved] in der Betreffzeile des ersten Beitrags kennzeichnen. Auf diese Weise erleichtern wir anderen Benutzern das Finden von Lösungen zu einem Problem.

Weiterhin können die Mailinglisten auf Sourceforge verwendet werden. Dort ist es jedoch üblich, Fragen auf Englisch zu stellen.

pnp4nagios-users: Die Users-Liste für allgemeine Fragen zur Konfiguration.

pnp4nagios-devel: Die Devel-Liste für Anregungen und Fehler Reports.

pnp4nagios-checkins: Auf der Checkins-Liste werden Änderungen im SVN-Repository automatisch veröffentlicht.

## Datenhaltung

Die Performance-Daten werden mit Hilfe von RRDtool in sogenannten Round-Robin-Datenbanken gespeichert, die wie ein Ringpuffer funktionieren. Das bedeutet, dass nach einer gewissen Zeit die ältesten Daten “hinten” herausfallen und “vorne” durch neue ersetzt werden.

Verschiedene Zeitintervalle innerhalb der Datei sorgen für unterschiedliche Auflösungen. In der Standardeinstellung können die Daten für die letzten zwei Tage im Minutenabstand abgelegt werden, für zehn Tage im 5-Minutenabstand, für 90 Tage im 30-Minutenabstand und für 4 Jahre im 6-Stundenabstand. Die Vergrößerung des Intervalls bewirkt, dass auch die Daten über das jeweils größere Intervall hinweg gemittelt werden. Das führt automatisch dazu, dass Spitzen nicht mehr so deutlich zu sehen sind. Das ist kein Fehler von PNP, sondern eine Eigenheit von RRDtool. Dazu gibt es auch einen Artikel im Linux-Magazin.

Durch die Speicherung in diesem Format ändert sich die Dateigröße nach dem Anlegen nicht mehr. Pro Datenreihe werden ca. 400 KB benötigt.

Zurück zur Übersicht | PNP-Modi

de:pnp-0.6:about

# Die Kunst Daten zu sammeln

PNP unterstützt mehrere Arten, die Performance-Daten zu verarbeiten. Die einzelnen Modi unterscheiden sich durch ihre Komplexität und die zu erwartende Performance.

Das folgende Bild zeigt die Verbindungen zwischen Nagios, PNP und RRDtool

Nagios führt für jeden Host- und jeden Service, dessen Performance-Daten gesammelt werden sollen, einen Befehl aus. Abhängig vom gewählten Modus werden die Daten entweder direkt an ein Perl-Script übergeben oder in temporäre Dateien geschrieben und später verarbeitet. process_perfdata.pl legt die Datei in XML-Dateien ab und speichert sie mit Hilfe von RRDtool in RRD-Dateien.

Bevor Ihr euch auf einen Modus festlegt, lest euch alles durch und entscheidet selbst, welcher Weg für eure Installation der Beste ist.

# Die Modi im Vergleich

## Synchronous Mode

Der “Sync Mode” ist der einfachste und am leichtesten einzurichten. Nagios ruft für jeden Service (bzw. Host) zusätzlich das Perl-Script process_perfdata.pl auf, um die Daten zu verarbeiten.

Der sync-Mode funktioniert sehr gut bis ca. 1000 Services in einem Intervall von 5 Minuten. Dieser Modus belastet aber auch Nagios am meisten, daher ist es auch in kleinen Installationen ratsam, die weiteren Modi zu beachten.

## Bulk Mode

Im Bulk-Mode schreibt Nagios die benötigten Daten in eine temporäre Datei. Nach Ablauf einer definierten Zeit wird die Datei an einem Stück abgearbeitet und gelöscht.

Die Anzahl der Aufrufe von process_perfdata.pl reduziert sich um ein Vielfaches. Abhängig von der Zeit und den gesammelten Daten werden wesentlich weniger Systemaufrufe ausgeführt. Dafür läuft process_perfdata.pl länger.

Hinweis Bei diesem Modus sollte man die Laufzeit von process_perfdata.pl im Auge behalten. So lange, wie process_perfdata.pl zum Verarbeiten der Daten benötigt, so lange kann Nagios keine Checks ausführen.

Auszug aus var/perfdata.log:

    2007-10-18 12:05:01 [21138] 71 Lines processed
    2007-10-18 12:05:01 [21138] .../spool/service-perfdata-1192701894-PID-21138 deleted
    2007-10-18 12:05:01 [21138] PNP exiting (runtime 0.060969s) ...

71 Zeilen wurden in 0,06 Sekunden verarbeitet. Das ist das Datenvolumen bei ca. 2000 Services und der Verarbeitung im 10-Sekunden-Intervall. Wir haben Nagios also genau für 0.06 Sekunden blockiert.

## Bulk Mode mit NPCD

Dies ist aus Nagios-Sicht die sauberste Art der Verarbeitung. Nagios wird nicht blockiert.

Nagios benutzt wieder eine temporäre Datei, um die Daten zu speichern, und führt nach Ablauf der Zeit wieder ein Command aus. Jedoch wird die Datei nicht sofort von Process_perfdata.pl verarbeitet, sondern in ein spool-Verzeichnis verschoben. Da das Verschieben einer Datei im gleichen Filesystem so gut wie keine Zeit beansprucht, ist Nagios sofort wieder in der Lage, wichtige Arbeiten auszuführen.

Der NPCD ( Nagios Performance C Daemon ) überwacht nun das Verzeichnis auf neue Dateien und übergibt diese an process_perfdata.pl. Die Verarbeitung der Performancedaten ist also komplett von Nagios entkoppelt. NPCD wiederum ist in der Lage, zum Verarbeiten der Daten mehrere Threads zu starten.

## Bulk Mode mit npcdmod

In diesem Szenario kommt npcdmod.o, ein NEB-Modul, zum Einsatz. Diese Modul reduziert die Konfiguration des “Bulk Mode mit NPCD” auf zwei Zeilen in der nagios.cfg.

Dieser Modus ist gleichzusetzen mit dem “Bulk Mode mit NPCD”. Es ist auch genau der gleiche Ablauf und die gleiche Performance.

## Die Entscheidung

Welchen der beschriebenen Wege ihr verwendet, hängt also stark von der Größe der Nagios-Installation ab.

Die verwendeten Begriffe werden euch aber in der Dokumentation immer wieder über den Weg laufen.

Zurück zur Übersicht | Installation

de:pnp-0.6:modes

# Upgrade auf Version 0.6.x

Das Web-Frontend ist komplett neu geschrieben worden und basiert nun auf dem PHP MVC Framework Kohana. Somit ergeben sich grundlegend andere Abhängigkeiten, die dringend vor der Installation geprüft werden müssen.

Anmerkung: Ein Upgrade läuft zuerst wie eine Neuinstallation. Anschließend sind einige Anpassungen durchzuführen, die weiter unten beschrieben sind.

PNP 0.4.x wurde ohne weitere Angabe von Optionen beim Aufruf von `./configure` unterhalb einer Nagios-Installation unter `/usr/local/nagios` installiert.

PNP 0.6.x wird bei Angabe keiner weiteren Optionen unter `/usr/local/pnp4nagios` installiert, ist also wie Nagios als eigenständige Applikation zu sehen.

Anmerkung: Es reicht aus, die *.rrd-Dateien vom alten ins neue Verzeichnis zu kopieren. Sie enthalten die eigentlichen Daten. Die *.xml-Dateien werden jedes Mal neu angelegt, wenn Performance-Daten verarbeitet werden, denn sie enthalten lediglich Meta-Informationen. Außerdem hat sich die interne Struktur geändert, so dass sie sowieso nicht nutzbar sind.

## Vergleich der Struktur

Summary einer Installation von PNP 0.4.14

    ./configure
    ...
    *** Configuration summary for pnp 0.4.14 05-02-2009 ***

      General Options:
      -------------------------         -------------------
      Nagios user/group:                nagios nagios
      Install directory:                /usr/local/nagios
      HTML Dir:                         /usr/local/nagios/share/pnp
      Config Dir:                       /usr/local/nagios/etc/pnp
      Location of rrdtool binary:       /usr/bin/rrdtool Version 1.3.1
      RRDs Perl Modules:                FOUND (Version 1.3001)
      RRD Files stored in:              /usr/local/nagios/share/perfdata
      process_perfdata.pl Logfile:      /usr/local/nagios/var/perfdata.log
      Perfdata files (NPCD) stored in:  /usr/local/nagios/var/spool/perfdata/

Summary einer Installation von 0.6.0

    ./configure
    ...
    *** Configuration summary for pnp4nagios-0.6.0 07-30-2009 ***

      General Options:
      -------------------------         -------------------
      Nagios user/group:                nagios nagios
      Install directory:                /usr/local/pnp4nagios
      HTML Dir:                         /usr/local/pnp4nagios/share
      Config Dir:                       /usr/local/pnp4nagios/etc
      Location of rrdtool binary:       /usr/bin/rrdtool Version 1.3.1
      RRDs Perl Modules:                FOUND (Version 1.3001)
      RRD Files stored in:              /usr/local/pnp4nagios/var/perfdata
      process_perfdata.pl Logfile:      /usr/local/pnp4nagios/var/perfdata.log
      Perfdata files (NPCD) stored in:  /usr/local/pnp4nagios/var/spool

      Web Interface Options:  -------------------------         -------------------
      HTML URL:                         http://localhost/pnp4nagios/
      Apache Config File:               /etc/apache2/conf.d/pnp4nagios.conf

Aus diesen Infos ergeben sich die zu ändernden Parameter und somit die Upgrade-Strategie.

## Anpassungen

Die Vorlagen der action_url-Definitionen haben sich verändert. Statt ”/nagios/pnp” ist ”/pnp4nagios” einzutragen und statt “index.php” wird nun “graph” benutzt

    define host {
       name       host-pnp
       action_url /pnp4nagios/graph?host=$HOSTNAME$
       register   0
    }

    define service {
       name       srv-pnp
       action_url /pnp4nagios/graph?host=$HOSTNAME$&srv=$SERVICEDESC$
       register   0
    }

Ähnliches gilt für die Preview-Popup-Funktion

    define host {
       name       host-pnp
       action_url /pnp4nagios/graph?host=$HOSTNAME$' class='tips' rel='/pnp4nagios/popup?host=$HOSTNAME$
       register   0
    }

    define service {
       name       srv-pnp
       action_url /pnp4nagios/graph?host=$HOSTNAME$&srv=$SERVICEDESC$' class='tips' rel='/pnp4nagios/popup?host=$HOSTNAME$&srv=$SERVICEDESC$
       register   0
    }

Achtung: Es ist kein Fehler, dass die Zeichenketten vor und nach “class” jeweils nur ein Apostroph enthalten.

Anders als in der 0.4.x Dokumentation vermerkt gelten die Templates für Nagios 2.x und 3.x. Der einzige Unterschied besteht darin, dass die action_url-Direktive in Nagios 2.x nicht in der Service-Definition, sondern in eigenen serviceextinfo-Definitionen verfügbar ist.

Innerhalb der PHP-Dateien im templates-Verzeichnis müssen alle Variablen vor der ersten Benutzung initialisiert werden, z.B.

    $lower = ""

Das gilt auch für Variablen, an die früher “angehängt” werden konnte, ohne sie vorher zu initialisieren. Daher wird aus

    foreach ($DS as $i) {
        $def[1] .= "DEF:var$i=$rrdfile:$DS[$i]:AVERAGE " ;

nun

    $def[1] = "";
    foreach ($DS as $i) {
        $def[1] .= "DEF:var$i=$rrdfile:$DS[$i]:AVERAGE " ;

Konstanten in Template-Dateien funktionieren nicht mehr, so dass diese in Variablen umzuwandeln sind. Aus

    define("_WARNRULE", '#FFFF00');

wird dann z.B.

     $WARNRULE = '#FFFF00';

Man sollte daran denken, alle Vorkommen in der Datei zu ändern .

## Upgrade Szenario mit NPCD

1. Planen des neuen Aufbaus.
2. Testinstallation durchführen und sich mit dem neuen System vertraut machen.
3. Backup erstellen.
4. PNP 0.6.x nach `/usr/local/pnp4nagios` installieren.
5. make install-config
6. make install-webconf
7. Apache reload.
8. Apache-Config testen.
   1. Aufruf `/pnp4nagios` muss ein leeres Perfdata-Verzeichnis melden.
9. `/usr/local/pnp4nagios/etc/npcd.cfg` aus der `npcd.cfg-sample` erstellen.
   1. Pfade überprüfen und ggf. Änderungen der 0.4.x nachziehen.
10. Alle Pfade zur neuen Installation in der nagios.cfg anpassen.
11. Alle Pfade in den Command-Definitionen anpassen.
12. npcd über `/etc/init.d/npcd stop` anhalten.
13. `make install-init` installiert das neue Init Script für den npcd.
14. Nagios anhalten.
15. `/usr/local/nagios/share/perfdata` nach `/usr/local/pnp4nagios/var/perfdata` kopieren. Achtung: Auf Permissions achten.
16. `/etc/init.d/npcd` start
17. `/etc/init.d/nagios` start

de:pnp-0.6:upgrade

# Installation

Im Folgenden wird die Installation von PNP beschrieben. Dabei wird davon ausgegangen, dass Nagios aus den Sourcen übersetzt und im Verzeichnis /usr/local/nagios installiert wurde.
Achtung: Die Beschreibung bezieht sich auf die Developer-Version PNP 0.6.0.
Bitte vergessen Sie nicht, dass PNP nach der Installation noch konfiguriert werden muss.

## Make und Co

Die Installation von PNP wird wie bei Nagios auch über Makefiles gesteuert. Dabei wird durch den Aufruf von ./configure das System analysiert und die ermittelten Werte in Makefiles übernommen.

Als User root wird PNP in /usr/local/src entpackt.

    tar -xvzf pnp4nagios-HEAD.tar.gz
    cd pnp4nagios

Im Verzeichnis pnp4nagios wird nun ./configure aufgerufen.

    ./configure

Hinweis: Ohne weitere Optionen werden als Benutzer und Gruppe “nagios” verwendet. Bei abweichenden Werten sind die Parameter ”–with-nagios-user” und ”–with-nagios-group” zu benutzen. Im Falle von Icinga könnte der Aufruf so aussehen

    ./configure --with-nagios-user=icinga --with-nagios-group=icinga

Es laufen einige Zeilen über den Bildschirm. Wichtig ist die Ausgabe zum Schluss.

    *** Configuration summary for pnp4nagios-0.6.2 23-12-2009 ***

      General Options:
      -------------------------         -------------------
      Nagios user/group:                nagios nagios
      Install directory:                /usr/local/pnp4nagios
      HTML Dir:                         /usr/local/pnp4nagios/share
      Config Dir:                       /usr/local/pnp4nagios/etc
      Location of rrdtool binary:       /usr/bin/rrdtool Version 1.2.12
      RRDs Perl Modules:                FOUND (Version 1.2012)
      RRD Files stored in:              /usr/local/pnp4nagios/var/perfdata
      process_perfdata.pl Logfile:      /usr/local/pnp4nagios/var/perfdata.log
      Perfdata files (NPCD) stored in:  /usr/local/pnp4nagios/var/spool

      Web Interface Options:  -------------------------         -------------------
      HTML URL:                         http://localhost/pnp4nagios/
      Apache Config File:               /etc/apache2/conf.d/pnp4nagios.conf

      Review the options above for accuracy.  If they look okay,
      type 'make all' to compile.

Die angezeigten Pfade sollten nun geprüft werden. Falls die gezeigten Werte nicht passen, kann durch einen erneuten Aufruf von ./configure mit den passenden Optionen Abhilfe geschaffen werden.
ACHTUNG: Nachdem es immer wieder Schwierigkeiten gibt: “Location of rrdtool binary” bedeutet inkl. Namen des Binary! Bei Bedarf kann man das beim ./configure als Parameter angeben:

     ./configure --with-rrdtool=/usr/local/rrdtool-1.2.xx/bin/rrdtool

     ./configure --help

zeigt, welche Optionen möglich sind.
Ein

     make all

kompiliert nun die in C geschriebenen Komponenten wie NPCD

     make install

kopiert alles an die richtige Stelle im Filesystem. Die Pfade wurden ja beim ./configure bereits gezeigt.

Nach der Installation der Programm- und HTML-Dateien wird mit

     make install-webconf

eine Konfigurationsdatei in das Konfigurationsverzeichnis des Apache-Web-Servers kopiert.

Optional kann noch

     make install-config

aufgerufen werden. Damit werden Config-Files für process_perfdata.pl und npcd nach etc/pnp kopiert.

Wird das INIT Script für den NPCD benötigt, so sorgt

     make install-init

für die Installation nach /etc/init.d

Zusammenfassen lassen sich diese einzelnen Commands durch

make fullinstall

Achtung: Nach dem Kopieren der Konfigurationsdatei für den Web-Server ist ein Restart des Web-Servers notwendig (`service httpd restart` bzw. `/etc/init.d/apache2 restart`).

## Update

Das Update einer 0.6.x-Version funktioniert (fast) genauso wie die Installation. Bitte beachten Sie, dass Sie beim ”./configure” die gleichen Optionen wie bei der Erstinstallation benutzen! Bitte prüfen Sie außerdem, ob Sie Änderungen im Verzeichnis `share/templates.dist` vorgenommen haben. Eigene Templates sollten im Ordner `share/templates` abgelegt werden.
Achtung: Wenn Sie in der Datei config.php Änderungen vorgenommen haben, sollten Sie diese Datei sichern, bevor sie bei einem “make install-config” überschrieben wird.

Sie können die Schritte `make install-webconf` und `make install-init` überspringen, denn zwischen den 0.6.x-Versionen gab es an dieser Stelle keine Änderungen.

## Die Komponenten

Nach der Installation sind einige Komponenten von PNP an die passenden Stellen im Dateisystem kopiert worden.

Im Folgenden sind dies die PHP-Files für das Web-Frontend in

     /usr/local/pnp4nagios/share/pnp

Der Datensammler process_perfdata.pl in

     /usr/local/pnp4nagios/libexec

Beispiel-Config-Files mit der Dateierweiterung `-sample` in

     /usr/local/pnp4nagios/etc

Die Config-Datei config.php für das Web-Frontend in

     /usr/local/pnp4nagios/etc

Zurück zur Übersicht | Konfiguration

de:pnp-0.6:install

# Konfiguration

Im folgenden wird die Konfiguration der bereits erwähnten Arten der Performance-Daten Verarbeitung genauer erklärt.

Die bevorzugte Methode der PNP Entwickler ist der “Bulk Mode mit NPCD und npcdmod”.

## Synchronous Mode

Der Synchronous-Mode ist die einfachste Art, den Datensammler `process_perfdata.pl` in Nagios zu integrieren. Hierbei wird bei jedem Ereignis ein gesondertes Command `process-service-perfdata` (bzw. `process-host-perfdata`) ausgeführt.

Grundsätzlich ist in der `nagios.cfg` die Verarbeitung der Performance-Daten zu aktivieren. Bitte beachten Sie, dass diese Direktive wahrscheinlich bereits in der Konfigurationsdatei enthalten ist (Default ist “0”).

     process_performance_data=1

Für jeden Host und jeden Service, für den KEINE Performance-Daten verarbeitet werden sollen, ist die Verarbeitung der Performance-Daten explizit auszuschalten.

    define service {
       ...
       process_perf_data 0
       ...
    }

Weiterhin ist es ab Nagios 3.x möglich, in der `nagios.cfg` das Exportieren der Environment-Variablen zu deaktivieren. Diese sind jedoch für den Synchronous-Mode zwingend erforderlich. Daher muss

    enable_environment_macros=1

ebenfalls in der `nagios.cfg` gesetzt sein.

Zusätzlich wird das Kommando zum Verarbeiten der Performance-Daten in der `nagios.cfg` angegeben.

     service_perfdata_command=process-service-perfdata

Ab Nagios 3.x ist es durchaus sinnvoll, auch die Verarbeitung der Performance-Daten für Hosts einzuschalten. Nagios 3 führt durch die geänderte Hostcheck-Logik nun auch die Prüfung der Hosts regelmäßig aus.

     host_perfdata_command=process-host-perfdata

Die referenzierten Commands müssen natürlich auch Nagios bekannt gegeben werden. Wie man sieht, sind für den Aufruf von process_perfdata.pl so gut wie keine Optionen nötig. Einzig bei Performance-Daten der Host-Checks ist die Option -d ( DATATYPE ) nötig. Wenn Sie die Schnellstart-Installationsanleitungen für Nagios benutzt haben, können Sie die Definitionen in der Datei commands.cfg anpassen.

    define command {
           command_name    process-service-perfdata
           command_line    /usr/bin/perl /usr/local/pnp4nagios/libexec/process_perfdata.pl
    }

    define command {
           command_name    process-host-perfdata
           command_line    /usr/bin/perl /usr/local/pnp4nagios/libexec/process_perfdata.pl -d HOSTPERFDATA
    }

HINWEIS: `process_perfdata.pl` kann nicht unter Kontrolle des ePN ( embedded Perl Nagios ) gestartet werden. Daher wird das Script explizit mit `/usr/bin/perl` aufgerufen. Wird ePN nicht verwendet oder wird Nagios 3.x verwendet, kann auf die Angabe von `/usr/bin/perl` verzichtet werden.

zurück zur Übersicht | Funktion prüfen

## Bulk Mode

Der Bulk-Mode ist etwas komplizierter als der Synchronous-Mode, reduziert die Last auf dem Nagios Server jedoch merklich, da nun nicht mehr für jeden Service bzw. Host zusätzlich der Datensammler `process_perfdata.pl` gestartet werden muss.

Im Bulk-Mode schreibt Nagios die Daten in einem definierten Format in eine temporäre Datei. Diese Datei wiederum wird periodisch von `process_perfdata.pl` verarbeitet. Um den Start und den Intervall kümmert sich dabei Nagios selbst.

Auch hier muss die Verarbeitung der Performance-Daten in der `nagios.cfg` eingeschaltet werden.

     process_performance_data=1

Zusätzlich werden einige neue Parameter benötigt.

    #
    # Service Performance-Daten
    #
    service_perfdata_file=/usr/local/pnp4nagios/var/service-perfdata
    service_perfdata_file_template=DATATYPE::SERVICEPERFDATA\tTIMET::$TIMET$\tHOSTNAME::$HOSTNAME$\tSERVICEDESC::$SERVICEDESC$\tSERVICEPERFDATA::$SERVICEPERFDATA$\tSERVICECHECKCOMMAND::$SERVICECHECKCOMMAND$\tHOSTSTATE::$HOSTSTATE$\tHOSTSTATETYPE::$HOSTSTATETYPE$\tSERVICESTATE::$SERVICESTATE$\tSERVICESTATETYPE::$SERVICESTATETYPE$
    service_perfdata_file_mode=a
    service_perfdata_file_processing_interval=15
    service_perfdata_file_processing_command=process-service-perfdata-file

    #
    # Host Performance-Daten ab Nagios 3.x
    #
    host_perfdata_file=/usr/local/pnp4nagios/var/host-perfdata
    host_perfdata_file_template=DATATYPE::HOSTPERFDATA\tTIMET::$TIMET$\tHOSTNAME::$HOSTNAME$\tHOSTPERFDATA::$HOSTPERFDATA$\tHOSTCHECKCOMMAND::$HOSTCHECKCOMMAND$\tHOSTSTATE::$HOSTSTATE$\tHOSTSTATETYPE::$HOSTSTATETYPE$
    host_perfdata_file_mode=a
    host_perfdata_file_processing_interval=15
    host_perfdata_file_processing_command=process-host-perfdata-file

Achtung: Die Template-Definitionen weichen von denen in der Original-nagios.cfg ab!

Die Parameter und deren Bedeutung im Einzelnen:

- `service_perfdata_file` Der Pfad zur temporären Datei, in der die Daten gesammelt werden sollen.
- `service_perfdata_file_template` Das Format der temporären Datei. Hier werden die Daten über Nagios-Macros definiert.
- `service_perfdata_file_mode` Die Option “a” definiert, dass an die Datei angehangen werden soll.
- `service_perfdata_file_processing_interval` Das Intervall beträgt 15 Sekunden
- `service_perfdata_file_processing_command` das Command, das im definierten Intervall aufgerufen werden soll.

Die verwendeten Commands müssen Nagios wiederum bekannt gegeben werden. Wenn Sie die Schnellstart-Installationsanleitungen für Nagios benutzt haben, können Sie die Definitionen in der Datei commands.cfg anpassen.

    define command{
           command_name    process-service-perfdata-file
           command_line    /usr/local/pnp4nagios/libexec/process_perfdata.pl --bulk=/usr/local/pnp4nagios/var/service-perfdata
    }

    define command{
           command_name    process-host-perfdata-file
           command_line    /usr/local/pnp4nagios/libexec/process_perfdata.pl --bulk=/usr/local/pnp4nagios/var/host-perfdata
    }

HINWEIS:

Da `process_perfdata.pl` nun mehr Daten zu verarbeiten hat als im Default Mode, kommt es natürlich auch zu längeren Laufzeiten. Daher ist der TIMEOUT Wert in der `etc/process_perfdata.cfg` zu überprüfen und ggf. anzupassen.

zurück zur Übersicht | Funktion prüfen

## Bulk Mode with NPCD

Die Konfiguration ist identisch mit dem “Bulk Mode”, einzig das verwendete Command ist leicht abgewandelt. Wenn Sie die Schnellstart-Installationsanleitungen für Nagios benutzt haben, können Sie die Definitionen in der Datei commands.cfg anpassen.

    define command{
           command_name    process-service-perfdata-file
           command_line    /bin/mv /usr/local/pnp4nagios/var/service-perfdata /usr/local/pnp4nagios/var/spool/service-perfdata.$TIMET$
    }

    define command{
           command_name    process-host-perfdata-file
           command_line    /bin/mv /usr/local/pnp4nagios/var/host-perfdata /usr/local/pnp4nagios/var/spool/host-perfdata.$TIMET$
    }

Durch die Kommandos wird immer nach Ablauf des über `service_perfdata_file_processing_interval` eingestellten Intervalls die Datei service-perfdata nach var/spool/ verschoben. Dabei wird das Nagios-Macro $TIMET$ verwendet, an den Dateinamen angehängt, um zu verhindern, dass alte Dateien ungewollt überschrieben werden. Das Macro $TIMET$ enthält den aktuellen Zeitstempel in Unix-Time-Format ( Sekunden seit 1.1.1970 ).

Somit sammeln sich Dateien im Verzeichnis /usr/local/pnp4nagios/var/spool/, die nun mit Hilfe des NPCD verarbeitet werden.

NPCD überwacht das Spool-Verzeichnis und übergibt wiederum alle gefundenen Dateien an `process_perfdata.pl`. Damit ist die Verarbeitung der Performancedaten komplett von Nagios entkoppelt. Wir müssen nur noch den NPCD starten.

     /usr/local/pnp4nagios/bin/npcd -d -f /usr/local/pnp4nagios/etc/npcd.cfg

Die Option `-d` veranlasst NPCD im Hintergund als Daemon seinen Dienst zu verrichten.

Das Init Script für den NPCD wir während der Installation über “make install-init” installiert und kann somit auch für den Start verwendet werden.

     /etc/init.d/npcd start

In der Config-Datei des NPCD, der `npcd.cfg`, ist vor dem ersten Start zu prüfen, ob die Pfade zum Spool-Verzeichnis und zu `process_perfdata.pl` richtig gesetzt sind.

Weitere Informationen zu NPCD findet ihr hier.

## Bulk Mode with NPCD und npcdmod

Bei diesem Modus kommt das Eventbroker-Modul npcdmod.o zu Einsatz. Der Datenfluss ist jedoch identisch zum “Bulk Mode mit NPCD”. Die internen Perfdata-Routinen von Nagios, die über die “*_perf_data_*” Optionen in der `nagios.cfg` konfiguriert werden, kommen NICHT mehr zu Einsatz. Das Modul npcdmod.o kümmert sich um die für PNP nötige Aufbereitung der Daten.

Vorteil:

- Die Perfdata-Routinen innerhalb von Nagios stehen wieder für andere Addons zur Verfügung.
- Die Konfiguration reduziert sich.
- Die bevorzugte Methode der PNP-Entwickler.

Anpassung in der `nagios.cfg`:

    process_performance_data=1
    broker_module=/usr/local/pnp4nagios/lib/npcdmod.o config_file=/usr/local/pnp4nagios/etc/npcd.cfg

Alle anderen auf dieser Seite gezeigten Optionen dürfen für diesen Modus NICHT mehr verwendet werden.

Achtung: Wichtig sind in diesem Zusammenhang auch die `event_broker_options` bei einem von -1 abweichenden Wert. Für PNP müssen die Bits 2 und 3 gesetzt sein (0b01100; siehe auch http://www.nagios-wiki.de/nagios/ndo/eventbroker_optionen).

Nach dem Neustart von Nagios werden Informationen zum Ladevorgang des Moduls protokolliert.

Auszug aus den nagios.log

    [1277545053] npcdmod: Copyright (c) 2008-2009 Hendrik Baecker (andurin@process-zero.de) - http://www.pnp4nagios.org
    [1277545053] npcdmod: /usr/local/pnp4nagios/etc/npcd.cfg initialized
    [1277545053] npcdmod: spool_dir = '/usr/local/pnp4nagios/var/spool/'.
    [1277545053] npcdmod: perfdata file '/usr/local/pnp4nagios/var/perfdata.dump'.
    [1277545053] npcdmod: Ready to run to have some fun!
    [1277545053] Event broker module '/usr/local/pnp4nagios/lib/npcdmod.o' initialized successfully.

zurück zur Übersicht | Funktion prüfen

de:pnp-0.6:config

# Prüfen der Installation

Wenn bis jetzt alles sauber funktioniert hat, kann PNP zum ersten Mal im Browser aufgerufen werden. Bei der Installation mit den Standardeinstellungen erfolgt der Aufruf über http://<Servername>/pnp4nagios/.

Beim ersten Aufruf sieht man die Seite “PNP4Nagios Environment Tests”, die verschiedene Tests von notwendigen Komponenten enthält. Offenkundig sollten alle Tests erfolgreich verlaufen, bevor es weitergehen kann. Bitte beachten Sie die Hinweise auf der Seite.

Sind alle Tests erfolgreich verlaufen, so kann die Datei `pnp4nagios/share/install.php` gelöscht oder umbenannt werden. Erst dann ist das Webinterface erreichbar.

Alternativ kann eine Datei `pnp4nagios/share/install.ignore` angelegt werden, um den Aufruf des Installers nach weiteren Updates zu ignorieren.

Ohne weitere Optionen sucht PNP nach RRD- und XML-Dateien in `pnp4nagios/var/perfdata/` und zeigt alle Graphen des ersten Hosts in der Übersicht an.

ACHTUNG: Direkt nach dem (Neu-)Start von Nagios nach dem Aktivieren der Verarbeitung von Performance-Daten wird der Aufruf im Browser zu Fehlermeldungen führen, weil zunächst Performance-Daten gesammelt und in den RRD-Dateien abgelegt werden müssen. Abhängig vom Check-Intervall kann es einige Zeit dauern, bis die ersten Graphen angezeigt werden können.

## Logfile

Während der Installation wurde durch den Aufruf von `make install-config` ein Beispiel-Config-File `etc/process_perfdata.cfg-sample` erzeugt. Die Werte in der sample-Datei entsprechen den Default-Werten, die auch in `process_perfdata.pl` fest hinterlegt sind, daher ist die `process_perfdata.cfg` für den Betrieb nicht zwingend notwendig.

Die Datei `process_perfdata.cfg-sample` kann somit als Vorlage für die `process_perfdata.cfg` dienen, die immer dann notwendig ist, wenn vom Standard abweichende Werte eingestellt werden sollen.

In der `process_perfdata.cfg` lässt sich das Verhalten von `process_perfdata.pl` vielfach beeinflussen.

Die wichtigsten Optionen für die Inbetriebnahme sind LOG_LEVEL und LOG_FILE. Im laufenden Betrieb sollte der Log-Level immer auf 0 gesetzt sein, um die Performance von process_perfdata.pl nicht durch unnötiges Schreiben von Logfiles zu beeinträchtigen.

Während der Inbetriebnahme sollte man jedoch den `LOG_LEVEL` auf “2” setzen, um zu sehen, was process_perfdata.pl bei der Verarbeitung der Performance-Daten so alles anstellt.

Spätestens bei Support Anfragen im Forum oder auf den Mailinglisten werden wir sowohl nach Auszügen aus dem perfdata.log als auch nach der Ausgabe des verify_pnp_config-Scripts fragen. Es empfiehlt sich also, diese Angaben gleich mitzuliefern .

## Was aber wenn nicht ?

Einige grundlegende Einstellungen sind zu prüfen.

1. Sind RRD- und XML-Files erzeugt worden ?

`process_perfdata.pl` legt für jeden Host unter var/perfdata ein neues Verzeichnis an. In diesem Verzeichnis wird wiederum für jeden Service eine RRD-Datenbank und ein XML-File erstellt. Für den Host-Check lautet der Dateinamen `_HOST_.xml` bzw. `_HOST_.rrd`.
Falls Graphen urplötzlich nicht mehr weitergeführt werden, dann hilft vielleicht ein Blick in die betroffene XML-Datei. Dort gibt es u.a. die Tags <RC> und <TXT>. <RC> zeigt den Return-Code des RRDtool-Updates der RRD-Datei, <TXT> eine textuelle Beschreibung.
Allerdings liefern nicht alle Checks Performance-Daten, das gilt u.a. für “check_ping”, die Alternative “check_icmp” dagegen erzeugt Daten (ab Nagios-Plugin-Version 1.4.12 liefert auch check_ping Performance-Daten).
Teilweise muss man zusätzliche Optionen aktivieren, damit Performance-Daten ausgegeben werden. Evtl. kann das auch durch ein Wrapper-Script geändert werden.
In den Detailinformationen zu jedem Host/Service gibt es das Feld “Performance-Data”. Wenn dort keine Daten stehen, dann werden im jeweiligen Verzeichnis keine Dateien erzeugt und PNP kann deshalb auch keine grafischen Auswertungen liefern!
Das folgende Bild zeigt die Informationen zu einem “PING”-Service. Das blaue Feld enthält den vom Plugin gelieferten Text, das rote die Performance-Daten, die Nagios erkannt hat.

2. Hat Nagios `process_perfdata.pl` aufgerufen ?

In der Config-Datei für process_perfdata.pl, der `etc/process_perfdata.cfg` lässt sich der Debug-Level erhöhen. Die Verarbeitung der Daten wird nun in `var/perfdata.log` bzw. im Syslog protokolliert.

3. Grafiken werden ohne Text angezeigt ?

siehe Anforderungen

4. Bei aktiviertem npcdmod-Modul muss der Wert von `event_broker_options` in der nagios.cfg ggf. angepasst werden. Hinweise gibt es hier.

5. verify_pnp_config

Das Perl-Script verify_pnp_config.pl im `scripts`-Verzeichnis des Installationsordners bzw. im `libexec`-Verzeichnis ermöglicht die Prüfung von Konfigurationseinstellungen und zeigt, ob Performance-Daten vorhanden bzw. gültig sind. Die Syntax dafür ist ziemlich einfach:

    ./verify_pnp_config.pl -m <Modus>

wobei `<Modus>` durch “sync”, “bulk” oder “npcd” zu ersetzen ist (ohne Anführungszeichen). Bitte beachten Sie, dass “default” ab PNP v.0.6.0 den “npcd”-Modus prüft.

zurück zur Übersicht | verify_pnp_config.pl

de:pnp-0.6:verify

# verify_pnp_config

Bei Problemen kann das Perl-Script `verify_pnp_config.pl` im `scripts`-Verzeichnis helfen, mit dem neben der Konfiguration auch die Performance-Daten von Hosts und Services geprüft werden können. Es kann sowohl vor als auch während des Betriebs von PNP genutzt werden.

* Hinweis *: Die Angaben beziehen sich auf verify_pnp_config v0.1.24, das über http://www.pnp4nagios.org/pnp/dwnld in der Version 0.6.7 zu finden ist. Ältere Versionen haben teilweise weniger Optionen, so dass es in den Beschreibungen der einzelnen Optionen Hinweise auf die PNP-Version gibt.

* Hinweis *: In PNP 0.6.4 fehlt eine Zeile im Script, was zu einem Fehler führt, so dass Sie vorher diese Zeile einfügen sollten:

         $CPcfg{'$conf[\'max_age\']'} = 'n;^\(?[\d\* ]+\)?$';
         $CPcfg{'$conf[\'temp\']'} = 'd;;';
         $CPcfg{'$conf[\'base_url\']'} = "S;.+;";   # <-- diese Zeile einfügen
         $CPcfg{'$conf[\'nagios_base\']'} = "S;.+;";
         $CPcfg{'$conf[\'allowed_for_service_links\']'} = 'S;[\S,]+;';

* Hinweis *: die “langen” Optionen beginnen immer mit zwei ”-”. Leider ist das im Text nicht zu erkennen.

Die einfachste Form des Aufrufs zur Überprüfung der Konfiguration lautet:

    ./verify_pnp_config.pl -m <Modus>

wobei <Modus> durch den benutzen PNP-Modus zu ersetzen ist (sync, bulk oder NPCD).

Das Script liefert beim Aufruf mit der Option `–h` bzw `–help` u.a. die folgende Ausgabe:

    -h, --help        print these lines
    -b, --basedir=s   Nagios Base directory (default: /usr/local/nagios)
    -B, --binary=s    Nagios binary (default: nagios)
    -c, --config=s    Nagios main config file (default: /usr/local/nagios/etc/nagios.cfg)
    -m, --mode=s      PNP mode ("sync", "bulk", "NPCD")
    -l, --logfile=s   check configure log file
    -D, --pnpdir=s    PNP root dir
    -N, --npcdcfg=s   PNP config file for NPCD mode (default: /usr/local/pnp4nagios/etc/npcd.cfg)
    -P, --ppcfg=s     process_perfdata config file (default: /usr/local/pnp4nagios/etc/process_perfdata.cfg)
    -C, --cpcfg=s     PNP config file (config.php)
    -p, --precheck    use config files instead of objects cache
    -r, --rrdtool=s   specify the location of the RRDtool binary
    -R, --RRDpath=s   specify the perfdata directory (default: /usr/local/pnp4nagios/var/perfdata) or "no" for no check
    -U, --resource=s  location of the resource config file (default: /usr/local/nagios/etc/resource.cfg)
    -M, --monitor=s   specify the monitoring product (default: nagios, may be "icinga")
    -L, --layout=s    specify a layout (Nagios2, Nagios3, SuSE, Fedora)
    -T, --template=s  specify the path to the templates directory (default /usr/local/pnp4nagios/share/templates.dist)
    -u, --user=s      user of the perfdata directory
    -g, --group=s     group of the perfdata directory
    -q, --quiet       quiet mode, non-zero return code will indicate errors
    -o, --object=s    Nagios object (host name, service description)
    -t, --time        show warnings if RRDfiles are too old
    -s, --skip        skip check of installed packages
    -n, --native      show messages in native language (so far "es" or "de")
    -e, --english     show english messages/links
    -d, --debug       some debugging output
    -I, --info        show information about compile time variable settings

Das Nagios-Programm und der Zugriff auf die Hauptkonfigurationsdatei `nagios.cfg` werden immer benötigt. Bei vom Standard abweichenden Pfaden für Nagios gibt es daher die Möglichkeit, über die Option -L ein anderes Layout vorzugeben. Je nach Distribution bzw. Version sollte einer der Werte “suse” oder “fedora” bzw. “nagios2” oder “nagios3” funktionieren (u.a. bei Debian und Ubuntu).
Falls das alles nichts hilft, kann man sowohl das Basisverzeichnis (-b bzw. `–basedir`), den Namen des Programms (-B bzw. `–binary`) als auch den Standort der Hauptkonfigurationsdatei (-c bzw. `–config`) und der Ressource-Datei (-U bzw. –resource) mit Hilfe von Optionen anzugeben. Wenn der Name des Programms mit einem ”/” beginnt, dann wird dieser Wert als absolute Angabe betrachtet und unverändert übernommen. Ohne ”/” ergibt sich der Pfad aus dem Basisverzeichnis mit angehängtem “bin” und dem Binary-Namen.

Ohne Angabe von Optionen wird die Hilfeseite ausgegeben, so dass entweder der Modus oder ein Objekt als Parameter anzugeben sind.

Mit der Option `-m` (`–mode`) wird dabei der PNP-Modus angegeben, dessen Einstellungen untersucht werden. Dabei erlaubt die Option `-l <Dateiname>` bzw. `–logfile=<Dateiname>` die Prüfung der Konfiguration während der Installationsphase. Sie müssen bereits `./configure` (ggf. mit zusätzlichen Optionen) ausgeführt haben. Dadurch wird die Datei `config.log` erstellt, deren Name als Parameter übergeben wird. Das Script prüft, ob die Software-Voraussetzungen erfüllt werden bzw. ob verschiedene Einstellungen korrekt vorgenommen wurden. Dazu gehört auch ein Aufruf des RRDtool-Programms, so dass ggf. die Option `-r` (`–rrdtool`) benutzt werden muss, wenn es nicht unter /usr/bin/rrdtool zu finden ist.

Das Script prüft, ob für Dateien/Verzeichnisse im perfdata-Verzeichnis Benutzer und Gruppe mit den Werten übereinstimmen, die in der nagios.cfg eingetragen sind. Außerdem wird geprüft, ob innerhalb der xml-Dateien Return-Codes des RRDtools gefunden werden, die auf einen Fehler hinweisen. Dabei kann mit der Option -R (–RRDpath) das Verzeichnis angegeben werden, unter dem die RRD-Dateien abgelegt sind, falls es vom Standard abweicht. Falls keine Prüfung gewünscht wird, ist “no” als Verzeichnis anzugeben. Mit den Optionen -u (–user) und -g (–group) können Benutzer und Gruppe des Perfdata-Verzeichnisses angegeben werden, falls diese vom Nagios-Benutzer abweichen sollten.

Nach der Installation können die Änderungen in der nagios.cfg mit der Option `–p (–precheck)` überprüft werden, bevor ein Neustart erfolgt ist. Das ist sinnvoll, um ggf. fehlerhafte Einträge zu korrigieren, ohne Nagios jeweils neu starten zu müssen.

Beim Aufruf mit der Option `-o`, der als Parameter eine Zeichenkette folgt, werden alle Hosts bzw. Services mit diesem Namen sowie die Informationen zu Performance-Daten ausgegeben. Die Zeichenkette sollte in Anführungszeichen gesetzt werden. Falls keine bzw. fehlerhafte Performance-Daten vorhanden sind, gibt es entsprechende Meldungen.

Durch das Anhängen eines Semikolons werden nur Hosts mit der angegebenen Zeichenkette untersucht, durch Voranstellen nur Services. Enthält die Zeichenkette mittendrin ein Semikolon, dann wird der erste Teil als Hostname und der zweite als Servicebeschreibung betrachtet und die Auswertung auf diesen Host mit dem entsprechenden Service beschränkt:

- Hostname/Servicebeschreibung ⇒ Zeichenkette in Hostname oder Servicebeschreibung
- Hostname; ⇒ Einschränkung auf Hostnamen
- ;Servicebeschreibung ⇒ Einschränkung auf Servicebeschreibung
- Hostname;Servicebeschreibung ⇒ Einschränkung auf Hostname und Servicebeschreibung

Ab PNP-Version 0.6 hat sich die Verzeichnisstruktur geändert, so dass alle Dateien unter einem separaten Verzeichnis liegen. Mit der Option -D (–pnpdir) kann man einen von /usr/local/pnp4nagios abweichenden Pfad für das PNP-Basisverzeichnis angeben. Diese Einstellung wirkt sich auch auf die Optionen ”-N”, ”-P” und ”-C” aus, so dass dort ggf. keine Werte angegeben werden müssen.

Im NPCD-Modus kann durch die Option `-N` (`–npcdcfg`) der Name der Konfigurationsdatei angegeben werden, falls Name oder Ort nicht dem Standard entspricht (/usr/local/pnp4nagios/etc/npcd.cfg).

Mit der Option `-P` (`–ppcfg`) wird der Name der Konfigurationsdatei für process_perfdata.pl angegeben, falls Name oder Ort vom Standard abweicht (/usr/local/pnp4nagios/etc/process_data.cfg).

Mit der Option -C (–cpcfg) wird der Name der Konfigurationsdatei config.php angegeben, falls Name oder Ort vom Standard abweicht (/usr/local/pnp4nagios/etc/config.php).

Durch die Option -M (–monitor) kann das Produkt angegeben werden, von dem PNP die Daten bekommt. Per Default ist das Nagios, inzwischen wird auch Icinga unterstützt. Teilweise müssen auch die Optionen -b, -B und -c benutzt werden.

Teilweise entstehen beim Aendern von Templates Fehler, die man in der Web-GUI nicht so schnell findet. Mit der Option -T werden die Template-Dateien auf Fehler geprüft. Als Parameter ist der Pfad zum Template-Directory anzugeben.

Normalerweise wird geprüft, ob bestimmte Pakete installiert sind. Falls es dabei Schwierigkeiten gibt (oder man sicher ist, dass alle benötigten Pakete vorhanden sind), kann man die Prüfung durch die Option -s (–skip) überspringen.

Mit der Option -n (–native) gefolgt von “es” or “de” können spanische oder deutsche Meldungen gewählt werden.

Die Option `-e` (`–english`) erzwingt die Anzeige von englischen Meldungen, selbst wenn abweichende Spracheinstellungen erkannt werden.

Durch Angabe der Option `-d` bzw. `–debug` werden zusätzliche Zeilen ausgegeben, die bei der Fehlersuche helfen können, `-q` bzw. `–quiet` unterdrückt sämtliche Ausgaben.

Die Option `-I` (`–info`) zeigt die Inhalte von Variable wie z.B. `prefix`, `datadir` und anderen Dingen, die Sie vielleicht beim Aufruf von './configure' geändert haben. In einigen Fällen möchten wir diese Werte wissen und mit Hilfe dieser Option geht es einfacher als wenn Sie verschiedene Dateien durchsuchen müßten. Diese Option gibt es seit PNP 0.6.7.

Die Ausgaben selbst beginnen mit einem Buchstaben, der genauere Informationen ueber die Art der Ausgaben gibt:

`[I]` Informationen zu Einstellungen, …
`[A]` durchzuführende Aktionen
`[W]` Warnung: beeinträchtigt nicht die Arbeitsweise von PNP
`[E]` Fehlermeldung: PNP wird nicht korrekt arbeiten, solange das Problem besteht
`[H]` Hinweis: es ist ratsam, die angegebene Dokumentation zu lesen
`[D]` Debugging-Meldung, die hoffentlich zur Fehlerbehebung führt

zurück zur Übersicht | das Web-Frontend

de:pnp-0.6:verify_pnp_config

# Das Nagios Web Frontend

PNP soll natürlich schnell erreichbar sein. Man möchte nicht lange nach den richtigen Graphen suchen.

Nagios selbst bietet die Möglichkeit, externe URLs über die sogenannte Extended Info Config einzubinden. Da es in diesem Bereich eine Änderung zwischen Nagios 2.x und der Version 3.0 gibt, wird anschließend auf beide Versionen getrennt eingegangen.

## Nagios 2.x

Bis Nagios 2.x erfolgt die Einbindung externer URLs in das Nagios-Web-Interface über die Extended-Info-Objekte. Für PNP verwenden wir die Option action_url, um das PNP-Web-Frontend mit den passenden Optionen aufzurufen.

    define serviceextinfo {
       name                  srv-pnp
       action_url            /pnp4nagios/index.php/graph?host=$HOSTNAME$&srv=$SERVICEDESC$
       register              0
    }

Dieses Template kann nun über “use srv-pnp” in der serviceextinfo-Definition verwendet werden. Wenn Sie die Schnellstart-Installationsanleitungen benutzt haben, können Sie beispielsweise in der Datei localhost.cfg die Definitionen wie folgt erweitern:

    define serviceextinfo {
       use                     srv-pnp   ; Name of service templates to use
       host_name               localhost
       service_description     load
    }

## Nagios 3.x

Seit Nagios 3.0 ist die Direktive action_url in die Host- bzw. Service-Definition verschoben worden. Die serviceextinfo- und hostextinfo-Definitionen sind entfallen. Damit wird die Definition der URLs zum PNP-Interface wesentlich vereinfacht.

Zuerst definieren wir zwei Nagios-Templates. Falls Sie die Schnellstart-Installationsanleitungen für Nagios benutzt haben, können Sie die folgenden Zeilen der Datei templates.cfg hinzufügen:

    define host {
       name       host-pnp
       action_url /pnp4nagios/index.php/graph?host=$HOSTNAME$&srv=_HOST_
       register   0
    }

    define service {
       name       srv-pnp
       action_url /pnp4nagios/index.php/graph?host=$HOSTNAME$&srv=$SERVICEDESC$
       register   0
    }

Diese beiden Templates können nun über “use srv-pnp” in der Service-Definition oder “use host-pnp” in der Host-Definition verwendet werden. Wenn Sie die Schnellstart-Installationsanleitungen benutzt haben, können Sie beispielsweise in der Datei localhost.cfg die Definitionen wie folgt erweitern:

    define host{
            use                     linux-server,host-pnp    ; Name of host templates to use
                                                             ; This host definition will inherit all variables that are defined
                                                             ; in (or inherited by) the linux-server host template definition.
            host_name               localhost
            alias                   localhost
            address                 127.0.0.1
            }

    define service{
            use                     local-service,srv-pnp   ; Name of service templates to use
            host_name               localhost
            service_description     PING
            check_command           check_ping!100.0,20%!500.0,60%
            }

Die Links auf die richtigen URLs werden automagisch erstellt.

## Preview Popup

Außerdem gibt es die Möglichkeit, die Graphen bereits in der Statusübersicht beim Überfahren des “Action Url Icons” mit der Maus einzublenden.

Ermöglicht wird dies durch die CGI Includes, die es uns erlauben, Javascript-Code an geeigneter Stelle im Seitenkopf der Statusübersicht einzubinden ( status.cgi ).

In den PNP-Quellen ist die Datei `contrib/ssi/status-header.ssi` bereits enthalten, die verwendeten URLs müssen aber unter Umständen angepasst werden. Wir gehen hier davon aus, dass PNP über `/pnpnagios/index.php` erreichbar ist.

Die besagte Datei muss in das Verzeichnis `/usr/local/nagios/share/ssi/` kopiert werden und darf NICHT ausführbar sein. Nagios würde die Datei sonst wirklich wie ein CGI behandeln und ausführen, was aber in diesem Fall zu Fehlern führen würde. Die Apache-Admins mögen bitte “Nagios SSI” nicht mit “Apache SSI” in Verbindung bringen. Beides hat nichts miteinander zu tun.

Die action_url ist entsprechend anzupassen:

    define host {
       name       host-pnp
       register   0
       action_url /pnp4nagios/index.php/graph?host=$HOSTNAME$&srv=_HOST_' class='tips' rel='/pnp4nagios/index.php/popup?host=$HOSTNAME$&srv=_HOST_
    }

    define service {
       name       srv-pnp
       register   0
       action_url /pnp4nagios/index.php/graph?host=$HOSTNAME$&srv=$SERVICEDESC$' class='tips' rel='/pnp4nagios/index.php/popup?host=$HOSTNAME$&srv=$SERVICEDESC$
    }

Nach einem Restart von Nagios (nach Anpassung der Definitionen) sieht das Ergebnis ungefähr so aus:

Zurück zur Übersicht | Konfiguration Web-Frontend

de:pnp-0.6:webfe

# PNP Web Frontend

Das Verhalten des PNP-Web-Frontend lässt sich über die Config-Datei `etc/config.php` beeinflussen. Diese Datei wird bei Updates von PNP immer wieder überschrieben, da die meisten Pfade und Optionen bereits durch `./configure` ermittelt werden.

Eigene Anpassungen sollten daher in der Datei etc/config_local.php erfolgen. Sollte die Datei noch nicht existieren, kann die config.php als Vorlage verwendet werden.

## etc/pnp/config.php

Im folgenden die wichtigsten Parameter:

Der Pfad zum RRDtool-Binary. Wird von `./configure` ermittelt.

     $conf['rrdtool'] = "/usr/bin/rrdtool";

Höhe und Breite der RRD-Graphen

     $conf['graph_width'] = "500";
     $conf['graph_height'] = "100";

Bildschirmdimensionen ändern sich, Blattgrößen nicht. Um unterschiedliche Einstellungen zu ermöglichen, können für die Generierung von PDF-Dateien eigene Werte definiert werden. Wenn diese Variablen nicht definiert sind, werden die Werte der Graphen benutzt. Höhe und Breite der RRD-Graphen bei PDFs

     $conf['pdf_width'] = "675";
     $conf['pdf_height'] = "100";

Zusätzliche Optionen, die bei jedem Aufruf von RRDTool mit übergeben werden. Beispielsweise `—-slope-mode`, um die Graphen etwas zu glätten.

     $conf['graph_opt'] = "";

Der Pfad zu den von `process_perfdata.pl` erstellten RRD- und XML-Dateien

     $conf['rrdbase'] = "/usr/local/pnp4nagios/var/perfdata/";

Pfad zu den Config-Files für die Pages.

     $conf['page_dir'] = "/usr/local/pnp4nagios/etc/pages/";

Wert in Sekunden, nachdem die PNP-Seiten neu geladen werden sollen.

     $conf['refresh'] = "90";

Maximales Alter der RRD-Files in Sekunden. Nach Erreichen dieses Wertes werden Links zu den Graphen als “inactive” gekennzeichnet.

     $conf['max_age'] = 60*60*6;

Basis-URL zu den Nagios CGIs.

     $conf['nagios_base'] = "/nagios/cgi-bin";

Liste von Usern, für die Links zu den Services des aktuellen Hosts angezeigt werden sollen.

     $conf['allowed_for_service_links'] = "EVERYONE";

Liste von Usern, für die das Host-Suchfeld angezeigt werden soll.

     $conf['allowed_for_host_search'] = "EVERYONE";

Wird PNP nur mit der Angabe eines Hosts ( index.php?host=<myserver> ) aufgerufen, so wird eine Übersicht aller Services angezeigt, wenn der User in dieser Liste enthalten ist.

     $conf['allowed_for_host_overview'] = "EVERYONE";

Das Array $views[] legt fest, welche Zeitspannen die RRD-Graphen dargestellen sollen. Der Titel und die Anzahl der Graphen kann somit hier zentral definiert werden.

    $views[0]["title"] = "4 Hours";
    $views[0]["start"] = ( 60*60*4 );

    $views[1]["title"] = "24 Hours";
    $views[1]["start"] = ( 60*60*24 );

    $views[2]["title"] = "One Week";
    $views[2]["start"] = ( 60*60*24*7 );

    $views[3]["title"] = "One Month";
    $views[3]["start"] = ( 60*60*24*30 );

    $views[4]["title"] = "One Year";
    $views[4]["start"] = ( 60*60*24*365 );

Sie können hier auch weitere Views definieren ($views[5], …), sollten aber dabei berücksichtigen, dass im Normalfall ALLE definierten Views angezeigt werden.

zurück zur Übersicht | Timeranges

de:pnp-0.6:webfe_cfg

# Timeranges

In der Übersicht zeigt PNP fünf Zeitbereiche, die frei in der config.php definiert werden können.

Es gibt aber auch die Möglichkeit, die Zeitbereiche über die URL zu beeinflussen. Dies ist hilfreich, wenn z.B. automatisch PDF-Dokumente erstellt werden sollen

Die Zeitbereiche werden über die Optionen `start` und `end` definiert.

Beispiel:

     pnp4nagios/graph?host=<hostname>&srv=<servicedesc>&start=-1week

Der Startzeitpunkt der Graphen wird somit, ausgehend vom aktuellen Datum, um eine Woche nach hinten verschoben. Der Endzeitpunkt bleibt auf dem aktuellen Zeitstempel. Aber auch `end` lässt sich über diesen Weg beeinflussen, wobei beide Optionen auch einzeln manipuliert werden dürfen.

start | end | view | Ergebnis
--- | --- | --- | ---
|  |  | Alle Ansichten enden mit der aktuellen Zeit
x |  |  | Alle Ansichten beginnen mit dem angegebenen Datum
| x |  | Alle Ansichten enden mit dem angegebenen Datum
x | x |  | Eine Ansicht zwischen den beiden Zeitangaben
|  | x | Eine Ansicht endet mit der aktuellen Zeit
x |  | x | Eine Ansicht beginnt mit dem angegebenen Datum
| x | x | Eine Ansicht endet mit dem angegebenen Datum

Beispiele zur Datumsangabe:

Format | Beschreibung
--- | ---
2009W04 | 4. KW 2009
1.5.2009 | 1. Mai 2009
-1 day | Einen Tag zurück
-3 weeks | 3 Wochen zurück
-1 year | Ein Jahr zurück
yesterday | Gestern

zurück zur Übersicht | Pages

de:pnp-0.6:timeranges

# Pages

„pages“ bieten die Möglichkeit, Grafiken von verschiedenen Hosts/Services auf einer Seite zusammenzufassen. Auf diese Weise können z.B. die Übertragungsraten der Netzwerk-Interfaces aller Tape-Libraries dargestellt werden. Innerhalb der Definitionen sind reguläre Ausdrücke möglich, so dass – entsprechende Namen vorausgesetzt - mit wenig Aufwand viel erreicht werden kann. Das Verzeichnis, das in `config.php` durch den Konfigurationseintrag „$conf['page_dir']“ angegeben wurde, enthält ein oder mehrere Dateien mit der Endung „.cfg“.

Kommentare beginnen mit einem '#' und sind auch innerhalb einer Zeile möglich. Jede Datei enthält eine „page“-Definition, die neben dem Namen der Seite festlegt, ob die nachfolgenden Grafikdefinitionen reguläre Ausdrücke enthalten.
Die Bezeichnung hinter `page_name` erscheint in der Liste der verfügbaren Seiten und wird als Titel im Browser angezeigt. Achtung: “host_name” und “service_desc” beziehen sich auf die Namen der Dateien im perfdata-Ordner, nicht auf die Nagios-Bezeichnungen. Leerzeichen werden durch Unterstriche (“_”) ersetzt.

    define  page  {
            use_regex 1		# 0 = keine regulären Ausdrücke, 1 = reguläre Ausdrücke
            page_name Test-Seite	# Beschreibung der Seite
    }

Danach folgen ein oder mehrere „graph“-Definitionen:

    define graph {
            host_name       host1,host2,host3
            service_desc    Current_Load
    }

Achtung: Damit die oben gezeigte Liste von Host-Namen funktioniert, muss `use_regex 0` gesetzt sein!

    define graph {
            host_name       host4
            service_desc    Current_Users
    }

Und jetzt mit regulären Ausdrücken. Zuerst alle Hosts, deren Name mit „Tape“ beginnen:

    define graph {
            host_name       ^Tape
            service_desc    Traffic
    }

alle Hosts, deren Namen mit “00” enden

    define graph {
            host_name       00$
            service_desc    Load
    }

alle Services des localhost, deren Namen ein „a“ oder „o“ enthalten:

    define graph {
            host_name       localhost
            service_desc    a|o
    }

alle Services, die im Namen nach einem „_“ (mindestens) drei Ziffern haben auf allen Hosts, deren Namen mit „UX“ beginnen:

    define graph {
            host_name       ^UX
            service_desc    _\d{3}
    }

zurück zur Übersicht | Datenexport

de:pnp-0.6:pages

# Datenexport

PNP bietet über den `xport` Controller Zugriff auf die RRD-Daten. Dabei kann das Ausgabeformat gewählt werden. Zur Zeit sind die Formate `xml`, `json` und `csv` realisiert.

Aufgerufen wird der Controller über die URL

    /pnp4nagios/xport/<format>?host=<hostname>&srv=<servicedesc>

wobei <format> durch das jeweils gewünschte Format zu ersetzen ist.

zurück zur Übersicht | Templates

de:pnp-0.6:xport

# Was sind Templates ?

PNP benutzt Templates, um das Aussehen der RRD-Graphen zu beeinflussen.

Dabei bestimmt das verwendete check_command, welches Template zur Darstellung herangezogen wird. Im Folgenden wird beschrieben, wo Templates gespeichert werden und wie die Entscheidung für das “richtige” Template getroffen wird.

## Wann wird welches Template verwendet ?

Templates werden an zwei Stellen im Dateisystem gespeichert.

- share/templates.dist - für Templates, die im PNP-Paket bereits enthalten sind.
- share/templates - für selbst erstellte Templates. Diese werden bei Updates nicht verändert.

Weiterhin können seit Version 0.6.5 weitere Template Verzeichnisse in der Config Datei `pnp4nagios/etc/config.php` hinzugefügt werden.

Soll der Graph für den Service “http” auf Host “localhost” angezeigt werden, so sucht PNP zuerst nach der XML-Datei `perfdata/localhost/http.xml` und liest diese ein. Diese XML-Dateien werden automatisch erstellt und enthalten Informationen zum jeweiligen Host und Service. Weiterhin enthält der Kopf Informationen über das Plugin und die Performance-Daten. Im folgenden Beispiel erkennt man anhand des XML-Tags `<TEMPLATE>`, welches PNP-Template für diesen Graphen verwendet werden soll.

`/localhost/http.xml`

    <NAGIOS>
      <DATASOURCE>
        <TEMPLATE>check_http</TEMPLATE>
        <DS>1</DS>
        <NAME>time</NAME>
        <UNIT>s</UNIT>
        <ACT>0.006721</ACT>
        <WARN>1.000000</WARN>
        <CRIT>2.000000</CRIT>
        <MIN>0.000000</MIN>
        <MAX></MAX>
      </DATASOURCE>
      <DATASOURCE>
        <TEMPLATE>check_http</TEMPLATE>
        <DS>2</DS>
        <NAME>size</NAME>
        <UNIT>B</UNIT>
        <ACT>263</ACT>
        <WARN></WARN>
        <CRIT></CRIT>
        <MIN>0</MIN>
        <MAX></MAX>
      </DATASOURCE>
    ...
    </NAGIOS>

PNP sucht nun nach einem Template mit dem Namen `check_http.php` in folgender Reihenfolge:

1. templates/check_http.php
2. templates.dist/check_http.php
3. templates/default.php
4. templates.dist/default.php

Das Template default.php nimmt somit eine Sonderstellung ein und wird immer verwendet, wenn vorher kein anderes Template gefunden wird.

## Eigene Templates erstellen

PNP-Templates sind PHP-Dateien, die zur Laufzeit von PNP über die PHP-Funktion include() eingebunden werden. Dies bedeutet, dass jeder PHP-Code in Templates interpretiert wird. Daher ist die Manipulation aller Werte über PHP möglich.

PNP-Templates müssen folgende Eigenschaften besitzen:

1. Templates müssen gültigen PHP-Code enthalten.
2. Templates dürfen keine Ausgabe erzeugen.
3. innerhalb der Templates werden die zwei Arrays $opt[] und $def[] gefüllt.

Die beiden PHP-Arrays $opt[] und $def[] zusammen bilden den Aufruf von `'rrdtool graph`'. Somit sind alle Optionen möglich, die RRDtool bietet. Die Optionen von RRDtool sind auf der RRDtool Homepage genauestens beschrieben.

Wenn beide Arrays mehrere Datensätze enthalten, so wird für jeden Datensatz ein Graph erstellt.

Weiterhin stehen innerhalb der Templates die Daten aus dem zugehörigen XML-File zur Verfügung, die zum Erstellen der Graphen wieder verwendet werden können.

Am Beispiel des recht einfachen Templates response.php lassen sich die wichtigsten Optionen recht gut beschreiben.

    <?php
    #
    $opt[1] = "--title \"Response Time For $hostname / $servicedesc\" ";
    #
    $def[1] =  "DEF:var1=$RRDFILE[1]:$DS[1]:AVERAGE " ;
    $def[1] .= "AREA:var1#00FF00:\"Response Times \" " ;
    $def[1] .= "LINE1:var1#000000 " ;
    $def[1] .= "GPRINT:var1:LAST:\"%3.4lg %s$UNIT[1] LAST \" ";
    $def[1] .= "GPRINT:var1:MAX:\"%3.4lg %s$UNIT[1] MAX \" ";
    $def[1] .= "GPRINT:var1:AVERAGE:\"%3.4lg %s$UNIT[1] AVERAGE \" ";
    ?>

`$opt[1] = ”–title …”` setzt RRDtool-Optionen für den ersten Datensatz im Array. Hier ist das der Titel des Graphen. Wie man sieht, werden eingebettete Anführungszeichen durch einen Backslash (\) maskiert. Die beiden Variablen `$hostname` und `$servicedesc` sind durch den Aufruf von PNP ermittelt worden und stehen nun auch im Template zur Verfügung.

`$def[1] = “DEF:var1=$RRDFILE[1]:$DS[1]:AVERAGE ”;` definiert, welche Daten aus welchem RRD-File gelesen werden sollen. $RRDFILE[1] enthält den Pfad zur RRD-Datei dieses Services. $DS[1] verweist auf die Datenreihe eins aus der RRD-Datei.

`$def[1] .= “AREA:var1#00FF00:\”Response Times \” ”;` durch den Operator ”.=” werden weitere Daten an das Array $def[1] angehängt. Gezeichnet wird eine Fläche (AREA) mit den Daten der Variable var1. Die Farbe wird im HEX-Code #00FF00 definiert. Als Beschriftung wird “Response Times” verwendet.

`$def[1] .= “LINE1:var1#000000 ”;` Als Abschluss der eben gezeichneten Fläche wird eine Linie (LINE1) in Schwarz (#000000) gezeichnet.

`$def[1] .= “GPRINT:var1:LAST:\”%3.4lg %s$UNIT[1] LAST \” ”;
$def[1] .= “GPRINT:var1:MAX:\”%3.4lg %s$UNIT[1] MAX \” ”;
$def[1] .= “GPRINT:var1:AVERAGE:\”%3.4lg %s$UNIT[1] AVERAGE \” ”;`

Die drei GPRINT Zeilen bilden die Legende des Graphen. Die aktuellen Werte werden dabei über die printf Syntax formatiert.

## Verfügbare Variablen

PNP speichert über den Datensammler `process_perfdata.pl` zur Laufzeit nicht nur Performancedaten, sondern auch weitere von Nagios exportierte Werte. Diese Werte werden in der jeweils für den Service gültigen XML-Datei gespeichert.

Im ersten Teil der XML-Datei werden die Performancedaten in ihre Einzelteile zerlegt gespeichert.

    <NAGIOS>
      <DATASOURCE>
        <TEMPLATE>check_http</TEMPLATE>
        <DS>1</DS>
        <NAME>time</NAME>
        <UNIT>s</UNIT>
        <ACT>0.006721</ACT>
        <WARN>1.000000</WARN>
        <CRIT>2.000000</CRIT>
        <MIN>0.000000</MIN>
        <MAX></MAX>
      </DATASOURCE>
    ...
    </NAGIOS>

Das Feld <DS> bezeichnet die DataSource und dient der Identifizierung der Datenreihen innerhalb der RRD-Dateien, ist aber auch der Schlüssel der folgenden Arrays.

Im Array `$UNIT[1]` ist somit die Einheit der ersten Datenreihe gespeichert.

Die XML-Datei enthält jedoch noch weitere Informationen. Wird `process_perdata.pl` im sync-Mode verwendet, so sind alle verfügbaren Makros mit den aktuellen Werten verfügbar. Der folgende Ausschnitt ist jedoch zu Gunsten der Lesbarkeit gekürzt.

    <NAGIOS>
    ...
      <NAGIOS_SERVICENOTIFICATIONID>8418</NAGIOS_SERVICENOTIFICATIONID>
      <NAGIOS_SERVICENOTIFICATIONNUMBER>0</NAGIOS_SERVICENOTIFICATIONNUMBER>
      <NAGIOS_SERVICEOUTPUT>HTTP OK HTTP/1.1 200 OK - 10087 bytes in 0.125 seconds</NAGIOS_SERVICEOUTPUT>
      <NAGIOS_SERVICEPERCENTCHANGE>0.00</NAGIOS_SERVICEPERCENTCHANGE>
      <NAGIOS_SERVICEPERFDATA>time=0.124811s;;;0.000000 size=10087B;;;0</NAGIOS_SERVICEPERFDATA>
      <NAGIOS_SERVICEPERFDATAFILE></NAGIOS_SERVICEPERFDATAFILE>
      <NAGIOS_SERVICEPROBLEMID>0</NAGIOS_SERVICEPROBLEMID>
      <NAGIOS_SERVICESTATE>OK</NAGIOS_SERVICESTATE>
      <NAGIOS_SERVICESTATEID>0</NAGIOS_SERVICESTATEID>
      <NAGIOS_SERVICESTATETYPE>HARD</NAGIOS_SERVICESTATETYPE>
      <NAGIOS_SHORTDATETIME>27-12-2007 13:51:23</NAGIOS_SHORTDATETIME>
    ...
    </NAGIOS>

Die einzelnen XML-Felder sind als Variablen in den PNP-Templates verwendbar, wobei jedes Feld als Variable gleichen Namens verfügbar ist.

Aus `<NAGIOS_SERVICEOUTPUT>` wird die Variable `$NAGIOS_SERVICEOUTPUT`.

zurück zur Übersicht | Custom Templates

de:pnp-0.6:tpl

# Custom Templates

Wie bereits unter ”Was sind Templates ?” beschrieben, ist die Darstellung der Graphen abhängig vom verwendeten Check-Command.

Es gibt jedoch Situationen, in denen dieses Verhalten übersteuert werden muss.

## CUSTOM_TEMPLATE

Notwendig wird dies, wenn allgemeingültige Commands definiert wurden.

Beispiel:

    define command {
      command_name check_nrpe
      command_line $USER1$/check_nrpe -H $HOSTADDRESS$ -C $ARG1$ -a "$ARG2$"
    }

Die Folge wäre, dass immer das Template check_nrpe.php verwendet werden würde, auch wenn auf dem zu überwachenden Server via NRPE ein ganz anderes Plugin aufgerufen wurde.

PNP, speziell process_perfdata.pl, sucht zur Laufzeit für jedes check_command im Verzeichnis etc/check_commands nach einer Config-Datei ( <check_command>.cfg ) und liest diese, wenn vorhanden, ein.

Da unser Beispiel-Command check_nrpe lautet, wird nach etc/check_commands/check_nrpe.cfg gesucht.

Eine Beispiel-Config wird bereits während der Installation mit der Dateierweiterung .cfg-sample in etc/check_commands gespeichert.

In diesen Config-Files können zwei Optionen gesetzt werden.

    # check_command check_nrpe!load!-w 4,4,4 -c 5,5,5
    # ________0__________|       |       |
    # ________1__________________|       |
    # ________2__________________________|
    #
    CUSTOM_TEMPLATE = 1

`CUSTOM_TEMPLATE = 1` sorgt dafür, dass nur der Inhalt von $ARG1$ als Template-Name verwendet wird. Da in diesem Beispiel $ARG1$ mit dem Wert “load” gefüllt ist, ergibt sich als Template-Name “load.php”

`CUSTOM_TEMPLATE = 0,1` ergibt → “check_nrpe_load.php”

`CUSTOM_TEMPLATE = 1,0` ergibt → “load_check_nrpe.php”

## DATATYPE

Über die Option “DATATYPE” kann beeinflusst werden, mit welchem Datentyp die RRD-Datenbank angelegt werden soll. Default ist in diesem Fall “GAUGE”. Für fortlaufende Werte wird aber hier der Datentyp COUNTER benötigt. Normalerweise sollten Plugin-Entwickler für Daten von Typ Counter die Einheit “c” verwenden. Dies ist jedoch nicht immer der Fall.

Alle Datenreihen auf Typ COUNTER einstellen.

    DATATYPE = COUNTER

Einzelnen Datenreihen spezielle Datentypen zuweisen

    DATATYPE = GAUGE,GAUGE,COUNTER,COUNTER

Diese Option hat nur Einfluss, wenn die RRD Datenbank neu erstellt wird.

Weitere Datentypen sind in der RRDTool-Dokumentation unter rrdcreate erklärt.

## MIN und MAX

In einigen wenigen Situationen ist es notwendig, die für RRDTool gültigen Daten zu begrenzen.

RRD-Datenbanken lassen sich mit definierten Minimum- und Maximum-Werten anlegen. Weitere Infos unter http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html

Berücksichtigen des Maximum-Wertes aus den Performance-Daten

    USE_MAX_ON_CREATE = 1

Berücksichtigen des Minimum-Wertes aus den Performance-Daten

    USE_MIN_ON_CREATE = 1

## RRD_STORAGE_TYPE

    RRD_STORAGE_TYPE = SINGLE

Die Option RRD_STORAGE_TYPE definiert die Art der Datenhaltung.

Mögliche Werte sind MULTIPLE und SINGLE

SINGLE: Eine RRD-Datenbank pro Service

MULTIPLE: Ein oder mehrere RRD-Datenbanken pro Service. Für jede Datenreihe wird eine eigene RRD-Datenbank erstellt.

ACHTUNG: Daten werden nicht automatisch migriert!
Ein Konvertierungs-Script finden Sie hier.

## RRD_HEARTBEAT

Gültig ab PNP 0.6.1

    RRD_HEARTBEAT = 305

Nach <RRD_HEARTBEAT> Sekunden erwartet RRDtool neue Daten.

Mehr dazu unter http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html

zurück zur Übersicht | PNP in verteilten Umgebungen

de:pnp-0.6:tpl_custom

# Advanced

## Verteilte Systeme

Ist Nagios als verteiltes System implementiert, stellt sich die Frage, wo PNP installiert wird.

Rein technisch ist diese Frage nicht wichtig. PNP kann auf den Slaves sowie auf dem Master-Server installiert sein. Oder nur auf dem Master?

Wird PNP auf dem Master betrieben, ist jedoch bei der Übergabe der Daten via send_nsca von den Slave-Servern zum Master darauf zu achten, dass auch die Performance-Daten übergeben werden. Weiterhin kommt auf dem Master oft nicht das Original-Check-Command zum Einsatz.

Damit nun aber PNP auf dem Master noch erkennen kann, welches Check-Command auf den Slaves die Daten ermittelt hat, reagiert process_perfdata.pl auf ein zusätzliches Feld am Ende der Performance-Daten.

    OK - 127.0.0.1: rta 2.687ms, lost 0% | rta=2.687ms;3000.000;5000.000;0; pl=0%;80;100;; [check_icmp]

Findet PNP am Ende der Performance Daten einen in eckigen Klammern eingeschlossenen Text, so wird dieser als Check-Command und somit als PNP-Template verwendet.

Die Nagios-Dokumentation zu diesem Thema ist hier zu finden. Das in der Doku verwendete Command ist leicht anzupassen.

Aus

    define command{
    	command_name	submit_check_result
    	command_line	/usr/local/nagios/libexec/eventhandlers/submit_check_result $HOSTNAME$ '$SERVICEDESC$' $SERVICESTATE$ '$SERVICEOUTPUT$'
    	}

wird

    define command{
    	command_name	submit_check_result
    	command_line	/usr/local/nagios/libexec/eventhandlers/submit_check_result $HOSTNAME$ '$SERVICEDESC$' $SERVICESTATE$ '$SERVICEOUTPUT$ | $SERVICEPERFDATA$ [$SERVICECHECKCOMMAND$]'
    	}

## Das check_multi-Plugin

Das Plugin check_multi ist eines der ersten Plugins, das die Funktionen von Nagios 3.0 richtig ausschöpft. Check_Multi ist in der Lage, mehrere Nagios-Plugins auszuführen, aber für Nagios als einen Service darzustellen. Die Ausgabe von check_multi erfolgt über mehrere Zeilen, um die Masse an Informationen wieder darstellen zu können.

Daraus ergaben sich jedoch einige Schwierigkeiten für PNP. PNP muss aus den Performance-Daten wieder die Daten der einzelnen Plugins ermitteln können. Zusammen mit Matthias Flacke, dem Entwickler von check_multi, haben wir jedoch recht schnell eine Möglichkeit gefunden, die Daten wieder sauber den einzelnen Plugins zuzuordnen.

Zurück zur Übersicht | rrdcached-Unterstützung

de:pnp-0.6:advanced

# RRDtool Cache Daemon

In großen Installationen wird man über kurz oder lang feststellen, dass die Verarbeitung der Performance-Daten eine recht hohe I/O-Last zur Folge hat. RRDtool muss extrem viele Updates auf Disk schreiben, kann dabei jedoch den Disk-Cache nicht optimal ausnutzen.

Eine Optimierung stellt das Sammeln und Sortieren der Daten dar. Es ist für das System effektiver, viele Updates im Block in eine RRD-Datenbank zu schreiben. Der Disk-Cache kann dabei effektiver genutzt werden.

In der aktuellen RRDtool-Version ( SVN trunk 1550+ ) ist der rrdcached enthalten, der genau diese Situation verbessern soll.

An dieser Stelle möchte ich mich bei Florian octo Forster, Kevin Brintnall und Tobi Oetiker bedanken. Die Entwicklung dieses Daemons wurde vorbildlich auf der rrd-developers Mailingliste koordiniert.

## Arbeitsweise

Der rrdcached arbeitet als Daemon im Hintergrund und öffnet einen UNIX- oder TCP-Socket, auf dem er auf Anfragen von rrdtool wartet. Aufgrund von Sicherheitsbedenken ist es in neueren Versionen von rrdcached aber nicht mehr möglich absolute Pfadangaben (wie bei pnp4nagios üblich) bei Netzwerkzugriffen zu verwenden, daher ist derzeit nur Nutzung von UNIX-Sockets möglich.

### rrdcached

Der rrdcached kennt einige wichtige Optionen, die beim Start übergeben werden.

Option -l definiert den Socket, auf dem der rrdcached Requests annimmt. Der Default-UDP-Port ist 42217, der Default-UNIX-Socket /tmp/rrdcached.sock.

    -l unix:/pfad/zum/rrdcached.sock
    -l /pfad/zum/rrdcached.sock
    -l 127.0.0.1
    -l 127.0.0.1:8888

Option -P gibt die für die nachfolgenden Sockets (mit -l spezifiziert) erlaubten Befehle an, welche auf die RRD-Datenbanken angewendet werden können.

    -P FLUSH,PENDING

Option -s erlaubt es die Gruppenzugehörigkeit der nachfolgenden UNIX-Sockets zu ändern.

    -s nagios

Option -m setzt die Zugriffsrechte für die nachfolgenden UNIX-Sockets auf die (in oktal) angegebenen Werte.

    -m 0660

Option -w bestimmt den Intervall in Sekunden, in dem die Daten auf Disk geschrieben werden sollen.

    -w 1800

Option -z definiert einen Delay, der die über die Option -w definierten Schreibzyklen in einen zufälligen Bereich [0-delay] verteilt, um gleichzeitige Schreibzugriffe zu verhindern. Der Wert der Option -z darf nicht größer gewählt werden als -w.

    -z 1800

Option -p definiert ein PID File

    -p /var/run/rrdcached.pid

Option -j definiert den Pfad zu einem Journal-Verzeichnis. Dort werden alle Aufträge protokolliert und ggf. beim nächsten Start nachgefahren, falls der rrdcached-Daemon abstürzt.

    -j /var/cache/rrdcached

Daraus ergibt sich beispielsweise ein Aufruf von rrdached mit folgenden Parametern

     rrdcached -w 1800 -z 1800 -p /tmp/rrdcached.pid -j /tmp -s nagios -m 0660 -l unix:/tmp/rrdcached.sock

### rrdtool

RRDtool selbst wird die Existenz des Daemons über die Option –daemon=<socket> mitgeteilt.

     rrdtool --daemon=unix:/tmp/rrdcached.sock update ...

Dies muss natürlich mit den Startoptionen des rrdcached übereinstimmen!

## Integration in PNP

Da zwei Bestandteile von PNP auf den rrdcached vorbereitet werden müssen, ergeben sich Änderungen in zwei Config-Files. Außerdem muß der User unter welchem der Webserver läuft zur Gruppe unter der Nagios läuft hinzugefügt werden.

1. Anpassen der `process_perfdata.cfg` für den Datensammler `process_perfdata.pl`

    # EXPERIMENTAL rrdcached Support
    # Use only with rrdtool svn revision 1511+
    #
    RRD_DAEMON_OPTS = unix:/var/run/rrdcached.sock

2. Anpassen der `config_local.php` (bzw. config.php) für das Webinterface

    #
    # EXPERIMENTAL rrdcached Support
    # Use only with rrdtool svn revision 1511+
    #
    # $conf['RRD_DAEMON_OPTS'] = 'unix:/tmp/rrdcached.sock';
    $conf['RRD_DAEMON_OPTS'] = 'unix:/var/run/rrdcached.sock';

Die passenden Optionen sind bereits in den Beispieldateien enthalten.

zurück zur Übersicht | migrieren von RRD-Dateien

de:pnp-0.6:rrdcached

# NPCD

NPCD (Nagios-Perfdata-C-Daemon) wurde geschrieben, um die asynchrone Bearbeitung von Nagios Performance-Daten zu ermöglichen.

## Einleitung

In großen Nagios-Installationen kann es zu nicht akzeptierbaren Verspätungen seitens der Checks kommen. Das bedeutet, dass Nagios einen Check zum Zeitpunkt `x` ausführen soll, diesen aber erst `y` Sekunden später tatsächlich ausführt.

Wenn man dem Nagios-Daemon mitteilt, dass man nach jedem einzelnen Check auch die Performance-Daten verarbeiten möchte, so geht dies bis zu einem bestimmten Grad gut, ab einer gewissen Anzahl von Checks pro Sekunde allerdings kommt man relativ schnell zu den sog. Latency-Problemen.

Um die Anzahl der Aktionen pro Check zu verringern, kann man nun PNP im Bulk-Mode verwenden, wobei die Performance-Daten zunächst vom Nagios-Prozess gesammelt und anschließend ebenfalls vom Nagios-Prozess selbst verarbeitet werden.

Man kann aber auch dem Nagios-Prozess mitteilen, dass die Verarbeitung der Performance-Daten lediglich durch das Verschieben der Dateien in ein Spool-Verzeichnis geschehen soll, welches für den Nagios-Prozess selbst eine sehr schnelle Aktion ist und die Performance nicht nennenswert beeinflusst und somit dem Core mehr Zeit für seine eigentliche Arbeit lässt: weitere Checks ausführen, Alamierungen bereitstellen, etc.

## Wie NPCD arbeitet

Wie bereits erwähnt, ist die Arbeit der Performance-Daten-Verarbeitung durch das schnelle Verschieben der Datei bereits erledigt, aber das bringt die Performance-Daten noch nicht in die RRD-Datenbank.

Um den Transport der Performance-Daten-Dateien kümmert sich nun der NPCD-Daemon, unabhängig vom Nagios-Prozess, indem er regelmäßig in das Spool-Verzeichnis guckt und für jede dort gefundene Datei eine Aktion ausführt.

Nachdem NPCD gestartet wurde, erstellt er sich eine Liste von Dateinamen des Spool-Verzeichnisses und startet für jede gefundene Datei einen Thread zur weiteren Verarbeitung mit Hilfe des `perfdata_file_run_cmd` und dem optionalen `perfdata_file_run_cmd_arg` als zusätzlichem Argument.

Da das Format der Performance-Daten-Dateien dem Format der 'normalen' PNP-Bulk-Modus-Dateien gleicht, kann NPCD nun für jede gefundene Datei also `process_perfdata.pl` im Bulk Modus aufrufen.

## Vor- und Nachteile

Pro:

- bessere Performance für Nagios
  - aufgrund der vom Nagios-Prozess getrennten Verarbeitung der Performance-Daten hat Nagios mehr Zeit für die wichtigen Dinge
- kein Datenverlust
  - solange Nagios Performance-Daten-Dateien im Spool-Verzeichnis ablegt, gehen keine Daten verloren. Selbst wenn der NPCD mal nicht laufen sollte (Bsp. nach Neustart des Systems), werden die Dateien nach Wiederanlauf in chronologischer Reihenfolge bearbeitet ($TIMET$ Makro beim verschieben ins Spool-Verzeichnis)

Kontra:

- Keine Echtzeitverarbeitung der Performance-Daten
  - aufgrund des Rhythmusses, wann Nagios die Performance-Daten-Dateien verschiebt (`service_perfdata_file_processing_interval`)
  - nach jedem Lauf durch alle Dateien des Spool-Verzeichnisses wartet NPCD 10 Sekunden lang auf neue Dateien

# NPCD Config

NPCD muss zwangsläufig über eine Konfigurationsdatei gesteuert werden. Eine Beispielkonfiguration liegt der PNP-Installation als `npcd.cfg-sample` bei.

Nach Umbenennen der `-sample` Datei zu `npcd.cfg` kann NPCD nun wie folgt gestartet werden:

    /usr/local/pnp4nagios/bin/npcd -f /usr/local/pnp4nagios/etc/npcd.cfg

oder

    /usr/local/pnp4nagios/bin/npcd -d -f /usr/local/pnp4nagios/etc/npcd.cfg

um NPCD im Hintergrund als Daemon laufen zu lassen.

Hinweis: Die `-sample` Datei sollte in jedem Fall in `npcd.cfg` umbenannt werden, da sie sonst bei einem Update von PNP überschrieben werden könnte.

## npcd.cfg-sample

Dies sind die essentiellen Konfigurationsdirektiven für NPCD:

    # Privilege Options
    user = nagios
    group = nagios

    # Logging Options
    log_type = syslog
    log_file = /usr/local/pnp4nagios/var/npcd.log
    max_logfile_size = 10485760
    log_level=0

    # Processing Options
    perfdata_spool_dir = /usr/local/pnp4nagios/var/spool/perfdata/
    perfdata_file_run_cmd = /usr/local/pnp4nagios/libexec/process_perfdata.pl
    perfdata_file_run_cmd_args = -b

    # Thread Options
    npcd_max_threads=5

    # greedy options
    use_load_threshold = 0
    load_threshold = 10.0

    # Process Options
    pid_file=/var/run/npcd.pid

## Die Direktiven

- Privilege-Optionen
  - user <username>
    - NPCD versucht die Userberechtigung zu diesem User zu wechseln.
    - Default: nagios
  - group <groupname>
    - NPCD versucht die Gruppenberechtigung zu dieser Gruppe zu wechseln.
    - Default: nagios
- Logging-Optionen
  - log_type <syslog> oder <file>
    - Log-Type, den NPCD zum Loggen verwenden wird
    - Default: syslog
  - log_file </pfad/zu/datei>
    - Falls `log_type = file` wird diese Logdatei verwendet
    - Default: /usr/local/pnp4nagios/var/npcd.log
  - max_logfile_size <bytes>
    - NPCD wird nach Erreichen der hier angegebenen Dateigröße eigenständig eine Logrotation durchführen
    - Default: 10485760 = 10 MByte
  - log_level <integer>
    - Wie viel soll aufgezeichnet werden, möglich ist:
      - 0 = Kein Log - außer Fehlern
      - 1 = wenig Log - etwas mehr Aufzeichnen
      - 2 = Mehr Log (aktuell ALLES)
      - -1 = DEBUG Mode - Es wird alles aufgezeichnet und die Bearbeitung wird verlangsamt
    - Default: 0
- Bearbeitungs-Optionen
  - perfdata_spool_dir </path/to/spool/dir/>
    - Das Verzeichnis, in das Nagios die Dateien verschiebt
    - Default: /usr/local/pnp4nagios/var/spool/
  - perfdata_file_run_cmd </path/to/bin/filename>
    - Das Programm, welches Nagios für jede Datei aufrufen soll
    - Default: /usr/local/pnp4nagios/libexec/process_perfdata.pl
  - perfdata_file_run_cmd_args <option>
    - Das Argument, welches optional an `perfdata_file_run_cmd` angehängt wird
    - Default: ”-b”
    - Die Kommandozeile wird nach folgendem Schema aufgebaut:

          <perfdata_file_run_cmd> <perfdata_file_run_cmd_args> <filename_from_perfdata_spool_dir>

- Thread-Optionen
  - npcd_max_threads <integer value>
    - Anzahl der maximal zu startenden parallelen Threads
    - Default: 5
- Greedy-Optionen
  - use_load_threshold <0 oder 1>
    - definiert, ob NPCD bei Erreichen des load_thresholds die Anzahl der Threads begrenzen soll
      - 0 = ausschalten (weitere Threads starten)
      - 1 = einschalten
    - Default: 0
  - load_threshold <float value>
    - wenn `use_load_threshold` auf 1 gesetzt ist, werden bei Erreichen dieses load limits keine neuen Threads gestartet
    - Default: 10.0
- Process-Optionen
  - pid_file </path/to/pid.file>
    - Pfad zum PID File
    - Default: /var/run/npcd.pid

zurück zur Übersicht | Wrapper-Script

de:pnp-0.6:npcd

check_procs ist ein Beispiel für ein Plugin, das keine Performance-Daten ausgibt:

    ./check_procs -a ndo2db -w 1: -c 0:
    PROCS OK: 2 processes with args 'ndo2db'

Mit dem folgenden Wrapper-Script kann das geändert werden

check_procs.sh

    #!/bin/bash
    LINE=`/usr/local/nagios/libexec/check_procs $*`
    RC=$?
    COUNT=`echo $LINE | awk '{print $3}'`
    echo $LINE \| procs=$COUNT
    exit $RC

Nun wird die Zahl zusammen mit einer Bezeichnung ausgegeben.

    ./check_procs.sh -a ndo2db -w 1: -c 0:
    PROCS OK: 2 processes with args 'ndo2db'| procs=2

de:pnp-0.6:wrapper

2.6. Performance-Daten

Performance-Daten von Nagios sind definiert als “alles hinter dem | des Plugin-Outputs” - nähere Einzelheiten dazu, wie diese Daten in Logfiles umgeleitet werden, gibt es in der Nagios-Dokumentation. Trotz allem ist es die Aufgabe des Plugin-Schreibers, dass die Performance-Daten in einem “Nagios-Plugin”-Format vorliegen. Dies ist das erwartete Format:

'Bezeichnung'=Wert[UOM];[warn];[crit];[min];[max]

Anmerkungen:

1. Leerzeichen trennen Listen von Bezeichnung/Werte-Paaren
2. Bezeichnungen können beliebige Zeichen enthalten
3. die Bezeichnung muss in Apostrophs eingeschlossen sein, wenn diese = oder Leerzeichen enthält, ansonsten sind die Apostrophs optional
4. die Länge der Bezeichnung ist beliebig, aber idealerweise sind die ersten 19 Zeichen eindeutig (aufgrund einer Beschränkung in RRD). Bitte beachten Sie, dass es eine Längenbegrenzung bei der Menge von Daten gibt, die von NRPE an Nagios geliefert werden kann
5. um ein Apostroph darzustellen, nutzen Sie zwei einzelne Apostrophs
6. warn, crit, min und/oder max können leer sein (z.B. wenn der Schwellwert nicht definiert ist oder wenn min oder max nicht zutreffen). Nachfolgende, nicht gefüllte Semikola können entfallen
7. min und max sind nicht erforderlich, wenn UOM = %
8. Wert, min und max sind aus der Klasse [-0-9.] (Ziffern, Minuszeichen und Dezimalpunkt). Alle müssen das gleiche UOM benutzen
9. warn und crit sind im “Range”-Format (siehe Abschnitt 2.5 der Original-Dokumentation). Alle müssen das gleiche UOM benutzen.
10. UOM (unit of measurement, Maßeinheit) ist eins von:
    - keine Einheit angegeben - angenommen wird eine Zahl (int oder float) von Dingen (z.B. Benutzer, Prozesse, Load)
    - s - Sekunden (auch us, ms)
    - % - Prozent
    - B - Bytes (auch KB, MB, TB; GB?)
    - c - ein fortlaufender Zähler (z.B. Bytes, die über ein Interface übertragen werden)

Es bleibt Drittanbietern überlassen, aus den Performance-Daten Graphen zu erzeugen.

Quelle: http://nagiosplug.sourceforge.net/developer-guidelines.html#AEN201

de:pnp-0.6:perfdata_format