WriterEin Writer ist ein Objekt das von Zend_Log_Writer_Abstract abstammt. Die Aufgabe eines Writer's ist es Log Daten in ein Speicher-Backend aufzunehmen. In Streams schreibenZend_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.
Um Daten in eine Datei zu schreiben, muß eine der » Dateisystem URLs verwendet werden:
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:
Der Modus kann für existierende Stream Ressourcen nicht definiert werden. Wenn das gemacht versucht wird, wird eine Zend_Log_Exception geworfen. In Datenbanken schreibenZend_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:
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. An Firebug schreibenZend_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:
Example #1 Loggen mit Zend_Controller_Front
Example #2 Loggen ohne Zend_Controller_Front
Setzen von Stilen für PrioritätenEingebaute und Benutzerdefinierte Prioritäten können mit der setPriorityStyle() Methode angepasst werden.
Der Standardstil für Benutzerdefinierte Prioritäten kann mit der setDefaultPriorityStyle() Methode gesetzt werden.
Die unterstützten Stile sind wie folgt:
Daten für das Loggen vorbereitenWärend jede PHP Variable mit den eingebauten Prioritäten geloggt werden kann, ist eine etwas spezielle Formatierung notwendig wenn einige der spezialisierteren Logstile verwendet werden. Die LOG, INFO, WARN, ERROR und TRACE Stile benötigen keine spezielle Formatierung. Loggen von AusnahmenUm eine Zend_Exception zu loggen muß einfach das Exceptionobjekt an den Logger übergeben werden. Es ist egal welche Priorität oder welcher Stil gesetzt wurde, da die Ausnahme automatisch erkannt wird.
Tabellen loggenMan kann auch Daten loggen und diese in einem Table Stil formatieren. Spalten werden automatisch erkannt und die erste Zeile der Daten wird automatisch der Header. In Emails schreibenZend_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:
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. Zend_Layout VerwendungEine Zend_Layout Instanz kann verwendet werden um den HTML Anteil einer Multipart Email zu erstellen. Wenn eine Zend_Layout Instanz in Verwendung ist, nimmt Zend_Log_Writer_Mail an das sie verwendet wird um HTML darzustellen und setzt den Body HTML für die Nachricht als den Zend_Layout-darstellenden Wert. Wenn Zend_Log_Writer_Mail mit einer Zend_Layout Instanz verwendet wird, hat man die Option eine eigene Formatierung zu setzen indem die setLayoutFormatter() Methode verwendet wird. Wenn kein Zend_Layout-spezifischer formatierungs-Eintrag spezifiziert wurde, wird der aktuell in Verwendung befindliche Formatierer verwendet. Die vollständige Verwendung von Zend_Layout mit einem eigenen Formatierer wird anbei gezeigt.
Zusammenfassung der Fehlerlevel in der SubjektzeileDie setSubjectPrependText() Methode kann statt Zend_Mail::setSubject() verwendet werden um die Subjektzeile dynamisch zu schreiben bevor die Email gesendet wird. Wenn, zum Beispiel, der dem Subjekt vorangestellte Text "Fehler des Skriptes" heißt, würde das Subjekt des Emails das von Zend_Log_Writer_Mail mit zwei Warnungen und fünf Fehlern erstellt wird "Fehler des Skriptes (warn = 2; error = 5)" sein. Wenn kein Subjekttext mit Zend_Log_Writer_Mail vorangestellt wird, wird die Zend_Mail Subjektzeile verwendet, wenn vorhanden. VorbehalteDas Senden von Logeinträgen über Emails kann gefährlich sein. Wenn Fehlerzustände vom eigenen Skript falsch behandelt werden, oder man die Fehlerlevel falsch verwendet, kann man sich selbst in einer Situation finden in der man Hunderte oder Tausende von Emails zu den Empfängern sendet abhängig von der Frequenz der eigenen Fehler. Bis dato bietet Zend_Log_Writer_Mail keinen Mechanismus für die Limitierung oder andernfalls die Dosierung der Nachrichten. Solche Funktionalitäten, können vom Konsumenten, wenn benötigt, selbst implementiert werden. Nochmals, Zend_Log_Writer_Mail's primäres Ziel ist es proaktiv Menschen über Fehlerzustände zu benachrichtigen. Wenn diese Fehler zeitgerecht behandelt werden, und Sicherheitsmaßnahmen platziert werden um diese Vorbehalte in Zukunft zu verhindern, dann kann die Email-basierende Benachtichtigung von Fehlern ein nützliches Tool sein. In das Systemlog schreibenZend_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:
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.
Beim Loggen kann man weiterhin die standardmäßigen Zend_Log Prioritäts Konstanten verwenden; intern entsprechen diese den Prioritäts Konstanten von syslog(). Auf den Zend Server Montior schreibenZend_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:
Dann können Nachrichten einfach wie gewohnt geloggt werden:
Wenn man zusätzliche Informationen spezifizieren will, die mit dem Event geloggt werden sollen, können diese Informationen in einem zweiten Parameter übergeben werden:
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.
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.
Einen Writer abstumpfenZend_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:
Mit der Attrappe testenZend_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.
Um die Events die von der Attrappe protokolliert wurden zu entfernen, muß einfach $mock->events = array() gesetzt werden. Gemischte WriterEs 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:
|