|
|
| Zeile 1: |
Zeile 1: |
| − | == Einleitung ==
| + | #REDIRECT [[Technische Konzepte: Logger]] |
| − | | + | |
| − | Für diverse Stellen in einem Programm muss es möglich sein bestimmte Schritte zu loggen. Das heißt konkret es werden Informationen, in welcher Form auch immer, gespeichert und protokolliert.
| + | |
| − | Welche Informationen und wie viel protokolliert wird legt ein sog. LogLevel fest. Beim Entwicklen soll z.B. möglichst viel geloggt werden, im echten Betrieb nur wichtige Fehler.
| + | |
| − | | + | |
| − | == LogLevel ==
| + | |
| − | | + | |
| − | Für unser relativ kleines Projekt sind, denke ich, nicht viele LogLevel notwendig.
| + | |
| − | * Debug
| + | |
| − | Das DebugLevel ist für Meldungen gedacht die eher zum Programmablauf gedacht sind, um zu verstehen wie ein Fehler auftreten kann. Es muss hier also kein konkreter Fehler direkt damit in Verbindung stehen.
| + | |
| − | * Info
| + | |
| − | Das Info-Level ist für Informationen gedacht, die auch eher den Programmablauf protokollieren, aber auch für den Anwender von Bedeutung sind. (Z.b. irgendwelche Verzweigungen, die zwar unvorhergesehen sind, das Programm aber durchaus weiterlaufenn kann --> Eine Variable kann nicht gelesen werden, es wird eine StandardVariable benutzt)
| + | |
| − | Das Info-Level ist standardmäßig eingestellt!
| + | |
| − | * Error
| + | |
| − | Wird ein Error geloggt, dann handelt es sich um einen kritischen Fehler, das Programm (oder die gerade benutzte Funktion) kann so nicht weiter benutzt werden. Ein Error manifestiert sich außerdem zusätzlich in einem Fehlerfenster, das dem Nutzer angezeigt wird. (Z.b. damit nicht einfach das Programm ohne Fehlermeldung abschmiert!)
| + | |
| − | | + | |
| − | == Auf welche Arten wird geloggt? ==
| + | |
| − | | + | |
| − | Der Logger gibt einerseits eine Meldung an die Konsole und außerdem wird ein Log-File erstellt.
| + | |
| − | Im besonders kritischen Fall wird außerdem ein GUI-Error-Fenster angezeigt, dass dem Nutzer den Fehler direkt präsentiert.
| + | |
| − | | + | |
| − | An dieser Stelle soll nochmal betont werden, dass wirklich nur geloggt wird wenn das LogLevel stimmt. Das LogLevel muss mindestens genauso "schlimm" sein oder noch "schlimmer" als das, was im Logger eingestellt ist.
| + | |
| − | | + | |
| − | Das LogLevel kann im laufenden Betrieb geändert werden.
| + | |
| − | | + | |
| − | == Welche Methoden stellt der Logger bereit? ==
| + | |
| − | | + | |
| − | Es gibt zum einen verschiedene Methoden um z.B. das LogLevel zu ändern oder den Dateipfad für die LogDatei.
| + | |
| − | | + | |
| − | Viel wichtiger sind die beiden Methoden zum eigentlichen loggen.
| + | |
| − | Zum einen gibt es die Methode "log" mit 2 Parametern. Wird diese Methode verwendet wird nur das LogLevel benötigt für das diese LogNachricht bestimmt ist und mit dem zweiten Parameter wird die eigentliche LogMessage angegeben.
| + | |
| − | | + | |
| − | Über diese Methode hinaus gibt es die Methode "log" mit insgesamt 5 Parametern. Diese enthält die beiden, wie sie eben beschrieben wurden und zusätzlich verschiedene Angaben, die die Meldung näher spezifizieren. Es kann ein bestimmter "Header" für die Error Nachricht angegeben werden, die dem User Grafisch bei einem Error präsentiert wird. Es kann ein Klassenname (als String) und eine Exception als Objekt übergeben werden.
| + | |
| − | Sollte ein Parameter mit null oder leer ("") belegt sein, so wird dieser ignoriert.
| + | |
| − | | + | |
| − | == Wo ist der Logger zu finden? ==
| + | |
| − | | + | |
| − | Der Logger ist Bestandteil des Jar-Files "tools", dass auch noch den ConfigManager beherbergt.
| + | |
| − | Das Paket ist mit einer Classpath Variable bereits in unserem Projekt eingebunden.
| + | |
| − | Er kann einfach mit Logger.xx (xx für die entsprechende Methode) benutzt werden. Wobei aufgepasst werden muss dass auch unser Logger verwendet wird (Auswahlliste in Eclipse). Das der Logger statisch ist muss nichts initialisiert werden. Es sollte aber das LogLevel nur an einer zentralen Stelle geändert werden (z.b. gleich in der Starter-->main)
| + | |
| − | | + | |
| − | Der Logger benutzt Standardmäßig das LogLevel INFO
| + | |
