Monolog ist eine weit verbreitete Logging-Bibliothek für PHP, die das PSR-3-Standardinterface für Logs implementiert und so kompatibel mit PSR-3-konformen Frameworks und Anwendungen ist. Monolog bietet eine einfache und flexible Möglichkeit, Logs in verschiedenen Zielsystemen zu speichern und zu verwalten. Entwickler können damit Fehler, Warnungen oder allgemeine Informationen in PHP-Anwendungen protokollieren und so das Debugging und die Wartung ihrer Anwendungen verbessern.

Hauptfunktionen und Konzepte von Monolog:

1. Logger Instanz: Monolog erstellt einen Logger über die Logger-Klasse. Die Logger-Instanz unterstützt verschiedene Log-Level (z. B. debug, info, warning, error), die in PHP-Programmen genutzt werden können, um verschiedene Schweregrade von Log-Nachrichten zu erfassen.

2. Handler: Ein Herzstück von Monolog ist das Konzept der Handler. Handler steuern, wohin und wie die Log-Einträge gespeichert werden. Monolog unterstützt zahlreiche Handler, darunter:

   • StreamHandler: Schreibt Logs in Dateien oder Streams.
   • RotatingFileHandler: Erzeugt täglich rotierende Log-Dateien.
   • FirePHPHandler und ChromePHPHandler: Ermöglichen das Loggen direkt in den Browser (über spezielle Browser-Erweiterungen).
   • SlackHandler, MailHandler u. a.: Zum Versand von Logs an spezifische Kanäle wie Slack oder per E-Mail.

3. Formatter: Handler können mit Formatters kombiniert werden, um den Inhalt der Logs anzupassen. Monolog bietet verschiedene Formatierer, die z. B. die Logs im JSON-Format ausgeben können oder einfach nur die grundlegende Textausgabe formatieren.

4. Processor: Neben Handlern und Formattern erlaubt Monolog auch den Einsatz von Prozessoren, die zusätzliche Daten an die Log-Einträge anhängen, z. B. Kontextinformationen wie User-Daten oder die aktuelle IP-Adresse.

Beispiel zur Verwendung von Monolog:

Hier ein einfaches Beispiel zur Initialisierung und Nutzung eines Monolog-Loggers:

use Monolog\Logger;
use Monolog\Handler\StreamHandler;

$logger = new Logger('name');
$logger->pushHandler(new StreamHandler(__DIR__.'/app.log', Logger::WARNING));

// Log-Meldung erstellen
$logger->warning('Dies ist eine Warnung');
$logger->error('Dies ist ein Fehler');

Vorteile von Monolog:

• Modularität: Dank der Handler ist Monolog sehr flexibel und anpassbar, um Logs an verschiedene Orte zu senden.
• PSR-3-Kompatibilität: Monolog erfüllt den PSR-3-Standard, was die Integration in andere PHP-Projekte vereinfacht.
• Erweiterbarkeit: Handler, Formatter und Prozessoren können individuell konfiguriert oder durch benutzerdefinierte Klassen erweitert werden, um spezifische Anforderungen zu erfüllen.

Verbreitung

Monolog ist eine der am häufigsten eingesetzten Logging-Bibliotheken in PHP, vor allem in Kombination mit Symfony, Laravel und anderen PHP-Frameworks.

PSR-3 ist eine Empfehlung der PHP-FIG (PHP Framework Interoperability Group), die ein standardisiertes Interface für Logging-Bibliotheken in PHP-Anwendungen festlegt. Das Ziel ist es, Entwicklern eine einheitliche und flexible Schnittstelle für das Logging bereitzustellen, die unabhängig von der verwendeten Bibliothek funktioniert. Dadurch können Log-Bibliotheken leicht ersetzt oder geändert werden, ohne dass bestehender Code angepasst werden muss.

Wichtige Punkte von PSR-3:

1. Standardisiertes Logger-Interface: PSR-3 definiert das Interface Psr\Log\LoggerInterface mit verschiedenen Methoden für unterschiedliche Log-Level wie emergency(), alert(), critical(), error(), warning(), notice(), info() und debug().

2. Log-Level: Die acht vordefinierten Log-Level (z. B. emergency, alert, error) basieren auf dem weit verbreiteten Syslog-Protokoll RFC 5424, was die Kompatibilität mit vielen Logging-Systemen sicherstellt.

3. Nachrichteninterpolation: PSR-3 erlaubt es, Platzhalter in Log-Nachrichten (z. B. {platzhalter}) durch tatsächliche Werte zu ersetzen. Beispiel:
   $logger->error("Benutzer {username} nicht gefunden", ['username' => 'johndoe']);
Dadurch werden Log-Nachrichten konsistent und lesbar formatiert, ohne dass aufwendige String-Manipulation nötig ist.

4. Flexible Implementierung: Jede Logging-Bibliothek, die LoggerInterface implementiert, kann in PSR-3-kompatiblem Code verwendet werden, wie etwa die weit verbreitete Bibliothek Monolog.

5. Dynamische Log-Level: Mit der log()-Methode kann man Nachrichten auch dynamisch auf jedem gewünschten Log-Level protokollieren, indem der Level als Parameter übergeben wird.

Beispiel zur Anwendung:

Hier ein Beispiel, wie ein PSR-3-konformer Logger verwendet wird:

use Psr\Log\LoggerInterface;

class UserService
{
    private $logger;

    public function __construct(LoggerInterface $logger)
    {
        $this->logger = $logger;
    }

    public function findUser($username)
    {
        $this->logger->info("Suche nach Benutzer {username}", ['username' => $username]);
        // ...
    }
}

Vorteile von PSR-3:

• Interoperabilität: Das Standard-Interface ermöglicht einen unkomplizierten Wechsel zwischen verschiedenen Logging-Bibliotheken.
• Konsistenz: PSR-3 sorgt für eine einheitliche Struktur beim Logging, was die Lesbarkeit und Wartbarkeit des Codes vereinfacht.
• Anpassungsfähigkeit: PSR-3 unterstützt komplexe Anwendungen, die möglicherweise verschiedene Logging-Level und Speicherorte für Logs benötigen.

Mehr Informationen und Details finden sich auf der offiziellen PHP-FIG-Seite zur PSR-3-Spezifikation.