logback.xml
In diesem Thema wird kurz erläutert, wie Logging im AWI behandelt wird. Es wird außerdem beschrieben, wie Sie die Standardeinstellung für den Schweregrad der protokollierten AWI-Ereignismeldungen ändern können.
Konfiguration erforderlich?
Nein. Standardwerte sind in der gelieferten Version enthalten.
Verwandte AWI-Produkte
Das AWI-Framework und all seine Perspektiven.
Beschreibung
Die Protokollierung von AWI-Ereignisnachrichten erfolgt über das Logback Framework für Tomcat. Diese Protokollierung umfasst alles, was in AWI mit Ausnahme der Kommunikation mit der AE API geschieht. Die Angaben zum AWI-Logging sind in der Datei logback.xml definiert. Hier können Sie den niedrigsten Schweregrad der Nachrichten konfigurieren, die Sie nachverfolgen lassen möchten. Sie können diesen Wert ändern, sollten aber nichts anderes in der Datei ändern.
Der Schweregrad in der gelieferten Datei logback.xml ist auf DEBUG gesetzt. Für eine normale, funktionierende Produktionsumgebung sollten Sie ihn auf INFO ändern, damit die Performance nicht durch übermäßiges Logging beeinträchtigt wird.
Logging für die Fehlerberichterstattung
Informationen zu den verschiedenen Logging- und Tracing-Möglichkeiten in AWI, sowie Schritte zum Sammeln von Logdateien bei Fehlermeldungen an den CA Automic-Support finden Sie unter Vorbereiten von Logdateien für die Fehlerberichterstattung.
Die folgende Liste beschreibt die Einstellwerte für die Meldungsebene in der Reihenfolge des Schweregrades der Auslösesituationen:
-
ERROR
Zweck: Fehlgeschlagene Aktion einer AWI-Komponente, von der sich das AWI nicht erholen konnte.
Tracing-Daten in der Meldung: Keine den Benutzer identifizierenden Daten, mit Ausnahme des Benutzernamens. Hostnamen, andere standortspezifische Daten, Klassennamen, Objektnamen und dergleichen sind jedoch in den ereignisbezogenen Angaben enthalten. Die Nachricht enthält den vollständigen Stack-Trace.
-
WARNING
Zweck: Unerwartetes Verhalten einer AWI-Komponente, wie z. B. instabile Netzwerkverbindungen, die eine automatische Wiederherstellung der Verbindung des AWI, einen Wiederholungsversuch nach einem Timeout oder das Auslösen eines Workarounds für einen Bug eines Drittanbieters erfordern.
Tracing-Daten in der Meldung: Wie ERROR-Level, auch keine den Benutzer identifizierenden Daten.
-
INFO
Zweck: Konfigurationswerte beim Anmelden oder Hochfahren von Komponenten oder globale Konfigurationsänderungen.
Tracing-Daten in Meldung: Wie ERROR-Ebene, jedoch ohne vollständigen Stack-Trace. Auch keine den Benutzer identifizierenden Daten.
-
DEBUG
Zweck: Benutzerspezifische Aktionen auf hoher Ebene, wie z. B. An- und Abmeldeereignisse, Benutzeränderungen (z. B. Objektbearbeitung), autorisierungsbezogene Ereignisse (z. B. erfolgreiche und fehlgeschlagene Setup-Aktionen) und wichtige Leistungskennzahlen
Tracing-Daten in der Meldung: Ereignisbezogene Spezifikationen und möglicherweise Benutzerinformationen. Standardwert in logback.xml.
-
TRACE
Zweck: Benutzerspezifische Aktionen auf niedriger Ebene wie Navigation, Objekt öffnen, Tastenklicks, die Nutzlast von Backend-Aufrufen, interne Anwendungsereignisse und alle Aufrufe des Backends. Es enthält den Benutzer identifizierende Daten.
Tracing-Daten in der Meldung: wie DEBUG.
Speicherort der Datei
Wenn Sie das AWI installiert haben, finden Sie diese Konfigurationsdatei auf Ihrem -Anwendungsserver im Ordner ...\<AWI>\config.
Ändern der Standardeinstellung für den Schweregrad
- Wechseln Sie in Ihrem Anwendungsserver in den Ordner ...\<AWI>\config.
- Öffnen Sie die Datei logfile.xml, um sie zu bearbeiten.
- Ändern Sie die Log-Ebene für den Root-Appender.
- Suchen Sie nach 'ref="LOGGER" .'
- Eine Zeile darüber ändern Sie den Wert des Parameters <root level= value> auf den niedrigsten Schweregrad der Lognachrichten, die Sie für das AWI nachverfolgen lassen möchten. Weitere Informationen finden Sie unter Log-Ebenen.
Ändern Sie keine weiteren Parameter in der Datei, da dies die Untersuchung von Fehlersituationen für CA Automic unmöglich machen könnte.
- Damit die Änderungen wirksam werden, müssen Sie den Anwendungsserver stoppen und neu starten.
Aufbau
Die folgende Liste erklärt das Root-Element, in dem Sie die Log-Ebene für den LOGGER-Appender in der Datei logback.xml einstellen. Der Rest der Datei ist nicht beschrieben, da Sie sie nicht verändern sollten.
-
<root level="log_level">
Anfang des Root-Elements und Angabe des Attributs "level", wo Sie die Log-Ebene definieren. Weitere Informationen finden Sie unter Log-Ebenen.
-
<appender-ref ref="LOGGER" />
Identifiziert, dass dies das <Root>-Element für den LOGGER-Appender ist. Der LOGGER-Appender ist die Komponente, die die Logging-Ereignisse für AWI-Aktionen und -Ereignisse schreibt.
-
</root>
Ende des Root-Elements
Beispiel
Der folgende Code ist der Abschnitt der Datei logback.xml, in dem Sie die Root-Log-Ebene für die Anmeldung am AWI festlegen. Hier ist die Ebene auf "INFO" eingestellt, was der Standardwert ist und für eine Produktionsumgebung geeignet ist. Sie können dies ändern, z. B. in "DEBUG", wenn Sie umfangreichere Logdateien mit mehr Details zur Fehleranalyse benötigen.
<!-- Hier wird die Log-Ebene festgelegt. Mögliche Werte: TRACE, DEBUG, INFO, WARN, ERROR
DEBUG wird für Test- und Entwicklungsinstanzen empfohlen.
INFO wird für Produktionsinstanzen empfohlen.
-->
Somit werden zu viele Log-Einträge vermieden.
<appender-ref ref="LOGGER" />
</root>