Logging-Einstellungen
| Zugehörige Informationen | |||
| Datei, Bearbeitungsbereiche, Datenbank, Extras, Hilfe | Grundlegegendes zur Bedienung | — | — |
| Administrator-Client öffnen, Importieren, Repository-Services, Kontroll- und Reparatur-Services, Logging-Einstellungen, Übersichten | |||
Fachlich/inhaltliche Beschreibung
Die Programmkomponenten von ASYS sind einheitlich mit der Programmablaufprotokollierungsbibliothek Log4j ausgestattet. Log4j bietet umfangreiche Einstellungsmöglichkeiten, die für Einsteiger nicht leicht zu verstehen sind. Daher ist in den Administrator ein Dialog integriert worden, über den eine vereinfachte Konfiguration für Log4j ermöglicht wird. Für Eingeweihte besteht dennoch die Möglichkeit, die Log4j-Einstellungen über diesen Dialog manuell zu optimieren. Geänderte Log-Konfigurationen werden erst bei einem vollständigen Neustart einer Komponente wirksam (bei einer Server-Komponenten reicht daher z.B. das Anhalten und Neustarten nicht).
Sie müssen die Einstellungen für das Logging für ASYS V7.12 einmal neu vornehmen!
Wegen eines sicherheitskritischen Problems in den Log4j-Bibliotheken der Versionsreihe 1.x wird mit ASYS V7.12 programmweit Log4j 2.x eingeführt. Durch diesen Wechsel sind die Property-Dateien für Log4j 1.x nicht mehr nutzbar. Leider gibt es keine Möglichkeit einer automatischen Konvertierung in Property-Dateien für Log4j 2.x.
Aus diesen Gründen gilt:
- Alle Konfigurationen des Loggings müssen von Ihnen einmalig neu erstellt werden.
- Die von den ASYS-Komponenten verwendeten Property-Dateien für das Logging mit Log4j 2.x haben neue Namen erhalten.
- Aber Achtung: Eine Umbenennung der bisherigen Property-Dateien ist nicht zulässig, da Log4j 2.x mit den alten Property-Dateien nicht korrekt konfiguriert werden kann.
- Wenn Sie individuelle Einstellungen in den Property-Datei vorgenommen haben, müssen Sie diese entsprechend den für Log4j 2.x geltenden Konfigurationsregeln erneut vornehmen.
- Am Ende der Seite mit den Konfigurationshinweisen zu Log4j wird die für Log4j 2.x verfügbare Dokumentation (englisch) bereitgestellt.
Bedienung
Die Einstellungen können für die ASYS-Komponenten
- Administrator-Programm (Admin-Log),
- Asys Admin Datenban- und Test-Tool1) (AdminClient-Log),
- ASYS Kommunikations-Server (KomServer-Log),
- ASYS-WebServer (WebServer-Log),
- ASYS Funktionsserver (JobServer-Log) und
- die ASYS Anwendungsoberfläche (BOF-Log)
jeweils getrennt vorgenommen werden. Für jede der genannten ASYS-Komponenten findet die Logging-Konfiguration in diesem Dialog auf einem eigenen Tab-Reiter statt. Die Bedienung ist aber in allen Fällen im Grundsatz gleich (für die Anwenderoberfläche gelten einige Besonderheiten, auf die unten eingegangen wird).
Schnellkonfiguration
Der Dialog stellt für jede ASYS-Komponente eine vereinfachte Konfiguration im oberen Dialogabschnitt der Schnellkonfiguration bereit. Bis zu sechs Logging-Ströme können je Komponente auf diese Weise vereinfacht mit Hilfe des Dialogs eingestellt werden:
| Logging-Typ | Erläuterung | Admin-Log | AdminClient-Log | KomServer-Log | WebServer-Log | JobServer-Log | BOF-Log |
|---|---|---|---|---|---|---|---|
| info | Grundlegende Programmstatusinformationen, genutzte Konfigurationsdateien und Pfade, verwendeter Datenbankadapter etc. | Ja | Ja | Ja | Ja | Ja | Ja |
| debug2) | Detaillierte Programmstatusinformationen, Zwischenergebnisse, SQL-Befehle, Skripte, Prüfregeln, aktivierte Java-Objekte der Mittelschicht etc. | Ja | Ja | Ja | Ja | Ja | Ja |
| sql | An die Datenbank geschickte SQL-Kommandos | - | Ja | Ja | Ja | Ja | Ja |
| rule | Ausgeführte Prüfregeln (Oberflächenprüfpläne, Nachrichtenprüfpläne) | - | Ja | Ja | - | Ja | Ja |
| script | Ausgeführte Skripte (Empfängerermittlung, Vorgangssteuerung) | - | - | Ja | - | - | - |
| vg | Ergebnisse der Ausführung der Skripte, der Arbeitsschritte und der Aktionen | - | - | Ja | - | - | Ja |
| change | Protokolliert Änderungen, die an den Daten vorgenommen werden mit dem Wert vor und nach der Änderung (z.B. 2020-04-23 17:37:42,001 DEBUG - Maske: Entsorger, Maskenfeld: Entsorger Name 3 - Wert vor Änderung: , Wert nach Änderung: Change) | - | - | - | - | - | Ja |
Nicht alle ASYS-Komponenten verwenden alle diese protokollierbaren Funktionalitäten. Daher werden sie nur bei den Komponenten angeboten, wo eine entsprechende Protokollierung sinnvoll nutzbar ist (siehe die Spalten der vorstehenden Tabelle).
Je Logging-Strom können folgende Einstellungen vorgenommen werden:
- Ein der Logging-Strom wird über das Ankreuzfeld aktiviert in seinem Einstellungsblock aktiviert bzw. deaktiviert. Wird der Strom aktiviert, so werden seine übrigen Einstellungsmöglicheiten freigegeben, bei einer Deaktivierung werden sie abgeschaltet.
- Über die Historisierung wird festgelegt, ob pro Kalendertag eine neue Logging-Datei angelegt werden soll (Ja –> DailyRollingFileAppender; die Vortagsdatei wird jeweils mit dem zugehörigen Protokollierungsdatum als Dateiendung gesichert) oder ob je Sitzung eine Datei angelegt werden soll, welche die alte Datei überschreibt (Nein –> FileAppender).
- Der Pfad zur Logdatei gibt den Ort der Log-Datei im Dateisystem an. Der Pfad ist per Default relativ zum Verzeichnis, aus dem heraus die ASYS-Komponente gestartet wird. Mit der Aktivierung eines Stroms wird ein Pfad und ein Dateiname vorgeschlagen. Sollen die Logging-Informationen an einem anderen Ort gespeichert werden, so kann ein alternativer Pfad und/oder Dateiname in das Textfeld eingetragen werden. Außerdem können über den Button
ein Pfad und ein Dateiname über einen Standard-Dateiauswahldialog bestimmt werden3):
Konfigurations-Quelltext
Die im Bereich der Schnellkonfiguration oben vorgenommenen Einstellungen müssen noch mittels des Buttons 
in die Konfigurationsdatei übernommen werden, die im unteren Dialogabschnitt angezeigt wird.
Die resultierende Konfigurationsdatei wird im Quelltext unten angezeigt. Die Überschrift des Quelltextfeldes zeigt den Pfad und Namen der Konfigurationsdatei. Der Quelltext der Log4j-Konfiguration kann in diesem Feld auch manuell bearbeitet werden! Siehe hierzu die Konfigurationshinweise zu Log4j.
Über den Button 
rechts unter dem Quelltextfeld wird die Log4j-Konfiguration in der Konfigurationsdatei abgespeichert.
Besonderheit für die Logging-Einstellungen der Anwenderoberfläche
Die Standardnamen der Logging-Dateien der Anwenderoberfläche (Tab-Reiter Nutzer-Log (Vorlage)) enthalten den Platzhalter <*LOGIN_NAME*> im Dateinamen. Über den Button wird dabei nur eine Vorlagendatei im Programmverzeichnis von ASYS abgelegt.
Bei jedem Programmstart der ASYS-Anwenderoberfläche wird überprüft, ob die Vorlagendatei im ASYS-Programmverzeichnis jünger ist, als die Log4j-Konfigurationsdatei im persönlichen Nutzerverzeichnis %user_home%\Asys7. Ist sie jünger, wird sie automatisch vor dem eigentlichen Programmstart in das persönliche Nutzerverzeichnis kopiert und der Platzhalter <*LOGIN_NAME*> im Quelltext wird durch den Login-Namen des Nutzers ersetzt. Auf diese Weise können für alle ASYS-Nutzer persönlichen Logging-Protokolle in einem gemeinsamen Verzeichnis abgelegt werden.
| Weitere Informationen zu dieser Maske | ||||||||||||||||
| Konfigurationshinweise zu Log4j | ||||||||||||||||
| landesspezifische Zusatzinformationen: | SH | HH | NI | HB | NW | HE | RP | BW | BY | SL | BE | MV | ST | BB | TH | SN |