log4j

aus Wikipedia, der freien Enzyklopädie
Wechseln zu: Navigation, Suche
log4j
Maintainer Scott Deboy, Ralph Goers, Gary Gregory, Christian Grobmeier
Entwickler Apache Software Foundation
Aktuelle Version 2.0.2 / 1.2.17
(16. August 2014 / 13. Mai 2012)
Betriebssystem plattformunabhängig
Programmier­sprache 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.

Geschichte[Bearbeiten]

Logo von Log4js

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:

  • log4cxx für C++ mit zu Log4J kompatiblen Konfigurationsdateien
  • log4Net für .Net
  • log4php für PHP

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[Bearbeiten]

Das Apache-Logging-Projekt versucht log4j-ähnliche Systeme für diverse Programmiersprachen zusammenzuführen. Bisher sind das log4j, log4cxx, log4net, log4php[2] und Chainsaw (ein Logdatei-Betrachter und -Analysewerkzeug).[3]

Außerdem werden sogenannte Companions entwickelt, die zusätzliche Funktionalität für Apache log4j bereitstellen.

Funktionsweise[Bearbeiten]

Anstatt auftretende Fehler und Infomeldungen auf der Standardausgabe auszugeben, dient log4j dazu, die Meldungen über sogenannte Logger an das gewählte Loggingsystem weiterzuleiten. Neben der Auswahl des Loggingsystems wird gleichzeitig aufgrund der Wichtigkeit 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.[4]

Ausgabe-Umfang[Bearbeiten]

In der Konfigurationsdatei kann die Ausgabe je nach Wichtigkeit der Nachrichten gefiltert werden. Der Ausgabe-Umfang steigt 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:

ALL
Alle Meldungen werden ungefiltert ausgegeben
TRACE
ausführlicheres Debugging (seit Version 1.2.12), Kommentare
DEBUG
allgemeines Debugging (auffinden von Fehlern)
INFO
allgemeine Informationen (Programm gestartet, Programm beendet, Verbindung zu Host Foo aufgebaut, Verarbeitung dauerte SoUndSoviel Sekunden …)
WARN
Auftreten einer unerwarteten Situation
ERROR
Fehler (Ausnahme wurde abgefangen. Bearbeitung wurde alternativ fortgesetzt)
FATAL
Kritischer Fehler, Programmabbruch
OFF
Logging ist deaktiviert

Appender[Bearbeiten]

Mittels Appender kann je nach Wunsch auf Standardausgabe, in eine Datei, ins Systemlog, in eine Datenbank oder in beliebige andere Ziele geschrieben werden bzw. in mehrere gleichzeitig.

Die folgenden sind die wichtigsten Appender-Arten:

ConsoleAppender
Gibt auf Standardausgabe aus
FileAppender
Schreibt in eine Datei
RollingFileAppender
Beginnt eine neue Datei ab einer gewissen Größe
DailyRollingFileAppender
Beginnt zu gewissen Zeiten mit einer neuen Datei
SyslogAppender
Loggt mittels Syslog-Dienst
JDBCAppender
Schreibt in eine Datenbank
NTEventLogAppender
Schreibt ins Ereignisprotokoll des Windows-Systems
SMTPAppender
Schickt bei gewissen Meldungen eine Mail.
SocketAppender
Sendet die Log-Nachricht an einen konfigurierten Socket-Listener.
LogCatAppender
Loggt in den Android LogCat

Weitere Appender können jederzeit hinzugefügt werden.

Konfiguration[Bearbeiten]

Bei log4j 1.x gibt es zwei Arten, um log4j zu konfigurieren: mittels einer Properties- oder mittels einer XML-Datei; bei log4j 2 werden Properties-Dateien nicht mehr unterstützt. 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:

Appender
Diese bestimmen mittels Konfiguration der entsprechenden Appender-Klasse, wohin die Log-Ausgaben geschrieben werden sollen, und mittels Konfiguration des Layouts, wie dorthin geschrieben werden soll. Neben der reinen Nachricht können mittels Muster zusätzlich Wichtigkeit, Datum, Loggername, Klassenname und Methodenname bis hin zur genauen Codezeile ausgegeben werden.
Logger
Ein Logger ist ein Objekt, welches die Logging-Aufgaben einer Klasse übernimmt. Es wird über seinen Namen identifiziert. Üblicherweise wird der Klassenname als Name für den Logger verwendet. Es ist allerdings auch möglich, einen Fantasie-Namen zu verwenden, der von mehreren Klassen benutzt wird. Ein typisches Beispiel könnte so aussehen:
Logger log = Logger.getLogger(org.wikipedia.MyClass)
Damit kann das Logging-Verhalten einer Klasse gesteuert werden. Da der Logger auch die Paket-Informationen erhält, ist es auch möglich Logging für ganze (Super)-Pakete zu konfigurieren.
Die Konfigurationsdatei kann dann eben den Logger-Namen - also z. B. "org.wikipedia.MyClass" - und auch das gewünscht Log-Level enthalten. Es ist wie bereits erwähnt möglich, eine Konfiguration für ein Paket wie "org.wikipedia" festzulegen.
Darüber hinaus können entweder allgemein oder auch zu jedem Logger spezifisch ein oder mehrere Appender definiert werden. Somit ist es beispielsweise möglich, fatale Fehler nicht nur in eine Datei zu schreiben, sondern auch gleichzeitig per E-Mail an einen Administrator zu schicken.
log4j 2.0 bietet neben diesen klassischen Konfigurationen auch modernere Möglichkeiten an in das Logging-Verhalten einzugreifen. Beispielsweise werden sogenannte Marker unterstützt.

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.

Beispiel[Bearbeiten]

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>

Apache log4j 2[Bearbeiten]

Seit 2012 ist die Version 2 zunächst im Alpha, nun als stabile Version erhältlich. Das Framework 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.[5]

Das Projekt plant derzeit gelegentliche Wartungsreleases der Serie 1.x, wird sich aber mehr und mehr auf die 2.x Serie fokussieren.

Alternativen[Bearbeiten]

  • Java Logging – seit Java 1.4 Bestandteil der Java-Klassenbibliothek; ähnlich zu log4j, weniger Appender, kein PatternLayout
  • Apache Commons Logging – Schnittstelle für beliebig austauschbare Logging-Frameworks, unter anderem log4j
  • tinylog – schlankes Logging-Framework mit nur einem statischen Logger

Literatur[Bearbeiten]

Weblinks[Bearbeiten]

Einzelnachweise[Bearbeiten]

  1. Rolf Kulemann: android-logging-log4j. Logging with Log4J in Android ¦ providing LogCat appender and configuration facade. Abgerufen am 29. November 2011.
  2. Apache log4php
  3. Apache Logging Services Project
  4. Apache log4j 1.2
  5. The new log4j 2.0