Icinga
11.3. Keine Icinga API mehr zu installieren
Zurück  Kapitel 11. Entwicklung  Weiter

11.3. Keine Icinga API mehr zu installieren

11.3.1. Installation und Benutzung der Icinga API
11.3.2. Konfiguration
11.3.3. Unterstützte Backends
[Wichtig] Wichtig

In der Zeit vor dem Release der Version 1.5 sagten wir unserer Icinga API "Tschüss" und führten ein neues API- und Web-Konzept ein.

Sie fragen sich vielleicht, was war diese API überhaupt? In der Tat, wenn Sie keine Erweiterungen oder Anpassungen für das neue Web-Interface entwickelt haben, dann hatten Sie wahrscheinlich wenig Kontakt mit dieser wichtigen Projektkomponente. Als Icinga konzipiert wurde, war eines der Hauptziele die Unterstützung der Entwicklung von Addons und Plugins. Die API stellte einen Satz von allgemein verwendbaren Abfragebefehlen zur Verfügung, um die Notwendigkeit zu beseitigen, SQL-Abfragen und generell eine Menge überflüssigen Code zu schreiben.

Alles war in Ordnung, bis wir uns entschieden, etwas mehr zusätzliche Datenbankflexibilität anzubieten. Als wir neben MySQL Unterstützung für Oracle and PostgreSQL hinzufügten, gaben wir auch dem Icinga API-Team etwas zusätzliche Arbeit. Mit jeder Änderung, jedem Bugfix oder neuer Funktionalität mussten Marius, Michael L und Jannis die Abfragen für jedes Datenbank-Backend separat anpassen. Dieser Prozess war nicht nur kompliziert und fehlerbehaftet, sondern auch ein Zeichen dafür, dass wir eine neue flexiblere Architektur benötigten.

Mit Icinga 1.5 wurde die externe Icinga API durch eine interne Datenbankschicht namens Doctrine ersetzt und mit Icinga Web verschmolzen. Ähnlich wie vorher laufen Abfragen durch diese Schicht zwischen der Datenbank (IDOUtils) und dem Web-Interface. Trotzdem können wir dank Doctrine mehrere Datenbank-Backends benutzen und das Abfragen der Datenbank ist nun viel einfacher. Im Gegensatz zu SQL nutzt der "object relational mapper" (ORM) die Doctrine Query Language, so dass wir nun die Flexibilität ohne die Code-Duplizierung haben.

Allerdings funktionieren Abfragen mit der alten API nach wie vor, dank des 'Legacy Layer', der alte API-Abfragen in diesen neuen ORM-Typ umwandelt. Auf diese Weise erhalten wir die Kompatibilität mit Addons, die für ältere Icinga-Versionen erstellt wurden. Das Rest-API ist also weiterhin vorhanden als ein Teil von Icinga Web, und erweitert unsere Doctrine-Schicht mit HTTP für Addons, die nur bestimmte Teile der Überwachungsinformationen benötigen.

Durch den Wegfall einer eigenständigen API wird der durchschnittliche Icinga-Benutzer kaum einen Unterschied bemerken, außer der Tatsache, dass die Konfiguration nun in die databases.xml verschoben wurde. Das Beste daran ist, dass jeder Modul-Entwickler nun einfach, ohne viel Code-Overhead, auf die Icinga-Datenbank zugreifen kann- also Adddon-Entwickler, legt los!

[Wichtig] Wichtig

Das Folgende ist veraltet

11.3.1. Installation und Benutzung der Icinga API

11.3.2. Konfiguration

Wenn Sie Ihr eigenes Addon auf Basis der Icinga API entwickeln möchten, benötigen Sie das folgende assoziative Array:

 $idoConfig = array (
    'type'         => '<Type of database>',
    'host'         => '<Database hostname>', 
    'database'     => '<Databasename>',
    'user'         => '<Username>',
    'password'     => '<password>',
    'persistent'   => <true | false>,
    'table_prefix' => '<table prefix>', 
 );

Beispiel:

 $idoConfig = array (
    'type'         => 'mysql',
    'host'         => 'localhost',
    'database'     => 'ido',
    'user'         => 'idouser',
    'password'     => 'idopassword',
    'persistent'   => true,
    'table_prefix' => 'icinga_',
 );

11.3.3. Unterstützte Backends

Aktuell sind folgende Backend Typen verfügbar. Mehr Information finden Sie unter doc/icinga-api-types.txt.

Benutzung

  1. Datenermittlung

    Host-Namen und zugehörige Zustände

    Erzeugen Sie eine Instant der Klasse IcingaApi:

     $api = IcingaApi::getConnection(IcingaApi::CONNECTION_IDO, $idoConfig);

    Erzeugen Sie die Suchkriterien:

     $apiRes = $api->createSearch()
 ->setSearchTarget(IcingaApi::TARGET_HOST)
 ->setResultColumns(array('HOST_NAME', 'HOST_CURRENT_STATE'))
 ->fetch();

    Mit Hilfe von setSearchFilter() können Sie Filter benutzen, um die Suche einzuschränken:

     $apiRes = $api->createSearch()
 ->setSearchTarget(IcingaApi::TARGET_HOST)
 ->setResultColumns(array('HOST_NAME', 'HOST_CURRENT_STATE'))
 ->setSearchFilter(HOST_NAME, 'Switch%', IcingaApi::MATCH_LIKE)
 ->fetch();

  2. Verarbeiten der Ergebnisse

     foreach($apiRes as $apiHandle){
    echo 'Host '.$apiHandle->HOST_NAME.' has state '.$apiHandle->HOST_CURRENT_STATE.'<br />';
 }

    Ausgabe ohne Filter:

     Host localhost has state 0
 Host MySql has state 0
 Host router-01 has state 0
 Host windows100 has state 0
 Host Apache_01 has state 0

    Ausgabe mit Filter:

     Host switch70 has the current state 0
 Host switch71 has the current state 0
 Host switch72 has the current state 0
 Host switch73 has the current state 0
 Host switch74 has the current state 0
 Host switch75 has the current state 0
 Host switch76 has the current state 0
 Host switch77 has the current state 0

  3. Kompletter Code ohne die Nutzung von Filtern

     <?
 // Path to icinga api file
 $apiFile = 'icinga-api/IcingaApi.php';
 
 // Database connection
 $idoConfig = array (
    'type'         => 'mysql',
    'host'         => 'localhost',
    'database'     => 'ido',
    'user'         => 'idouser',
    'password'     => 'idopassword',
    'persistent'   => true,
    'table_prefix' => 'icinga_',
 );
 
 // Include required files
 require_once($apiFile);
 
 // Instance the class
 $api = IcingaApi::getConnection(IcingaApi::CONNECTION_IDO, $idoConfig);
 
 // Create search
 $apiRes = $api->createSearch()
 ->setSearchTarget(IcingaApi::TARGET_HOST)
 ->setResultColumns(array('HOST_NAME', 'HOST_CURRENT_STATE'))
 ->fetch();
 
 // Create output
 foreach($apiRes as $apiHandle){
    echo 'Host '.$apiHandle->HOST_NAME.' has the current state '.$apiHandle->HOST_CURRENT_STATE.'<br />';
 }
 ?>

    Für nähere Informationen werfen Sie bitte einen Blick in das git repository oder die Beispiele im doc/examples-Verzeichnis.

Zurück  Nach oben  Weiter
11.2. Entwickeln von Plugins für die Nutzung mit Embedded Perl  Zum Anfang  11.4. Die Icinga Web REST API

© 1999-2009 Ethan Galstad, 2009-2017 Icinga Development Team, https://www.icinga.com