WebAdmin bietet zu Diagnosezwecken die Möglichkeit, Informationen über den Programmablauf in Dateien aufzuzeichnen. WebAdmin verwendet für die Logging-Funktionen das Java Logging-Framework Log4j2. Die Konfigurationseinstellungen des Log4j2-Frameworks stehen in der Datei WebAdmin.log4j2.properties.xml , die sich im UtmWebAdmin/app/config Verzeichnis unterhalb des WebAdmin-Installationsverzeichnisses befindet.
WebAdmin verwendet zum Abspeichern der Tracesätze einen Mechanismus, der mehrere Logging-Dateien erzeugt. Angegeben werden dabei die Haupt-Logging-Datei, die Anzahl von Backup- Dateien und die maximale Größe einer Logging-Datei.
Funktionsweise:
Der Mechanismus erzeugt und benötigt im Betrieb die Verwaltungsdatei <File>.gen , also im Standardfall UtmWebAdmin/app/logs/logging.txt.gen .
Er schreibt aktuell immer in die Logging-Datei <File> . Beim Umschalten wird die Datei <File> umkopiert in eine Backup-Datei mit dem Namen
<FilePrefix>.<nächste-Dateigeneration>.<FileSuffix> , und die Datei <File> wird wieder von vorne beschrieben.
Gibt es danach mehr Backup-Dateien als durch <MaxNbrBackupFiles> angegeben, und ist <MaxNbrBackupFiles> größer als 0, dann werden beim Umschalten die ältesten überzähligen Dateien gelöscht.
Beispiel für <MaxNbrBackupFiles>=3
Situation vor dem Umschalten:
logging.txt | (in Benutzung) |
logging.13.txt | (älteste Backup-Datei) |
logging.14.txt | |
logging.15.txt | (neueste Backup-Datei) |
Beim Umschalten wird logging.txt in logging.16.txt umkopiert, logging.13.txt wird gelöscht und danach logging.txt wieder beschrieben.
Situation nach dem Umschalten:
logging.txt | (in Benutzung) |
logging.14.txt | (älteste Backup-Datei) |
logging.15.txt | |
logging.16.txt | (jüngste Backup-Datei, vorherige logging.txt) |
In diesem Fall ist das <FilePrefix> "logging" und das <FileSuffix> "txt". Ein File Suffix hat immer genau drei Zeichen und ist durch einen Punkt vom File Prefix getrennt.
WebAdmin wird mit drei verschiedenen Logging-Konfigurationen ausgeliefert.
Diese befinden sich im Verzeichnis <WebAdmin-Installationsverzeichnis>/UtmWebAdmin/app/config und haben die Namen WebAdmin.log4j2.properties_default.xml , WebAdmin.log4j2.properties_error.xml und WebAdmin.log4j2.properties_debug.xml . Die jeweils verwendete Konfiguration steht in der Datei WebAdmin.log4j2.properties.xml .
Um eine andere Logging-Konfiguration zu verwenden, muss man lediglich die Datei WebAdmin.log4j2.properties.xml löschen, die gewünschte Konfigurationsdatei kopieren und in WebAdmin.log4j2.properties.xml umbenennen. Dies sollte gemacht werden, wenn der Web-Server nicht läuft.
Die einzelnen Konfigurationsdateien im Detail:
WebAdmin.log4j2.properties_default.xml
Nach der Installation ist der Inhalt dieser Datei der gleiche wie der der DateiWebAdmin.log4j2.properties.xml. Diese Logging-Konfiguration hat den geringsten Trace-Umfang.
WebAdmin.log4j2.properties_errort.xml
Diese Logging-Konfiguration hat einen mittleren Trace-Umfang und kann zur Diagnose von Fehlern in der Web-Anwendung aktiviert werden.
WebAdmin.log4j2.properties_debug.xml
Diese Logging-Konfiguration hat einen sehr hohen Trace-Umfang. Unter anderem sind hier auch alle UPIC-Traces aktiviert, die von den UTM-Anwendungen empfangen werden, protokollieren. Sie sollte nur in bestimmten Situationen zur Fehlerdiagnose aktiviert werden.
Achtung: WebAdmin als Windows-Dienst schreibt das Logging ins Verzeichnis apache-tomcat\logs