Zend_Log_Writer_Stream sendet Log Daten in einen PHP Stream.

Um Log Daten in den PHP Ausgabebuffer zu schreiben, muß die URL php://output verwendet werden. Alternativ können Log Daten direkt an einen Stream wie z.B. STDERR (php://stderr) gesendet werden.

$writer = new Zend_Log_Writer_Stream('php://output');
$logger = new Zend_Log($writer);

$logger->info('Informational message');

Um Daten in eine Datei zu schreiben, muß eine der Dateisystem URLs verwendet werden:

$writer = new Zend_Log_Writer_Stream('/path/to/logfile');
$logger = new Zend_Log($writer);

$logger->info('Informative Nachricht');

Standardmäßig wird der Stream im Anhänge-Modus geöffnet ("a"). Um Ihn in einem anderen Modus zu öffnen, akzeptiert der Zend_Log_Writer_Stream Konstruktor einen optionalen zweiten Parameter für den Modus.

Der Konstruktor von Zend_Log_Writer_Stream akzeptiert auch eine existierende Stream Ressource:

$stream = @fopen('/path/to/logfile', 'a', false);
if (! $stream) {
    throw new Exception('Stream konnte nicht geöffnet werden');
}

$writer = new Zend_Log_Writer_Stream($stream);
$logger = new Zend_Log($writer);

$logger->info('Informative Nachricht');

Der Modus kann für existierende Stream Ressourcen nicht definiert werden. Wenn das gemacht versucht wird, wird eine Zend_Log_Exception geworfen.

Zend_Log_Writer_Db schreibt Log Informationen in eine Datenbank Tabelle wobei Zend_Db verwendet wird. Der Konstrukor von Zend_Log_Writer_Db benötigt eine Zend_Db_Adapter Instanz, einen Tabellennamen, und ein Abbild der Datenbankspalten zu den Elementen der Eventdaten:

$params = array ('host'     => '127.0.0.1',
                 'username' => 'malory',
                 'password' => '******',
                 'dbname'   => 'camelot');
$db = Zend_Db::factory('PDO_MYSQL', $params);

$columnMapping = array('lvl' => 'priority', 'msg' => 'message');
$writer = new Zend_Log_Writer_Db($db, 'log_table_name', $columnMapping);

$logger = new Zend_Log($writer);

$logger->info('Informative Nachricht');

Das obige Beispiel schreibt eine einzelne Zeile von Log Daten in einem Datenbanktabelle welche 'log_table_name' Tabelle benannt wird. Die Datenbankspalte welche 'lvl' benannt ist empfängt die Nummer der Priorität und die Spalte welche 'msg' benannt ist empfängt die Log Nachricht.

Zend_Log_Writer_Firebug sendet Logdaten an die Firebug Console.

Alle Daten werden über die Zend_Wildfire_Channel_HttpHeaders Komponente gesendet welche HTTP Header verwendet um sicherzustellen das der Seiteninhalt nicht verändert wird. Das Debuggen von AJAX Anfragen die klare JSON und XML Antworten benötigen ist mit diesem Vorgehen möglich.

Notwendigkeiten:

// In der Bootstrap Datei platzieren bevor der Frontcontroller ausgeführt wird
$writer = new Zend_Log_Writer_Firebug();
$logger = new Zend_Log($writer);

// Verwende das in den Modell, View, und Controller Dateien
$logger->log('Das ist eine Lognachricht!', Zend_Log::INFO);

$writer = new Zend_Log_Writer_Firebug();
$logger = new Zend_Log($writer);

$request = new Zend_Controller_Request_Http();
$response = new Zend_Controller_Response_Http();
$channel = Zend_Wildfire_Channel_HttpHeaders::getInstance();
$channel->setRequest($request);
$channel->setResponse($response);

// Ausgabe buffering starten
ob_start();

// Jetzt können Aufrufe an den Logger durchgeführt werden
$logger->log('Das ist eine Lognachricht!', Zend_Log::INFO);

// Logdaten an den Browser senden
$channel->flush();
$response->sendHeaders();

$logger->addPriority('FOO', 8);
$writer->setPriorityStyle(8, 'TRACE');
$logger->foo('Foo Nachricht');

$writer->setDefaultPriorityStyle('TRACE');

$exception = new Zend_Exception('Test Ausnahme');
$logger->err($exception);

$writer->setPriorityStyle(8, 'TABLE');
$logger->addPriority('TABLE', 8);

$table = array('Summary line for the table',
               array(
                   array('Spalte 1', 'Spalte 2'),
                   array('Zeile 1 c 1','Zeile 1 c 2'),
                   array('Zeile 2 c 1',' Zeile 2 c 2')
               )
         );
$logger->table($table);

Zend_Log_Writer_Mail schreibt Logeinträge in eine Email Nachricht indem es Zend_Mail verwendet. Der Konstruktor von Zend_Log_Writer_Mail nimmt ein Zend_Mail Objekt und ein optionales Zend_Layout Objekt entgegen.

Der primäre Verwendungszweck für Zend_Log_Writer_Mail ist es Entwickler, System Administratoren, oder jede benötigte Partei über Fehler zu benachrichtigen die mit PHP-basierenden Skripten auftreten können. Zend_Log_Writer_Mail wurde aus der Idee geboren das, wenn irgendetwas fehlschlägt, ein Mensch sofort darüber alarmiert werden muß um korrigierende Maßnahmen durchzuführen.

Die grundsätzliche Verwendung wird anbei gezeigt:

$mail = new Zend_Mail();
$mail->setFrom('errors@example.org')
     ->addTo('project_developers@example.org');

$writer = new Zend_Log_Writer_Mail($mail);

// Setzt den Subjekt-Text der verwendet wird; Zusammenfassung der Anzahl der
// Fehler wird der Subjektzeile angefügt bevor die Nachricht gesendet wird.
$writer->setSubjectPrependText('Errors with script foo.php');

// Nur Einträge vom Level Warnung und höher schicken
$writer->addFilter(Zend_Log::WARN);

$log = new Zend_Log();
$log->addWriter($writer);

// Irgendetwas schlechtes findet statt!
$log->error('Kann nicht zur datenbank verbinden');

// Wenn der Writer heruntergefahren wird, wird Zend_Mail::send()
// getriggert um ein Email mit allen Logeinträgen zu senden die
// auf oder über dem Filterlevel von Zend_Log liegen

Zend_Log_Writer_Mail stellt den Email Body standardmäßig als reinen Text dar.

Es wird eine Email gesendet die alle Logeinträge enthält die auf oder über dem Filterlevel sind. Wenn zum Beispiel, Einträge mit Warnungs-Level gesendet werden sollen, und zwei Warnungen und fünf Fehler stattfinden, wird das Email in Summe sieben Logeinträge enthalten.

$mail = new Zend_Mail();
$mail->setFrom('errors@example.org')
     ->addTo('project_developers@example.org');
// Beachte das die Subjektzeile nicht auf der Zend_Mail
// Instanz gesetzt wird!

// Verwende eine einfache Zend_Layout Instanz mit seinen Standardwerten
$layout = new Zend_Layout();

// Erstelle einen Formatierer der den Eintrag in ein Listitem Tag umhüllt
$layoutFormatter = new Zend_Log_Formatter_Simple(
    '<li>' . Zend_Log_Formatter_Simple::DEFAULT_FORMAT . '</li>'
);

$writer = new Zend_Log_Writer_Mail($mail, $layout);

// Füge den Formatierer für die Einträge hinzu die mit Zend_Layout
// dargestellt werden
$writer->setLayoutFormatter($layoutFormatter);
$writer->setSubjectPrependText('Fehler im Skript foo.php');
$writer->addFilter(Zend_Log::WARN);

$log = new Zend_Log();
$log->addWriter($writer);

// Irgendetwas schlechtes hat stattgefunden!
$log->error('unable to connect to database');

// Wenn der Writer heruntergefahren wird, wird Zend_Mail::send()
// getriggert um ein Email mit allen Logeinträgen zu senden die
// auf oder über dem Filterlevel von Zend_Log liegen

Zend_Log_Writer_Syslog schreibt Logeinträge in das Systemlog (syslog). Intern werden PHP's openlog(), closelog(), und syslog() Funktionen aufgerufen.

Ein nützlicher Fall für Zend_Log_Writer_Syslog ist das zusammenführen von Logs von geclusterted Maschinen über die Funktionalität vom Systemlog. Viele Systeme erlauben das entfernte Loggen von Systemevents, das es Systemadministratoren erlaubt einen Cluster von Maschinen von einer einzelnen Logdatei aus zu monitoren.

Standardmäßig wird allen erzeugen Syslog Nachrichten der String "Zend_Log" vorangestellt. Man kann einen anderen "application" Namen spezifizieren durch den solche Logmeldungen identifiziert werden können, entweder durch die Angabe des Anwendungsnamens an den Constructor oder dem Accessor der Anwendung:

// Bei der Instanziierung den "application" Schlüssel in den Optionen übergeben:
$writer = new Zend_Log_Writer_Syslog(array('application' => 'FooBar'));

// Zu jeder anderen Zeit:
$writer->setApplicationName('BarBaz');

Das Systemlog erlaubt es auch die "facility", oder den Anwendungstyp zu identifizieren, der die Nachricht loggt; viele Systemlogger erzeugen in Wirklichkeit unterschiedliche Logdateien pro Facility, welche wiederum die Aktivitäten von Administratoren unterstützen die Server monitoren wollen.

Man kann die Log Facility entweder über den Constructor oder über einen Accessor spezifizieren. Das sollte eine der openlog() Konstanten sein die in der openlog() Dokumentations Seite definiert sind.

// Bei der Instanziierung den "facility" Schlüssel in den Optionen übergeben:
$writer = new Zend_Log_Writer_Syslog(array('facility' => LOG_AUTH));

// Zu jeder anderen Zeit:
$writer->setFacility(LOG_USER);

Beim Loggen kann man weiterhin die standardmäßigen Zend_Log Prioritäts Konstanten verwenden; intern entsprechen diese den Prioritäts Konstanten von syslog().

Zend_Log_Writer_ZendMonitor erlaubt es Events über Zend Server's Monitor API zu loggen. Das erlaubt es die Log Nachrichten für die Umgebung einer komplette Anwendung an einem einzelnen Ort zu sammeln. Intern verwendet es einfach die monitor_custom_event() Funktion der Zend Monitor API.

Ein relativ nützlichen Feature der Monitor API ist das Sie es erlaubt beliebige eigene Informationen zusammen mit der Log Nachricht zu spezifizieren. Wenn man zum Beispiel eine Exception loggen will, kann man nicht nur die Exception Nachricht loggen, sondern auch das komplette Exception Objekt an die Funktion übergeben, und das Objekt dann im Zend Server Event Monitor inspizieren.

Die Instanzierung des ZendMonitor Log Writers ist trivial:

$writer = new Zend_Log_Writer_ZendMonitor();
$log    = new Zend_Log($writer);

Dann können Nachrichten einfach wie gewohnt geloggt werden:

$log->info('Das ist eine Nachricht');

Wenn man zusätzliche Informationen spezifizieren will, die mit dem Event geloggt werden sollen, können diese Informationen in einem zweiten Parameter übergeben werden:

$log->info('Exception gefunden', $e);

Der zweite Parameter kann ein Skalar, Objekt oder ein Array sein; wenn man mehrere Teile an Informationen übergeben will, ist der beste Weg diese als assoziatives Array zu übergeben.

$log->info('Exception gefunden', array(
    'request'   => $request,
    'exception' => $e,
));

Im Zend Server wird das Event als "eigenes Event" (custom) geloggt. Vom "Monitor" Tab muss das "Events" Sub-Element ausgewählt werden und dann der Filter aus "Custom" um eigene Events zu sehen.

Events im Dashboard von Zend Server's Monitor

In diesem Screenshot sind die ersten zwei angeführten Events eigene Events die über den ZendMonitor Log Writer geloggt wurden. Man kann anschließend auf ein Event klicken um alle Ihr zugehörigen Informationen zu sehen.

Event Detail in Zend Server's Monitor

Wenn auf das Sub-Tab "Custom" geklickt wird, werden alle extra Informationen angezeigt die durch die Übergabe des zweiten Arguments an die Logging Methode geloggt wurden. Diese Informationen werden als info Unterschlüssel geloggt; man kann sehen das in diesem Beispiel das Request Objekt geloggt wurde.

Zend_Log_Writer_Null ist ein Stumpf der keine Log Daten irgendwohin schreibt. Er ist nützlich um die Protokollierung auszuschalten oder während Tests abzustumpfen:

$writer = new Zend_Log_Writer_Null;
$logger = new Zend_Log($writer);

// geht nirgendwohin
$logger->info('Informative Nachricht');

Zend_Log_Writer_Mock ist ein sehr einfacher Writer der die rohen Daten die er empfängt aufnimmt und in einem Array als öffentliche Eigenschaft zur Verfügung stellt.

$mock = new Zend_Log_Writer_Mock;
$logger = new Zend_Log($mock);

$logger->info('Informative Nachricht');

var_dump($mock->events[0]);

// Array
// (
//    [timestamp] => 2007-04-06T07:16:37-07:00
//    [message] => Informative Nachricht
//    [priority] => 6
//    [priorityName] => INFO
// )

Um die Events die von der Attrappe protokolliert wurden zu entfernen, muß einfach $mock->events = array() gesetzt werden.

Es gibt kein gemischtes Writer Objekt. Trotzdem kann eine Log Instanz in jede beliebige Anzahl von Writern schreiben. Um das zu tun, muß die addWriter() Methode verwendet werden:

$writer1 = new Zend_Log_Writer_Stream('/path/to/first/logfile');
$writer2 = new Zend_Log_Writer_Stream('/path/to/second/logfile');

$logger = new Zend_Log();
$logger->addWriter($writer1);
$logger->addWriter($writer2);

// Geht zu beiden Writern
$logger->info('Informative Nachricht');