Projekt

Allgemein

Profil

Log-Datei

Solltet jemand aufgefordert werden seine Logdatei zur Begehebung eines Fehlers zu schicken so ist folgendes zu beachten:

Was ist eine Log-Datei?

Eine Logdatei (engl. log file, auch Ereignisprotokolldatei genannt) enthält Informationen über den Programmablauf. Hiermit können Fehler im Programmablauf nachvollzogen werden.

Wo finde ich diese?

Grundsätzlich gibt es beim Radio Operator drei Log-Dateien, je nach Fehlerart ist eine andere relevant. Im Allgemeinen werdet ihr genau erfahren welche Log-Datei benötigt wird.

Die Dateien liegen alle in %appdata%\RadioOperator. Der Begriff %appdata% ist eine Umgebungsvariable die ihr genau so wie angegeben im Windows Explorer eingeben könnt. Sie zeigt bei Windows auf ein bestimmtes Verzeichnis abhängig vom angemeldeten Benutzter.

Eingabe von:

Wird automatisch ersetzt durch:

Was ist beim Erstellen der Log-Datei zu beachten?

Um detailiertere Informationen in der Logdatei zu haben ist das Log-Level anzupassen. Hierzu gibt es zwei Wege.

Wenn nur das Log-Level für die radiooperator.log angepasst werden muss, so kann dies bequem über den Radio Operator Admin gemacht werden.

Anpassen über Radio Operator Admin

Hierzu im Tab Allgemein auf "Loglevel..." klicken:

Anschließend (sofern man nicht als Administrator arbeitet) wird durch die Windows Benutzerverwaltung abgefragt für das Ändern des Loglevels Administratiorrechte zu bekommen, da die zu ändernde Datei sich im Programmverzeichnis befindet in welchem Schreibvorgänge ausschließlich als Administrator möglich sind.

Diese Meldung kann bestätigt werden.

Anschließend das Loglevel auf das gewünschte Level (gewöhnlich von ERROR auf DEBUG oder zurück) setzen:

Manuelles editieren

Das manuelle Editieren ist der Alternative Weg.

Sollte es Probleme mit dem Radio Operator Admin geben oder die update.log bzw. decoder.log soll ein anderes Loglevel erhalten so ist folgender Weg zu wählen.

radiooperator.log

Im Radio Operator Programmverzeichnis (üblicherweise C:\Programme\Radio Operator oder C:\Program Files (x86)\Radio Operator) befindet sich eine RadioOperator.exe.config Datei welche bearbeitet werden muss. Hierzu eigenet sich ein Texteditor wie bspw. das Windows-Notepad.

Das Level muss von ERROR/INFO oder DEBUG geändert werden um optimale Ergebnisse beim Fehlerreport zu erzielen.

Anpassen und Änderungen speichern:

decoder.log

Hierbei ist in der decoder.xml Datei, welche in %appdata%\RadioOperator liegt, INFO durch DEBUG zu ersetzen. Hierzu eigenet sich ein Texteditor wie bspw. das Windows-Notepad.

Anpassen und Änderungen speichern:

update.log

Hierbei sind keine Besonderheiten zu beachten, die Datei kann direkt so versendet werden.

Zeichensatz beachten

Wichtig ist, dass beim Speichern der abgeänderten Config Datei der Zeichensatz beachtet wird. Er muss wie ursprünglich UTF-8(BOM) sein.

Fehler reproduzieren und Versand

Nun gilt es den Fehler noch einmal zu reproduzieren damit er entsprechend in der Log-Datei aufgezeichnet werden kann.
Anschließend muss die Log-Datei entweder an den entsprechenden Fehler im Bug-Tracking-System angehängt werden oder per Mail an das Radio Operator Team geschickt werden. Auch hierbei ist eine möglichst detaillierte Bebschreibung des Fehler enorm wichtig.

Zurücksetzen des Levels

Es ist zu beachten, dass unter Umständen die Performance des Radio Operator durch eine dauerhafte Logleveleinstellung auf z.B. "DEBUG" sehr darunter leiden kann.
Des Weiteren können die dateien decoder.log, radiooperator.log schnell sehr groß werden und unnötig Speicherplatz belegen.
Daher ist es stehts zu empfehlen nach Lösung des Problemes das Loglevel wieder auf das ursprüngliche (gewöhnlich ERROR) zu ändern.