Logger

Die Klasse Logger ist ein Tool, mit dem Logging-Aufgaben einfach und zentral bewerkstelligt werden können. Um die Performance einer Anwendung nicht durch häufige, verteilte und konkurrierende File-Zugriffe zu beeinträchtigen, sollte der Logger als Singleton-Instanz erzeugt und verwendet werden. Die Logfile-Einträge werden dann am Ende eines Requests gesammelt in das entsprechende Logfile geschrieben. Der Logger verwendet dazu den Registry-Wert LogDir aus dem Namespace apf::core. Dieser wird mit dem absoluten Pfad zum aktuellen Verzeichnis plus Unterordner logs initialisiert. Soll ein anderes Log-Verzeichnis verwendet werden, so kann der Pfad in der Bootstrap-Datei vor dem Erstellen der Page- oder des FrontController per

PHP-Code
Registry::register('apf::core','LogDir','/Pfad/zu/meinem/Log/Verzeichnis');

angepasst werden. Der angegebene Pfad dient der Ablage aller Log-Dateien einer Applikation.

Um Fehler beim Zugriff auf das Log-Verzeichnis zu vermeiden, sollte der Pfad absolut definiert sein!

Zur Verwendung des Loggers muss dieser zunächst per

PHP-Code
import('core::logging','Logger');

eingebunden werden. Anschließend kann per

PHP-Code
$log = &Singleton::getInstance('Logger');

eine Referenz auf die Instanz des Loggers im aktuellen Gültigkeitsbereich erzeugt werden. Das Hinzufügen eines Eintrags mit dem Inhalt MESSAGE zu einem Logfile mit dem Namen FILENAME ist mit dem Aufruf

PHP-Code
$log->logEntry('FILENAME','MESSAGE');

erledigt. Der dritte Parameter (optional) der Methode logEntry() definiert die SEVERITY der Meldung und kann frei definiert werden. Für Fehler wird üblicherweise ERROR eingesetzt, Standard ist INFO.

Sollte die Applikation exzessives Logging betreiben, kann es sinnvoll sein zu Gunsten einer geringeren Speicher-Auslastung den Log-Buffer innerhalb eines Requests mehrmals zu leeren. Hierzu besitzt der Logger ab Version 1.14 eine Buffer-Größe, die mit der Methode setMaxBufferLength() auch nachträglich definiert werden kann. Überschreitet der Puffer die standardmäßig oder durch Aufruf der genannten Methode definierten Grenzwert, wird der Inhalt in die entsprechende Log-Datei geschrieben und anschließend geleert.

Kommentare

Möchten Sie den Artikel eine Anmerkung hinzufügen, oder haben Sie ergänzende Hinweise? Dann können Sie diese hier einfügen. Die bereits verfassten Anmerkungen und Kommentare finden Sie in der untenstehenden Liste.
Für diesen Artikel liegen aktuell keine Kommentare vor.