Log-Dateien

Einführung in Log-Dateien in ConSol CM

Log-Dateien sind die Hauptquelle für Informationen über die Aktivitäten im System und potentielle Probleme. In ihnen werden Log-Meldungen der unterschiedlichen Komponenten von ConSol CM gespeichert.

Konzepte, Begriffe und Definitionen

Konzept	Andere Begriffe	Definition
Log-Datei		Textdatei mit der Erweiterung .log, in der Meldungen über die Aktivität im System und Fehler geschrieben werden
Log-Level		Das Log-Level legt fest, welche Meldungen in den Log-Dateien geschrieben werden und wie viele Details in den Log-Meldungen enthalten sind. Die am meisten verwendeten Log-Level sind ERROR, INFO und DEBUG.

Zweck und Verwendung

Log-Dateien enthalten Informationen über die Systemaktivität. Wenn beim Betrieb des Systems Fehler auftreten, enthalten sie Details über den Fehler. Die Analyse der Log-Dateien ist für die Fehlerbehebung nützlich und kann Probleme aufdecken, die auf der Benutzeroberfläsche nicht zu sehen sind.

Es gibt zwei Möglichkeiten zum Zugriff auf die Log-Dateien:

• Öffnen Sie die Datei im Dateisystem. Der Standardpfad ist <JBOSS_HOME>/standalone/log. Die Datei audit.log befindet sich im Unterverzeichnis adminlogs.
• Öffnen Sie die Seite Log-Dateien der Web Admin Suite. Dort können Sie die Log-Dateien anzeigen und herunterladen.

Verfügbare Log-Dateien

Folgende Log-Dateien sind in ConSol CM verfügbar:

• access.log
  Enthält Log-Meldungen über den Zugriff und die Nutzung vom Web Client. Muss explizit aktiviert werden, siehe Aktivieren der Datei access.log.
• audit.log
  Enthält Log-Meldungen über An- und Abmeldevorgänge in Admin Tool, Web Admin Suite und Process Designer, und alle Operationen, die mit diesen Applikationen durchgeführt werden, z. B. Konfigurationsänderungen und Workflow-Installationen.
• cmrf.log
  Enthält Log-Meldungen vom CMRF (ConSol CM Reporting Framework), d. h. Meldungen über Datenübertragungen von der ConSol CM-Datenbank an die CMRF-Datenbank (DWH).
• cmweb.log
  Enthält Log-Meldungen vom Web Client.
• ctx.log
  Enthält Log-Meldungen vom Spring Framework.
• errors.log
  Enthält nur Log-Meldungen, die mindestens das Log-Level ERROR haben.
• index.log
  Enthält Log-Meldungen zum Index.
• mail.log
  Enthält Log-Meldungen zum E-Mail-System.
• operationtimes.log
  Enthält Log-Meldungen mit den Laufzeiten der Anfragen, um mögliche Performance-Engpässe zu erkennen.
• operationtimes-db.log
  Enthält Log-Meldungen mit den Datenbankzugriffszeiten von atomaren Operationen, um mögliche Performance-Engpässe zu erkennen. Die Protokollierung wird mit den System-Properties cmas-core-server, dao.log.threshold.milliseconds und cmas-core-server, dao.log.username konfiguriert.
• operationtimes-rest.log
  Enthält Log-Meldunden mit den Laufzeiten von REST-Anfragen. Die Anfrage-URL und die für die Verarbeitung der Anfrage benötigte Zeit werden auf dem Level DEBUG protokolliert. Die Protokollierung wird mit den System-Properties cmas-restapi-core, request.log.threshold.milliseconds und cmas-restapi-core, request.log.username konfiguriert.
• security.log
  Enthält Log-Meldungen, die sich auf Sicherheit, Autorisierung und Authentifizierung beziehen, z. B. Log-Meldungen über Kerberos-Authentifizierung.
• server.log
  Enthält alle Log-Meldungen, die mindestens Log-Level INFO haben.
• session.log
  Enthält Meldungen über Anmeldungen (Session-Starts) und Session-Timeouts von Benutzern.
• sql.log
  Enthält Log-Meldungen zu SQL-Anweisungen aus Hibernate, wenn das Level DEBUG gesetzt ist (standardmäßig ist INFO gesetzt).
• support_libs_errors.log
  Enthält Fehlermeldungen aus unterstützenden Bibliotheken, die von ConSol CM korrekt behandelt wurden (auf diese Weise bleibt die server.log übersichtlich).
• timer-manager.log
  Enthält zusätzliche Log-Meldungen mit dem Log-Level DEBUG, wenn Workflow-Timer aktiviert oder deaktiviert werden. Informationen über das Eskalationsdatum werden ebenfalls protokolliert.
• track_jersey.log
  Enthält Log-Meldungen aus CM/Track.
• transfer.log
  Enthält Log-Meldungen über den Export / Import von Szenarien.
• tx.log
  Enthält Log-Meldungen zu Transaktionen des Spring-Frameworks.
• unit-deletion.log
  Enthält Informationen über die Löschung von Kontakten.
• workflow.log
  Enthält Log-Meldungen über aktivierte / neu initialisierte / deaktivierte Timer, die mit Log-Level INFO protokolliert werden und die gesamte Debug-Ausgabe im Zusammenhang mit der Workflow-Engine.

Struktur der Log-Dateien

In der Standardkonfiguration haben die Einträge in der Log-Datei folgende Syntax:

Datum Zeitstempel Loglevel [Logger] Meldung

Beispiel für einen Eintrag in einer Log-Datei:

2020-10-11 13:52:44,526 INFO [reemarker.FreeMarkerConfigurer] [-] ClassTemplateLoader for Spring macros added to FreeMarker configuration

Die Komponenten der Meldung:

• Datum:
  11. Oktober 2020
• Zeitstempel:
  13:52:44
• Loglevel:
  INFO
• Logger:
  reemarker.FreeMarkerConfigurer
  Name der Java-Klasse, nicht der vollständige Name sondern die letzten 30 Zeichen. Der komplette Name wäre Freemarker.FreeMarkerConfigurer.
• Meldung:
  ClassTemplateLoader for Spring macros added to FreeMarker configuration

Einfache Meldungen und Meldungen zu einer erfolgreichen Operation haben häufig nur eine Zeile. Wenn Fehler auftreten (Log-Level ERROR), sehen Sie möglicherweise Stacktraces in den Logs.

Grundlegende Aufgaben

Zugriff auf Log-Dateien mit der Web Admin Suite.

Auf der Seite Log-Dateien im Menü Betrieb können Sie auf die Log-Dateien zugreifen, die im Standardverzeichnis gespeichert sind. Beim Öffnen der Seite werden die neusten Zeilen der Datei server.log angezeigt.

Sie können auf der Seite folgende Aktionen durchführen:

• Log-Datei anzeigen
  Wählen Sie die gewünschte Log-Datei im Auswahlfeld auf der linken Seite. Alle Log-Dateien, die im Standardverzeichnis, <JBOSS_HOME>/standalone/log, gespeichert sind, sind verfügbar.
• Log-Dateien herunterladen
  Klicken Sie auf den Button Log-Dateien herunterladen, und wählen Sie die Log-Dateien, die Sie herunterladen möchten. Die aktuell angezeigte Datei ist vorausgewählt. Sie können zusätzliche Log-Dateien auswählen, um mehrere Dateien gleichzeitig herunterzuladen. Wenn mehrere Dateien ausgewählt sind, werden sie als ZIP-Datei heruntergeladen.
• Automatische Aktualisierung konfigurieren
  Die aktuell angezeigte Log-Datei wird automatisch aktualisiert, wenn die Checkbox Log-Datei automatisch aktualisieren ausgewählt ist. Deaktivieren Sie diese Chckbox, wenn Sie die automatische Aktualisierung anhalten möchten.
• Anzeigereihenfolge ändern
  Die neusten Zeilen werden oben angezeigt, wenn die Checkbox Neuste Zeilen zuerst anzeigen ausgewählt ist. Deaktivieren Sie diese Checkbox, um die ältesten Zeilen zuerst anzuzeigen.

Erweiterte Aufgaben

Konfigurieren der Protokollierung

Der Standardpfad für die Log-Dateien ist <JBOSS_HOME>/standalone/log. Der Speicherort der Log-Dateien und das Logging-Verhalten kann in den jeweiligen Konfigurationsdateien konfiguriert werden:

• cm6-config.properties, cm6-cmrf-config.properties (JBoss EAP- / Wildfly-Standalone-Installationen mit oder ohne CMRF)
• cm6-domain-config.properties
  (JBoss EAP-Cluster-Installation)

Details dazu finden Sie in Configuring the log files in JBoss.

Aktivieren der Datei access.log

In einer Standardinstallation sind die folgenden Zeilen in der Konfigurationsdatei, cm6-<DB>.xml, cm6-cmrf-<DB>.xml oder cm6-dwh-<DB>.xml, auskommentiert. Durch Einkommentieren dieser Zeilen aktivieren Sie die Zugriffsprotokollierung in Ihrem ConSol CM-System.