Die Anwendung IBM® Enterprise Records enthält eine Musterdatei log4j.properties, die Sie konfigurieren können.
Die Datei log4j.properties befindet sich im Ordner IER-Installationspfad\RecordsManagerSweep. Sie können das Protokollierungsverhalten konfigurieren, indem Sie in der Datei Werte für die folgenden Eigenschaften festlegen:
Jeder Protokollfunktion in der Datei log4j.properties wird eine Stufe zugeordnet. Wenn Sie einer Protokollfunktion keine Stufe zuordnen, weist log4j der nicht zugeordneten Protokollfunktion automatisch die Stufe der übergeordneten Protokollfunktion zu. Standardmäßig wird einer Protokollfunktion die Stufe WARN zugeordnet.
Sie können die Datei log4j.properties mit unterschiedlichen Einstellungen für die Protokollfunktion, den Appender und das Layout konfigurieren. Die Datei log4j.properties muss zur Ausführungszeit für die Anwendung aus dem Klassenpfad verfügbar sein. Sie können Einträge in der Musterdatei auskommentieren, indem Sie der Anweisung ein Hashzeichen (#) voranstellen. Mit dem Hashzeichen auskommentierte Einträge werden zur Ausführungszeit übersprungen.
Navigieren Sie zum Öffnen der Datei log4j.properties zum Ordner IER-Installationspfad\RecordsManagerSweep und öffnen Sie dann die Datei mit einem Texteditor.
Sie müssen zuerst die Protokollfunktion festlegen. Sie können eine Reihe von Protokollfunktionen haben, um den Typ von Protokollierung zu klassifizieren, den Sie für die Anwendung benötigen. Wenn Sie die Protokollierung für alle Klassen von com.filenet.rm und dessen Unterpaketen aktivieren wollen, geben Sie die Protokollfunktion wie in der folgenden Anweisung an:
log4j.logger.com.filenet.rm
Sie können für die Protokollfunktion aber auch einen beliebigen Namen angeben. Sie können Ihre Protokollfunktion beispielsweise wie in der folgenden Anweisung gezeigt mit APILOG benennen:
log4j.logger.com.filenet.rm=warn, APILOG
Sie müssen eine Protokollstufe festlegen, um den Detaillierungsgrad der Nachrichten zu definieren, die von log4j zur Ausführungszeit aufgezeichnet werden. log4j unterstützt fünf normale Protokollstufen (siehe folgende Tabelle):
Stufe | Beschreibung |
---|---|
DEBUG | Gibt differenzierte Informationsereignisse an, die für das Debugging einer Anwendung am nützlichsten sind. |
INFO | Gibt Informationsnachrichten an, die den Prozess der Anwendung weniger differenziert darstellen. |
WARN | Gibt möglicherweise schädliche Situationen an. |
ERROR | Gibt Fehlerereignisse an, die die weitere Ausführung der Anwendung möglicherweise dennoch erlauben. |
FATAL | Gibt schwerwiegende Fehlerereignisse an, die möglicherweise dazu führen, dass die Ausführung der Anwendung gestoppt wird. |
Informationen zu speziellen und angepassten Protokollstufen finden Sie in der log4j-Dokumentation auf der Apache-Website. Standardmäßig beginnt die Anwendung mit der Stufe WARN. Diese Stufe kann zur Ausführungszeit in die Stufe DEBUG, INFO, ERROR oder FATAL geändert werden. Sie können auch mehrere Protokollfunktionsanweisungen, jeweils für dieselbe Protokollfunktion, jedoch mit unterschiedlichen Stufen aufnehmen (z. B. DEBUG und WARN). Sie können den einen oder den anderen Eintrag in der Musterdatei auskommentieren, indem Sie der Anweisung ein Hashzeichen (#) voranstellen. Anschließend können Sie bei Bedarf zwischen den Stufen DEBUG und WARN wechseln. Mit dem Hashzeichen auskommentierte Einträge werden zur Ausführungszeit übersprungen. Eine Protokollfunktion ohne Stufe übernimmt automatisch die Stufe der übergeordneten Protokollfunktion. Standardmäßig wird der API-Protokollfunktion in IBM Enterprise Recordsdie Stufe WARN zugeordnet.
Einer Protokollfunktion wird mindestens ein Appender zugeordnet, damit ihre Protokollnachrichten in Ausgabemedien geschrieben werden können. Sie können unterschiedliche Arten von Appendern in der Datei log4j.properties festlegen, die die Protokollinformationen an das angegebene Ausgabeziel senden. Die folgende Tabelle enthält eine Liste aller Appender, die in der Datei log4j.properties verwendet werden, zusammen mit einer Kurzbeschreibung und den zugehörigen Optionen.
Appender | Beschreibung und Codefragmente |
---|---|
NTEventLogAppender | Sendet Protokollnachrichten an das Ereignisprotokoll von Microsoft Windows NT. Dieser Appender kann nur auf einem Windows-System installiert und verwendet werden.
|
ConsoleAppender | Hängt Protokollnachrichten mit einem vom Benutzer angegebenen Layout an die Datenströme System.out (Standard) oder System.err an und verwendet dabei ein vom Benutzer festgelegtes Layout.
Optionen:
|
FileAppender | Sendet Protokollnachrichten an eine Datei.
Optionen:
|
RollingFileAppender | Erweitert 'FileAppender', sodass Protokolldateien gesichert werden, wenn diese eine bestimmte Größe erreicht haben.
Optionen:
|
Sie können in der Datei log4j.properties unterschiedliche Layouts zur Angabe des Protokollnachrichtenformats definieren. Sie können angeben, dass Protokollnachrichten das Datum, die Uhrzeit, den Modulnamen, den Threadnamen und andere Informationen enthalten sollen. Diese Konfigurationseinstellungen werden zur Ausführungszeit bei der Protokollierung der Nachricht verwendet.
Die folgende Tabelle enthält eine Liste aller Layouts, die in der Datei log4j.properties von IBM Enterprise Records verwendet werden, zusammen mit einer Kurzbeschreibung und den zugehörigen Optionen.
Layout | Beschreibung und Codefragment |
---|---|
SimpleLayout | Gibt die Stufe, gefolgt von einem Gedankenstrich (-), gefolgt vom Protokollnachrichtentext aus.
|
PatternLayout | Formatiert Protokollereignisse entsprechend einem definierten Konvertierungsmuster. Konvertierungsmuster bestehen aus Literaltext und Konvertierungskennungen. Literaltext ist die unveränderte Ausgabe. Konvertierungskennungen bestehen aus dem Prozentzeichen (%), gefolgt von einem optionalen Formatmodifikator und einem obligatorischen Konvertierungszeichen. Beispiel: %-5p [%t]: %m%n ist ein Konvertierungsmuster bestehend aus einer Konvertierungskennung für die Priorität, gefolgt vom Literaltext " [". Auf diese Zeichenfolge folgt eine Konvertierungskennung für den Thread, gefolgt vom Literaltext "]: ". Auf diese Zeichenfolge folgt eine Konvertierungskennung für die Nachricht und ein systemabhängiges Zeilentrennzeichen.
Optionen:
|
HTMLLayout | Formatiert die Ausgabe als HTML-Tabelle.
Optionen:
|
Formatiert die Ausgabe als XML.
Optionen:
|
Die mit IBM Enterprise Records mitgelieferte Datei log4j.properties verwendet PatternLayout als Protokollnachrichtenformat. Die folgende Tabelle enthält eine Liste von Konvertierungsmustern, die in der Konfigurationsdatei deklariert werden können, zusammen mit einer Kurzbeschreibung:
Muster | Beschreibung |
---|---|
%t | Name des Threads, der die Protokollanforderung stellt. |
%c | Name der Protokollfunktion für die Protokollanforderung. |
%-60c | Linksbündige Ausrichtung des Protokollfunktionsnamens innerhalb von mindestens 60 Leerzeichen. |
%r | Zeit in Millisekunden seit dem Start der Anwendung. |
%p | Stufe der Protokollanweisung. |
%m | Nachricht. |
%Time | Zeit, zu der die Protokollierung erfolgt. |
%d | Datum des Protokollereignisses. |
%n | Neue Zeile. |
Die folgende Codeanweisung zeigt, wie PatternLayout aktiviert und ein einfaches Konvertierungsmuster angegeben wird:
log4j.appender.APILOG.layout=org.apache.log4j.PatternLayout
log4j.appender.APILOG.layout.ConversionPattern=%-5p %d {dd MMM yyyy HH:mm:ss,SSS}, -%m, %r, [%M] % n
Beispiel:
WARN, 20 Jun 2005 14:48:20,900, -[enter] getObjectStoreXML(ObjectStores), 102042, [setLoggerMessage]
WARN, 20 Jun 2005 14:48:21,100, -[exit] getObjectStoreXML(ObjectStores), 102342, [setLoggerMessage]