IES-Admin (web) Logging

Das Protokollierungs-System des IES. Alle Ereignisse und Aktionen des IES können protokolliert werden. In welcher Form das geschehen soll, kann in diesem Bereich konfiguriert werden. Die Konfiguration des Loggings wird über die Definition von Appendern und Loggern vorgenommen.

Um in den Logging-Bereich zu wechseln, klicken Sie bitte den Menüpunkt 'Logging' und im Untermenu den Bereich Logger bzw. Appender an.

Appender

Über die Appender werden die Ausgabe-Kanäle definiert, in denen die Logging-Einträge protokolliert werden sollen. Die Ausgabe kann in einer Datei erfolgen, um sie für längere Zeit vorzuhalten oder die Logging-Einträge werden nur im Speicher gehalten, um aktuelle Aktionen zu verfolgen. Folgende Appender stehen zur Verfügung:

ConsoleAppender

Dieser Appender schreibt alle Logging-Einträge in die Standard-Ausgabe. Dieser wird vom IES in eine Datei gelenkt (SITEPARK_HOME/ies.out). Dieser Appender ist für Systemausgaben vorgesehen und kann nicht konfiguriert werden.

FileAppender

Dieser Appender schreibt alle Logging-Einträge in eine Datei. Hierbei ist zu beachten, dass es für die entstehende Log-Datei keine Obergrenze für dessen Größe gibt. Dieser Appender sollte nur für Logging-Einträge verwendet werden, die selten vorkommen.

RollingFileAppender

Dieser Appender schreibt alle Logging-Einträge in eine Datei. Es kann aber bestimmt werden wie groß die Datei maximal sein darf. Ist die maximale Größe der Datei erreicht, wird diese Log-Datei umbenannt und der Appender schreibt in einer neuen Datei weiter. Die Anzahl der Log-Datei Backups kann ebenfalls angegeben werden. So kann ein maximaler Speicherplatz definiert werden, den die Log-Dateien auf der Festplatte einnehmen dürfen.

DailyRollingFileAppender

Dieser Appender schreibt alle Logging-Einträge in eine Datei. Es kann bestimmt werden, wann eine neue Datei für das Logging angelegt werden soll. Es besteht die Möglichkeit eine neue Datei

jeden Monat
jede Woche
jeden Tag
zweimal am Tag
jede Stunde
jede Minute

anzulegen. Die alte Datei wird umbenannt. Der Dateiname enthält einen Zeitstempel.

MemoryAppender: Dieser Appender schreibt alle Logging-Einträge in eine Liste im Speicher. Um die Anzahl der Listen nicht unnötig anwachsen zu lassen, kann sie begrenzt werden. Weiterhin ist es möglich einen Filter mit Hilfe von regulären Ausdrücken anzugeben, um die Logging-Einträge weiter zu begrenzen.

Appender anlegen

Nach einem Klick auf die 'Neuen Appender anlegen'-Schaltfläche erscheint ein Menü in dem Sie auswählen können, welcher Appender-Typ angelegt werden soll. Je nach gewählten Appender öffnet sich ein Fenster mit folgenden Eingabefeldern:

Name

Der Name des Appenders muss eindeutig sein und wird auch für die Verknüpfung zwischen Appender und Logger verwendet. Ein Appender-Name sollte nur aus Großbuchstaben und Unterstrichen (_) bestehen.

Log-Datei

Datei, in der die Logging-Einträge geschrieben werden sollen. Die Datei wird angelegt, wenn sie noch nicht existiert. Das Verzeichnis der Log-Datei muss existieren und der IES muss Lese- und Schreibrechte auf dieses Verzeichnis haben.

Nach Neustart die nächsten Einträge anhängen

Ist diese Checkbox gesetzt, werden nach einem Neustart des IES-Prozesses die Logging-Eingträge in die vorhandenen Log-Datei geschrieben. Andernfalls wird die alte Logdatei überschrieben.

Maximale Dateigröße

Maximale Dateigröße in Bytes, die die Log-Datei haben darf. Angaben wie 10MB, 128KB, usw. sind erlaubt.

Maximale Backup Dateien

Anzahl der maximalen Backup Dateien die für diesen Appender erzeugt werden dürfen.

Neue Datei anlegen

Zeitraum, in dem die aktuelle Log-Datei umbenannt und eine neue Log-Datei angefangen werden soll. Mögliche Zeiträume sind:

jeden Monat
jede Woche
jeden Tag
zweimal am Tag
jede Stunde
jede Minute

Maximale Anzahl von Einträgen: Anzahl der Maximalen Logging-Einträge die vorgehalten werden sollen.
Filter: Regulärer Ausdruck mit dem definiert werden kann welche Logging-Einträge aufgenommen werden sollen.

Klicken Sie auf die 'speichern'-Schaltfläche, um den Appender anzulegen.

Appender bearbeiten

Wählen Sie einen Appender aus der Appender-Tabelle aus und klicken Sie die 'Appender bearbeiten'-Schaltfläche, um den Dialog zu öffnen.

Für den ausgewählten Appender können nun die schon in IES-Admin (web) Logging#Appender anlegen beschriebenen Eingabefelder konfiguriert werden.

Klicken Sie auf die 'speichern'-Schaltfläche, um die Änderungen zu speichern.

2.9.1.3. Appender löschen

Wählen Sie einen Appender oder mehrere Appender aus der Appender-Tabelle aus und klicken Sie die 'Appender löschen'-Schaltfläche.

Bestätigen Sie die Sicherheitsabfrage, um den oder die Appender zu löschen. Sollten noch Logger mit den gelöschten Appendern verknüpft sein, so werden diese Verknüpfungen aufgehoben. Diese Logger sind dann nicht mehr aktiv.

2.9.2. Logger

Der IES erzeugt bei jeder Aktion und bei jedem Ereignis eine Vielzahl von Log-Einträgen. Würden alle Log-Einträge verarbeitet und z.B. in eine Log-Datei geschrieben, würde diese Datei in kurzer Zeit sehr stark anwachsen. Um das zu verhindern gibt es zwei Möglichkeiten diese Log-Einträge zu filtern.

Filterung durch den Logger-Namen: Die Programmteile des IES, die die Log-Einträge erzeugen sind hierarchisch organisiert. Diese Hierarchie spiegelt sich in den Namen der Logger wieder. Wird beispielsweise ein Logger mit dem Namen com.sitepark.iesangelegt, werden alle Log-Einträge des IES von diesem Logger berücksichtig. com.sitepark.ies ist die oberste Ebene der IES-Logger Einträge. Soll der Logger nur Log-Einträge, die die Dienste betreffen verarbeiten, müsste der Name des Loggers wie folgt lauten: com.sitepark.ies.serviceslauten. Eine willkürliche Wahl des Logger-Namens macht also keinen Sinn, da nur Log-Einträge von den Loggern aufgenommen werden, die in der angegebenen Hierarchie liegen. Folgende Logger-Namen sind für die IES-Log-Einträge sinnvoll.

`com.sitepark.ies`	Alle Log-Einträge die der IES erzeugt.
`com.sitepark.ies.spel`	Log-Einträge, die die Sitepark Expression Language betreffen
`com.sitepark.ies.model`	Log-Einträge, die die EntityBean und Datenbank-Schicht betreffen
`com.sitepark.ies.services`	Log-Einträge, die die Services betreffen
`com.sitepark.ies.startup`	Log-Einträge, die die Start und Stop Prozeduren sowie die IES-Server Verwaltung betreffen
`com.sitepark.ies.control.ejb`	Log-Einträge, die die Kernel-Handler des IES betreffen
`com.sitepark.ies.control.jsp`	Log-Einträge, die die Web-Handler des IES betreffen
`com.sitepark.ies.startup`	Log-Einträge, die die Start und Stop Prozeduren sowie die IES-Server Verwaltung betreffen
`com.sitepark.ies.taglib`	Log-Einträge, die die Taglibraries der SPML betreffen.
`com.sitepark.ies.vo`	Log-Einträge, die die Value Objects des IES betreffen.
`com.sitepark.ies.http`	Wird dieser Logger auf das Debug-Level `DEBUG` gesetzt, können die Request-Parameter von Requests, die an den IES gesendet werden ausgegeben werden. Um die Ausgabe zu aktivieren muß noch ein Request-Parameter `SYS_requestdebug` mitgesendet werden. Wird der Wert des Parameters auf `session` gesetzt, werden alle nachfolgenden Requests mit der Sitzung ausgegeben. Wird der Wert des Parameters auf `application` gesetzt, werden alle Requests, die an die Applikation (Modul) gehen, ausgegeben

Filterung durch den Logger-Level: Eine weitere Möglichkeit Log-Einträge zu filtern ist der Logger-Level. Jeder Log-Eintrag hat einen bestimmten Level, der die Gewichtung des Eintrags bestimmt. Diese Level sind:

TRACE Einträge mit diesem Level enthalten erweiterte Debug-Informationen für die Entwicklung, die im normalen Betrieb nicht angezeigt werden sollten, da sie Einflüsse auf die Performanz haben können. DEBUG Einträge mit diesem Level enthalten Debug-Informationen, die bei Fehlersuche behilflich sein können. WARN Einträge mit diesem Level enthalten Warnungen. Warnungen sind vom Server festgestellte unkritische Missstände oder ungültige Nutzeraktionen die den weiteren Betrieb des IES nicht beeinflussen. INFO Einträge mit diesem Level enthalten Meldungen des Servers über seine ausgeführten Aktionen. ERROR Einträge mit diesem Level enthalten Fehler. Fehler entstehen durch fehlerhafte Programmteile, falsche Verwendung von IES Funktionalitäten oder falsche Nutzeraktionen. Fehler verhinden den erfolgreichen Abschluss einer Aktion, sollten aber den weiteren Betrieb des IES nicht beeinflussen. FATAL Einträge mit diesem Level enthalten fatale Fehler. Ein Fehler dieser Kategorie verhindert in den meisten Fällen den weiteren Betrieb des IES. Erst nach Behebung des Fehlers ist der Betrieb eines funktionsfähigen IES sichergestellt.Ein Logger mit einem bestimmten Level übernimmt nicht nur die Log-Einträge dieses Levels, sondern auch alle Einträge mit den darunter liegenden Leveln. Besitzt ein Logger z.B. den Level INFO werden von dem Logger alle Log-Einträge entgegengenommen, die die Level INFO, ERROR und FATAL haben. Bei einem Logger mit dem Level DEBUG werden alle Log-Einträge mit den Leveln DEBUG, WARN, INFO, ERROR, FATAL entgegengenommen.

Für die Verarbeitung der vom Logger definierten Log-Einträge sorgt der Appender. Jeder Logger kann mit einem oder mehren Appendern verknüpft werden, um damit zu bestimmen, was mit den Log-Einträgen passieren soll. Wird der Logger mit einem FileAppender verknüpft, werden die Log-Einträge in eine Datei geschrieben. Bei der Verknüpfung des Loggers mit einem MemoryAppender werden die Log-Einträge in einer Liste im Speicher gehalten.

Logger anlegen

Nach einem Klick auf die 'Neuen Logger anlegen'-Schaltfläche erscheint ein Dialog. Wählen Sie dort 'Logger' aus um einen Logger anzulegen. Vergeben Sie dann einen Namen für den Logger. Dieser Name ist nicht beliebig Er sollte aus der oben angegebenen Tabelle entnommen werden. Um zu bestimmen wie die Log-Einträge verarbeitet werden , sind ein oder mehrere Appender auszuwählen. Sollte kein Appender ausgewählt sein, werden die Log-Einträge nicht verarbeitet. Mit der Auswahl des Levels wird entschieden, ab welchem Level die Log-Einträge berücksichtig werden.

Logger bearbeiten

Wählen Sie einen Logger aus der Logger-Tabelle aus und klicken Sie die 'Logger bearbeiten'-Schaltfläche, um das Bearbeitungsfenster zu öffnen.

Sie können nun Appender hinzufügen oder entfernen und den Level des Loggers ändern.

Klicken Sie auf die 'speichern'-Schaltfläche, um die Änderungen zu speichern.

Logger löschen

Wählen Sie einen Logger oder mehrere Logger aus der Logger-Tabelle aus und klicken Sie auf die 'Logger löschen'-Schaltfläche.

Bestätigen Sie die Sicherheitsabfrage, um den oder die Logger zu löschen.