Log4j
| |
---|---|
Basisdaten
| |
Maintainer | Scott Deboy, Ralph Goers, Gary Gregory, Christian Grobmeier |
Entwickler | Apache Software Foundation |
Aktuelle Version | 2.17.0[1][2] (18. Dezember 2021) |
Betriebssystem | plattformübergreifend |
Programmiersprache | Java |
Lizenz | Apache-Lizenz 2.0 |
logging.apache.org |
Log4j ist ein Framework zum Loggen von Anwendungsmeldungen in Java. Innerhalb vieler Open-Source- und kommerzieller Softwareprodukte hat es sich über die Jahre zu einem De-facto-Standard entwickelt. Log4j gilt als Vorreiter für andere Logging-Frameworks, auch in anderen Programmiersprachen.
Das Projekt wurde von Ceki Gülcü 1996 während seiner Arbeit am IBM-Entwicklungslabor in Zürich gegründet. Heute ist es ein Teil des Logging-Projekts der Apache Software Foundation und steht unter der Apache-Lizenz 2.0. Es entstand zu einer Zeit, als es in den Java-Standardbibliotheken noch keine Logging-Mechanismen gab. Heutzutage ist es durch seine Ausgereiftheit und Konfigurierbarkeit für viele Softwareentwickler das Log-System der ersten Wahl.
Die Ausstrahlung der Log4j-Konzepte auf andere Programmiersprachen bzw. Plattformen ist so groß, dass es mittlerweile etliche Adaptionen gibt. Einige werden vom Apache Logging Projekt selbst gepflegt. Zum Beispiel:
Viele Varianten werden jedoch außerhalb von Apache Logging entwickelt:
Seit Juli 2014 ist Log4j 2 als Nachfolger des Log4j 1.x verfügbar.
Das Apache-Logging-Projekt versucht, Log4j-ähnliche Systeme für diverse Programmiersprachen zusammenzuführen. Bisher sind das log4j, log4cxx, log4net, log4php[5] und Chainsaw (ein Logdatei-Betrachter und -Analysewerkzeug).[6]
Außerdem werden sogenannte Companions entwickelt, die zusätzliche Funktionalität für Apache Log4j bereitstellen.
Anstatt auftretende Fehler und Infomeldungen auf der Standardausgabe auszugeben, dient Log4j dazu, die Meldungen über sogenannte Logger an das gewählte Loggingsystem weiterzuleiten („Appender“). Neben der Auswahl des Loggingsystems wird gleichzeitig aufgrund der Wichtigkeit („Log-Level“) der Meldung entschieden, ob diese überhaupt weitergeleitet wird. Der Programmierer muss sich beim Erstellen des Programms nur um die Wichtigkeit der Meldungen Gedanken machen. Die Filterung und Art der Ausgabe kann zur Laufzeit konfiguriert werden.
Log4j ist auf möglichst hohe Geschwindigkeit ausgelegt, damit das Loggen die Systemleistung nicht negativ beeinflusst. So dauert die Entscheidung, ob eine Meldung ausgegeben werden muss, auch auf einem veralteten System (AMD Duron mit 800 MHz, JDK 1.3.1) nur 5 Nanosekunden, die Ausgabe selbst – je nachdem, welches Layout verwendet wird – zwischen 21 und 37 Mikrosekunden.[7]
In der Konfigurationsdatei kann die Ausgabe je nach Wichtigkeit der Nachrichten gefiltert werden. Der Ausgabe-Umfang sinkt mit der zugewiesenen Wichtigkeitsstufe und umfasst alle Nachrichten der Stufe selbst, sowie aller noch dringenderen Stufen. Die Reihenfolge stellt sich dabei wie folgt dar: ALL → TRACE → DEBUG → INFO → WARN → ERROR → FATAL → OFF.
Für die Einstufung der Wichtigkeit gelten folgende Richtwerte:
Mittels Appender kann das Ausgabeziel/können die Ausgabeziele der erzeugten Loggingausgaben festgelegt werden.
Nachfolgend die wichtigsten Appender-Arten:
Weitere Appender können jederzeit hinzugefügt werden.
Es gibt drei Arten, Log4j zu konfigurieren: mittels einer Properties- oder einer XML-Datei oder im Programmcode. Es wird empfohlen, eine Properties- oder XML-Datei zu verwenden, damit ist die Konfiguration vom Code getrennt, was es ermöglicht, ohne Modifikation oder Neustart der Applikation das Loggen umzukonfigurieren. Somit kann beispielsweise eine Applikation so lange nur mit Log-Level FATAL betrieben werden, bis ein Fehler auftritt. Ab dann wird das Level WARN gesetzt, ohne die Applikation anzuhalten.
Die Konfigurationsdateien definieren mittels der folgenden Komponenten das Verhalten von Log4j:
Logger log = Logger.getLogger(org.wikipedia.MyClass)
.Ein weiteres nützliches Merkmal ist der Mapped Diagnostic Context. Dabei wird einer Kontextvariablen ein Wert zugewiesen und in der Konfigurationsdatei kann darauf referenziert werden. Dabei hat jeder Thread seinen eigenen Kontext und kann zusätzliche Informationen wie z. B. die Adresse des Clients bei einer Serveranwendung protokollieren.
Die folgende XML Konfiguration konfiguriert eine Applikation so, dass FATAL-Fehler von Fremdbibliotheken auf die Konsole geloggt werden, ERROR-Fehler der eigenen Applikation zusätzlich auch per E-Mail geschickt werden, bei einer spezifischen Komponente darüber hinaus auch noch INFO-Meldungen geloggt werden und bei einer bestimmten Klasse sogar noch DEBUG-Meldungen.
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration PUBLIC "-//APACHE//DTD LOG4J 1.2//EN"
"http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/xml/doc-files/log4j.dtd">
<log4j:configuration>
<!-- Appender für eine einzeilige Ausgabe an der Konsole -->
<appender name="Konsole" class="org.apache.log4j.ConsoleAppender">
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern"
value="%d{ABSOLUTE} %5p %c{1}:%L - %m%n" />
</layout>
</appender>
<!-- Appender für dieselbe Ausgabe via email -->
<appender name="mail" class="org.apache.log4j.net.SMTPAppender">
<param name="SMTPHost" value="smtp.myservername.xx" />
<param name="From" value="email@fromemail.xx" />
<param name="To" value="toemail@toemail.xx" />
<param name="Subject" value="[LOG] ..." />
<param name="BufferSize" value="1" />
<param name="threshold" value="error" />
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern"
value="%d{ABSOLUTE} %5p %c{1}:%L - %m%n" />
</layout>
</appender>
<!-- ERROR-Logger für alle Klassen meiner Applikation -->
<logger name="com.myapp">
<level value="error"/>
<appender-ref ref="Konsole" />
<appender-ref ref="mail" />
</logger>
<!-- INFO-Logger für eine spezifische Komponente -->
<logger name="com.myapp.mycomponent">
<level value="info"/>
</logger>
<!-- DEBUG-Logger für eine spezifische Klasse -->
<logger name="com.myapp.mycomponent.MyClass">
<level value="debug"/>
</logger>
<!-- FATAL-Logger für die gesamte Applikation (inkl. Bibliotheken) -->
<root>
<level value="fatal" />
<!-- loggt auf Konsole - wenn nicht in Sub-Loggern anders definiert -->
<appender-ref ref="Konsole" />
</root>
</log4j:configuration>
Version 2 wurde von Grund auf neu geschrieben, auch wenn Teile von Log4j 1.x übernommen wurden. Die neue Version verfügt über eine moderne Schnittstelle, wie sie auch von logback bekannt ist. Außerdem unterstützt sie slf4j native. Zugleich wurden Schwächen von logback analysiert und versucht zu verbessern. Somit verliert Log4j 2 beispielsweise keine Logging-Events, wenn sich das System neu konfiguriert. Außerdem wurde eine Plugin-Architektur bereitgestellt und die Konfiguration mittels JSON ermöglicht.[9]
Das Projekt plant mit Stand März 2013 gelegentliche Wartungsreleases der Serie 1.x, wird sich aber mehr und mehr auf die 2.x Serie fokussieren.
Auf der Website von Apache werden einige Unterschiede zwischen Log4j 1 und Log4j 2 aufgelistet.[10]
Am 10. Dezember 2021 wurde eine Zero-Day-Lücke in Log4j-Version 2 bekannt (CVE-2021-44228, oft als Log4Shell bezeichnet), die Angreifer ausnutzen konnten, um Code auf dem jeweiligen Hostsystem auszuführen (Remote Code Execution) und somit zum Beispiel Rechenleistung von den infizierten Servern zu benutzen, um Krypto-Mining zu betreiben. Laut F-Secure gab es auch Ransomware-Angriffe. Betroffene Dienste sind unter anderem Amazon Web Services, Steam und iCloud.[11][12]
Laut Bundesamt für Sicherheit in der Informationstechnik (BSI) ergeben Berichte von CERT-Quellen, dass weltweite Massenscans und versuchte Kompromittierungen im Zuge der Zero-Day-Lücke stattfanden.[13][12] Das BSI verwies auf eine „unvollständige Auflistung“ von 140 Unternehmen, die besonders anfällig seien.[14][12]
Nur wenige Tage nach Veröffentlichung wurde die Sicherheitslücke schon kriminell ausgenutzt.[15] Am 16. Dezember 2021 wurden mit dem Internet verbundene Systeme des belgischen Militärs über die Lücke angegriffen.[16] Am 17. Dezember 2021 wurde die Webseite des Bundesfinanzhofs wegen einer solchen Attacke abgeschaltet.[17]
Der präsentierte Inhalt des Wikipedia-Artikels wurde im 2021-12-23 basierend auf extrahiert https://de.wikipedia.org/?curid=200052