IBM® FileNet Workplace XT verwendet das Produkt Apache log4j für die Verwaltung seiner Protokollierung. Während der Protokollierung werden Informationen zur Anwendungsaktivität in Ausgabepositionen wie die Konsole oder Dateien geschrieben. Das Personal von Benutzerunterstützung und Entwicklung verwendet die Informationen in den Protokolleinträgen, um die Anwendungsaktivität zu analysieren und um Probleme zu diagnostizieren und zu beheben. Die Protokollierung dient nur Diagnosezwecken und enthält keinerlei Informationen zu Sicherheit oder Prüfprotokoll.
Das Produkt log4j wird während der Installation von Workplace XT installiert. Standardmäßig ist die Protokollierung während der Installation nicht aktiviert.
So aktivieren oder inaktivieren Sie die Protokollierung:
Protokollierungseinstellungen konfigurieren
Die Musterdatei log4j.properties enthält eine Gruppe Standardoptionen, die als Schlüsselwort=Wert-Paare angegeben werden. Wenn Sie die Standardwerte ändern wollen, öffnen Sie log4j.properties mit einem Texteditor, führen Sie die gewünschten Änderungen aus und speichern Sie die Datei. Sie können die Protokollierungseinstellungen nach der Installation jederzeit konfigurieren. Änderungen, die Sie an der Protokollierungskonfigurationsdatei vornehmen, werden automatisch erkannt. Sie müssen dafür die Anwendung oder den Anwendungsserver nicht erneut starten.
Die folgenden Themen enthalten Informationen zu einigen Protokollierungskonfigurationsoptionen der Datei. Weitere Informationen zu Protokollierungsoptionen finden Sie auf der Apache-Website (http://apache.org) unter dem Protokollierungsprojekt und auf der Apache-Website für die Protokollierung (http://logging.apache.org/log4j/).
Protokollfunktion
Eine Protokollfunktion schreibt aktivierte Protokollierungsanforderungen in Appender. In der Datei log4j.properties beschreibt das erste Schlüsselwort die Stammprotokollfunktion. Die Stammprotokollfunktion ist die Protokollfunktion der höchsten Ebene in der Hierarchie und stellt globale Standardwerte bereit. Alle untergeordneten Protokollfunktionen, für die nicht explizit Optionen gesetzt wurden, übernehmen das Verhalten der Stammprotokollfunktion.
Appender
Sie können angeben, wohin Protokolldaten geschrieben werden, indem Sie einen Appender konfigurieren, der die formatierten Protokolleinträge an ein angegebenes Ausgabeziel sendet. Zieltypen können eine Datei oder die Konsole sein, die Ausgabe kann in ein Windows-Ereignisprotokoll umgeleitet, an einen fernen log4j-Server weitergeleitet werden und so weiter. (In der Apache log4j-Dokumentation finden Sie alle Ausgabeziele und Formatierungsoptionen.) Eine einzelne Protokollfunktion kann mehrere Appender haben. So können Sie beispielsweise die Ausgabe gleichzeitig in die Konsole und in eine Datei schreiben. Eine Erhöhung der Anzahl der Ziele kann jedoch die Leistung beeinträchtigen.
In Workplace XT sind standardmäßig zwei Appender konfiguriert. Ein Appender schreibt die Protokolldaten im IBM Common Base Event-Format (CBE-Format), das von den IBM Support Assistant-Tools für die Verarbeitung des Protokolls verwendet wird, und der andere Appender schreibt in einem Format, das vom Benutzer besser lesbar ist. Sie können diesen zweiten Appender ändern, um den Ausgabeumfang zu reduzieren, oder Sie können ihn ganz ausschalten.
Stufe
Die von Ihnen angegebene Protokollierungsstufe bestimmt den Typ und die Anzahl der Informationen, die erfasst werden. Zwischen der Anzahl der erfassten Informationen und dem Leistungseinfluss auf das System besteht eine direkte Korrelation.
Das Workplace XT-Anwendungsprotokoll unterstützt die Standardstufen INFO, WARN, ERROR und FATAL sowie die Stufen ALL und OFF. In der folgenden Tabelle werden die Standardstufen kurz beschrieben. Ausführliche Informationen zu Stufen finden Sie in Ihrer Apache log4j-Dokumentation.
Stufe | Beschreibung |
---|---|
INFO | Fordert Informationsnachrichten an, die den Fortschritt der Anwendung auf einer allgemeinen Ebene beschreiben. |
WARN | Fordert die Protokollierung für potenziell fehlerträchtige Situationen an. |
ERROR | Fordert die Protokollierung von Ausnahmebedingungen an, die in der Anwendung ausgelöst wurden. |
FATAL | Fordert nur die Protokollierung sehr schwerwiegender Fehlerereignisse an, die möglicherweise zum Ausfall der Anwendung führen können. |
Die angegebene Stufe bestimmt die Anzahl der erfassten Informationen. Zwischen der Anzahl der erfassten Informationen und dem Leistungseinfluss auf das System besteht eine direkte Korrelation.
Ausgabedateiformat
Bei der Konfiguration des Appenders können Sie das Schlüsselwort layout verwenden, um das Format anzugeben, in dem die Daten geschrieben werden sollen. Sie wählen ein Musterlayout (PatternLayout) und ein Umsetzungsmuster (ConversionPattern) aus. Das Musterlayout gibt ein bestimmtes Muster für Protokolleinträge an, das Umsetzungsmuster, das die Muster von Elementen angibt, die in den Appender geschrieben werden, definiert das Muster. Betrachten Sie dieses Beispiel:
log4j.appender.ErrorOutputFile=org.apache.log4j.RollingFileAppender log4j.appender.ErrorOutputFile.layout=org.apache.log4j.PatternLayout log4j.appender.ErrorOutputFile.layout.ConversionPattern=%d [%t] - %-5p %m\r\n
Das obige Beispiel führt zu dem folgenden formatierten Protokolleintrag:
2007-05-31 17:36:12:801 [cwrap] - Document/Checkin ConnectionWrapper.send send.before
Weitere Informationen zu Formatierungsoptionen finden Sie in Ihrer Apache log4j-Dokumentation.
Ausgabe analysieren
Die Benutzerunterstützung kann Einträge in einer Protokolldatei prüfen, um die Anwendungsaktivität zu analysieren und Probleme zu diagnostizieren, die in der Anwendung auftreten. Außerdem wird die Analysephase durch die Verwendung der IBM Support Assistant-Tools (ISA-Tools) automatisiert. Die ISA-Tools verarbeiten die CBE-Einträge in der Protokollausgabe von log4j.
Sie können auch ein Tool wie Apache Chainsaw, eine grafisch orientierte Protokollanzeigefunktion verwenden, um Protokolleinträge, die in einem anderen Format als CBE vorliegen, selbst zu prüfen.