Fehlersuche (Logging)

FE2 protokolliert alle Ereignisse in Protokolldateien (sogenannten Log-Dateien). Im Fehlerfall können Sie darüber jederzeit nachvollziehen, was FE2 zu welcher Zeit getan hat.

Speicherort der Log-Dateien

Log-Dateien werden pro Tag als Textdatei abgelegt. Die Log-Datei des aktuellen Tages heißt immer log.txt. Log-Dateien von älteren Tagen werden inklusive Datum abgespeichert. Die maximale Größe einer einzelnen Datei beträgt standardmäßig 3 Megabyte. Sind mehr Logmeldungen an einem Tag erstellt worden, als in eine Datei mit 3 Megabyte passen, so werden fortlaufende Log-Dateien erstellt. Diese haben am Ende des Dateinamen fortlaufende Zahlen (beginnend bei 0). Je größer diese Zahl ist, desto aktueller ist die Datei.

Der Speicherort der Logdateien ist C:\ProgramData\Alamos GmbH\FE2\Logs

Das Verzeichnis ProgramData kann unter Umständen versteckt sein. Hier wird erklärt, wie Sie dieses wieder einblenden können.

Aufbau einer Log-Meldung

Einzelne Einträge werden folgendermaßen aufgebaut:

Datum - Uhrzeit [Level] |Alarm-Nummer| [Thread] Komponente - Eigentliche Meldung

Datum	Der Tag, an dem die Meldung protokolliert wurde
Uhrzeit	Die genaue Uhrzeit der Meldung
Level	Die Stufe der Meldung (Log-Level)
Alarm-Nummer	Falls die Log-Meldung zu einem Alarm protokolliert wurde, erscheint hier die Nummer des Alarms
Thread	Welcher Prozess den Eintrag ausgelöst hat
Komponente	Die Komponente welche den Eintrag erstellt hat

Das Log-Level verstehen

Das Log-Level gibt an, wie viele Informationen protokolliert werden. Je höher das Level, desto weniger wird protokolliert, desto weniger Speicherplatz wird verwendet und desto weniger belastet das Logging das System. Je kleiner das Level, desto mehr Informationen sind enthalten. Das Standard-Level ist INFO.

TRACE	Niedrigste Stufe. Hier werden alle Informationen (wirklich alle!) mit protokolliert. Nur für Test-Zwecken empfohlen
DEBUG	Normale "Fehler"-Stufe. Hier werden alle Informationen zur konkreten Fehlersuche mit protokolliert.
INFO	Normale Stufe. Hier werden nur für den Benutzer wichtige Informationen mit protokolliert.
WARN	Warnung vor möglichen Fehlern
ERROR	Fehler, die während des Programmablaufes aufgetreten sind. Hier wird am wenigsten protokolliert.

Sollten Sie Fehler an uns melden wollen, so ist es zwingend erforderlich, dass eine Log-Datei im Level DEBUG bereitgestellt wird, da nur in diesem Level genügend Informationen zur Fehleranalyse enthalten sind.

Das Log-Level ändern

Um Fehler besser analysieren zu können, ist es von Zeit zu Zeit nötig, das Log-Level zu ändern.

Das Log-Level im Browser ändern

Sie können über die Weboberfläche jederzeit das Log-Level ändern. Die Änderung wird in der Datenbank gespeichert und bei einem Neustart von FE2 wieder übernommen. Einzelne Log-Zeilen direkt beim Start von FE2 sind allerdings davon nicht betroffen, da zu diesem Zeitpunkt die Verbindung zur Datenbank noch nicht aufgebaut ist. Für diese Fälle sehen Sie bitte im nächsten Abschnitt “Das Log-Level per Datei ändern” nach.

Die Einstellung, die in Browser getätigt wird, ist nach dem Start von FE2 die vorgebende Einstellung. Anpassungen des Log-Levels in der logback.xml haben nur Auswirkungen auf den oben beschriebenen Teil des Startprozesses.

Das Log-Level per Datei ändern

Wenn Sie das Log-Level für eine Fehleranalyse direkt beim Start von FE2 ändern müssen, so müssen Sie dies in einer speziellen Datei anpassen. Sie finden diese Datei standardmäßig unter: C:\Program Files\Alamos GmbH\FE2\files\logback.xml

Existiert die logback.xml Datei im Konfigurationsverzeichnis, so muss diese Datei angepasst werden!

Öffnen Sie diese Datei mit einem Editor Ihrer Wahl (ggf. mit Administrator-Rechten) und scrollen Sie ganz an das Ende der Textdatei. Hier müssen Sie das level Feld des Elementes root ändern:

...
   <root level="info">
     <appender-ref ref="FILE" />
   </root>
...

Um das Log-Level zum Beispiel auf DEBUG zu setzen, ändern Sie den Wert wie folgt:

...
   <root level="debug">
     <appender-ref ref="FILE" />
   </root>
...

Kundensysteme, die FE2 vor der Version 2.29.590 bereits installiert hatten und nun auf einer Version >2.29.590 sind, haben die logback.xml bereits in Ihrem Konfigurationsverzeichnis und können diese, wenn gewünscht, löschen, da diese nur noch in Ausnahmefällen benötigt wird.

Wiederherstellen der Datei

Sollte Ihre Log-Datei defekt sein oder etwas nicht mehr richtig geloggt werden, so können Sie hier die standardmäßig ausgelieferte Datei herunterladen:

Handbuch