Änderungen von Dokument Logging

Von Version < 17.8
bearbeitet von awa
am 20.05.2019, 13:53
Auf Version < 1.2 >
bearbeitet von gru
am 15.03.2019, 16:51
<
Änderungskommentar: Update document after refactoring.

Zusammenfassung

Details

Seiteneigenschaften
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.awa
1 +XWiki.gru
Inhalt
... ... @@ -1,71 +1,68 @@
1 1  {{content/}}
2 2  
3 -{{figure image="logging_1_de.png" width="600"}}
4 -Log-Nachrichten dienen der Nachvollziehbarkeit von Prozessen und ermöglichen eine Fehleranalyse. Jede Java-Klasse hat einen eigenen Logger und es ist frei konfigurierbar, welche Log-Meldungen ausgegeben werden sollen.
5 -{{/figure}}
3 +{{figure image="log_config.png"/}}
6 6  
7 7  In diesem Bereich können Sie das zentrale Logging der Applikation beeinflussen. Änderungen am Logging können zur Laufzeit, ohne Neustart der Applikation durchgeführt werden. Somit ist es möglich für einzelne Applikationsbereiche den Log-Level vorübergehend zu ändern, um beispielsweise Log-Daten für eine Fehleranalyse zu erhalten.
8 8  
9 -Eine gültige Logger-Konfiguration besteht dabei immer aus einem Logger und einem Logger-Ziel. Im Logger festgelegt wird dabei der Schweregrad sowie die einzubeziehenden Log-Nachrichten. Über Logger-Ziele wird schließlich festgelegt, in welchem Format und wohin die Log-Nachrichten geschrieben werden sollen (Konsole oder Datei).
7 +Eine gültige Log-Konfiguration besteht dabei immer aus einem //Logger// und einem// Log-Appender//. Im //Logger// wird dabei jeweils die Logging Prioritäts-Stufe sowie die Ziele der Logging-Meldungen, mittels //Log-Appender//, festgelegt. Die //Log-Appender// wiederum, definieren die möglichen Ausgabekanäle (unterstützt werden Konsole und Rolling-File), sowie die Ausgabeformatierung.
10 10  
11 11  == Nutzerinteraktionsmöglichkeiten ==
12 12  
13 -; Logger hinzufügen
14 -: Fügt einen neuen Logger zu den bestehenden hinzu. Die Bearbeitungsmaske für Logger wird angezeigt.
15 -; Logger-Ziel hinzufügen
16 -: Fügt ein neues Logger-Ziel zu den bestehenden hinzu. Die Bearbeitungsmaske für Logger-Ziele wird angezeigt.
17 -; Bearbeiten
18 -: Führt zur Bearbeitungsmaske für den selektierten Logger oder das Logger-Ziel.
19 -; Löschen
20 -: Löscht den selektierten Logger oder das Logger-Ziel.
11 +* **Logger hinzufügen**
12 +Fügt der Liste von //Loggern// einen Neuen hinzu. Die Bearbeitungsmaske für //Logger// wird angezeigt.
13 +* **Log Appender hinzufügen**
14 +Fügt der Liste von //Log-Appendern// einen Neuen hinzu. Die Bearbeitungsmaske für //Log-Appender// wird angezeigt.
15 +* **Bearbeiten**
16 +Führt zur Bearbeitungsmaske für den selektierten //Logger// oder //Log-Appender//.
17 +* **Löschen**
18 +Löscht nach erfolgreicher Bestätigung den selektierten //Logger// oder //Log-Appender//.\\
21 21  
22 22  {{info}}
23 -Hinweis: Der Root-Logger kann nicht gelöscht werden. Weiterhin können Logger-Ziele nur gelöscht werden, wenn sie von keinem Logger mehr verwendet werden.
21 +Hinweis: Der Root-Logger kann nicht gelöscht werden. Weiterhin können //Log-Appender// nur gelöscht werden, wenn sie von keinem //Logger// mehr verwendet werden.
24 24  {{/info}}
25 25  
26 -== Einrichten von Loggern ==
24 +== Logger Definition ==
27 27  
28 -{{figure image="logging_2_de.png"}}
29 -Ein Logger sammelt Log-Nachrichten, die ausgegeben werden sollen. Dabei kann sowohl Log-Level als auch ein Packetpfad eingestellt werden. Der Logger verwirft dann alle Log-Nachrichten aus anderen Packetpfaden oder niedrigerem Log-Level.
30 -{{/figure}}
26 +{{figure image="logger.png"/}}
31 31  
32 -; Name oder Packagepfad
33 -: Entweder ein konkreten Namen einer zu loggenden Klasse oder ein Packetpfad in Java, in dem sich die zu loggenden Klassen befinden.
34 -; Level
35 -: Die Begrenzung für den Schweregrad der Log-Nachrichten, die ausgegeben werden. Es gibt folgende Möglichkeiten, in aufsteigender Reihenfolge des Schweregrads: //ALL//, //DEBUG//, //INFO//, //WARN//, //ERROR//, //FATAL//, OFF//. Ist ein bestimmter Schweregrad eingestellt, werden automatisch auch alle Log-Nachrichten mit höherem Schwergrad ausgegeben.//
36 -; Logger-Ziele
37 -: Das Logger-Ziele, wohin die Log-Nachrichten geschrieben werden sollen. Hier werden alle angelegten Logger-Ziele aufgelistet.
38 -; Log-Scope an RootLogger vererben
39 -: Diese Option erlaubt es, den Log-Scope an den Root-Logger zu vererben. Das bedeudet, dass dann eine Log-Nachricht sowohl von diesem Logger als auch vom Root-Logger ausgegeben wird.
28 +* **Name oder Packagepfad**
29 +Definiert den konkreten Namen einer zu loggenden Klasse oder einen Java-Package-Pfad, der die zu loggenden Klassen enthält.
30 +* **Level**
31 +Definiert das durch den Logger zu verwendende Log-Level.
32 +Folgende Möglichkeiten sind gegeben: //ALL, DEBUG, INFO, WARN, ERROR, FATAL, OFF//
33 +(Die Log-Level sind in absteigender Reihenfolge angegeben, das heißt, übergeordnete Log-Level schließen automatisch untergeordnete Log-Level mit ein.)
34 +* **Logger-Ziele**
35 +Hier werden alle definierten //Log-Appender// aufgelistet und können als Log-Ziele festgelegt werden.
36 +* **Log-Scope an RootLogger vererben**
37 +Diese Option erlaubt es den Log-Scope an den Root-Logger zu vererben.
40 40  
41 -== Einrichten von Logger-Zielen ==
39 +== Einrichten von Log-Appendern==
42 42  
43 -{{figure image="logging_3_de.png" width="300"}}
44 -Ausgabe von Log-Nachrichten auf der Konsole. Hierbei werden die Log-Nachrichten als Ausschrift auf der Konsole verwendet, die beim Starten des Anwendungsservers verwendet wurde.
45 -{{/figure}}
41 +{{figure image="appender_console.png" width="300" title="Beispiel für einen Konsolen-Log-Appender"/}}
46 46  
47 -{{figure image="logging_4_de.png" width="300"}}
48 -Ausgabe von Log-Nachrichten in einer Datei. Hierbei kann eingestellt werden, unter welchem Pfad die Datei abgelegt werden soll. Zudem kann auch die Dateigröße begrenzt werden, um den verfügbaren Speicherplatz des Servers nicht zu überschreiten.
49 -{{/figure}}
43 +{{figure image="appender_file.png" width="300" title="Beispiel für einen Rolling-File Log-Appender"/}}
50 50  
51 -; Typ
52 -: Gibt die Art des Logger-Ziels an. Unterstützt wird //Console// (Ausgabe auf die Konsole) und //RollingFile// (Ausgabe in eine Datei)
53 -; Name
54 -: Name für das Logger-Ziel. Dieser muss eindeutig sein. Zwei Logger-Ziele dürfen nicht den gleichen Namen haben.
55 -; Log-Level-Begrenzung
56 -: Legt für das Logger-Ziel eine Begrenzung des Log-Levels fest. Es gibt folgende Möglichkeiten: //Keine Begrenzung//, //DEBUG//, //INFO//, //WARN//, //ERROR//, //FATAL//
57 -; Layout_Typ
58 -: Legt den Layout Typ für das Logger-Ziel fest. Unterstützt wird aktuell das sogenannten Pattern-Layout. Das zur Anwendung kommende Pattern wird im Feld //Layout-Pattern// angezeigt.
45 +* **Appendertyp**
46 +Definiert den Log-Appender Typ. Unterstützt wird Console und RollingFile
47 +* **Name**
48 +Name für den Log-Appender, muss eindeutig sein.
49 +* **Log-Level Begrenzung**
50 +Legt für den Log-Appender eine Begrenzung des Log-Levels fest
51 +Folgende Möglichkeiten sind gegeben: //Keine Begrenzung, DEBUG, INFO, WARN, ERROR, FATAL//
52 +* **Layout_Typ**
53 +Legt den Layout Typ für den Log-Appender fest. Unterstützt wird aktuell das 'Pattern' Layout.
54 +Das zur Anwendung kommende Pattern wird im Feld **Layout-Pattern** angezeigt.
59 59  
60 -Die nachfolgend beschriebenen Felder sind nur bei einem Logger-Ziel vom Typ //RollingFile// zu vorhanden:
56 +Die nachfolgend beschriebenen Felder sind nur bei einem //Log-Appender// vom Typ //RollingFile// zu definieren:
61 61  
58 +* **Datei**
59 +Legt Dateipfad und Namen der Log-Datei fest.
60 +
62 62  {{info}}
63 63  Hinweis: Der Dateipfad muss im Dateisystem existieren und der Nutzer, in dessen Kontext die Applikation ausgeführt wird, muss Schreibrechte auf dieses Verzeichnis haben.
64 64  {{/info}}
65 65  
66 -; Datei
67 -: Legt Dateipfad und Namen der Log-Datei fest.
68 -; Maximale Dateigröße
69 -: Legt die maximal erreichbare Dateigröße fest, bevor eine neue Datei angelegt wird.
70 -; Maximale Anzahl von Backupdateien
71 -: Legt die maximale erreichbare Anzahl von Backup-Logdateien fest. Wird diese Anzahl überschritten, wird die die älteste Backupdatei gelöscht.
65 +* **Maximale Dateigröße**
66 +Legt die maximal erreichbare Dateigröße fest, bevor eine neue Datei angelegt wird.
67 +* **Maximale Anzahl von Backupdateien**
68 +Legt die maximale erreichbare Anzahl von Backup-Logdateien fest. Wird diese Anzahl überschritten, wird die die älteste Backupdatei gelöscht.
logging_1_de.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.ximaadmin
Größe
... ... @@ -1,1 +1,0 @@
1 -57.9 KB
Inhalt
logging_1_en.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.ximaadmin
Größe
... ... @@ -1,1 +1,0 @@
1 -59.6 KB
Inhalt
logging_2_de.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.ximaadmin
Größe
... ... @@ -1,1 +1,0 @@
1 -54.6 KB
Inhalt
logging_2_en.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.ximaadmin
Größe
... ... @@ -1,1 +1,0 @@
1 -54.4 KB
Inhalt
logging_3_de.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.ximaadmin
Größe
... ... @@ -1,1 +1,0 @@
1 -59.7 KB
Inhalt
logging_3_en.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.ximaadmin
Größe
... ... @@ -1,1 +1,0 @@
1 -59.2 KB
Inhalt
logging_4_de.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.ximaadmin
Größe
... ... @@ -1,1 +1,0 @@
1 -71.3 KB
Inhalt
logging_4_en.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.ximaadmin
Größe
... ... @@ -1,1 +1,0 @@
1 -71.5 KB
Inhalt
FCSnapshot10.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.gru
Größe
... ... @@ -1,0 +1,1 @@
1 +42.3 KB
Inhalt
FCSnapshot11.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.gru
Größe
... ... @@ -1,0 +1,1 @@
1 +23.6 KB
Inhalt
FCSnapshot12.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.gru
Größe
... ... @@ -1,0 +1,1 @@
1 +32.0 KB
Inhalt
FCSnapshot13.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.gru
Größe
... ... @@ -1,0 +1,1 @@
1 +24.2 KB
Inhalt
appender_console.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.gru
Größe
... ... @@ -1,0 +1,1 @@
1 +24.0 KB
Inhalt
appender_file.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.gru
Größe
... ... @@ -1,0 +1,1 @@
1 +31.6 KB
Inhalt
log_config.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.gru
Größe
... ... @@ -1,0 +1,1 @@
1 +38.5 KB
Inhalt
logger.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.gru
Größe
... ... @@ -1,0 +1,1 @@
1 +19.0 KB
Inhalt

Navigation

Copyright 2000-2024