GSB 7.0 Standardlösung

CAE Logging

Kontextspezifische Logging-Informationen

Die CAE-Webapplikation bietet die Möglichkeit, die Logausgaben mit zusätzlichen kontextspezifischen Informationen anreichern zu können. Die Kontextinformationen werden im sogenannten bereitgestellt und können für die Ausgabe in Logmeldugnen genutzt werden, um spezifischere Logmeldungen zu erhalten.

Folgende CAE spezifische MDC-Schlüssen werden durch den GSB gesetzt:

  • requestUri – Die aufgerufene URL
  • customer – Der aktuelle Mandant
  • calledDocument – Der Pfad des aufgerufenen Dokuments. Bei Formular-Aufrufen ist dies der Pfad der Formular-Zielseite.
  • calledDocumentId – Die Id des aufgerufenen Dokuments. Bei Formular-Aufrufen ist dies die Id der Formular-Zielseite.
  • calledForm – Der Pfad des aufgerufenen HTML-Formulars (Dokumenttyp HFForm)
  • calledFormId – Die Id des aufgerufenen HTML-Formulars (Dokumenttyp HFForm)
  • navnode – Der Pfad des aktuellen Navigationskonten (Dokumenttyp NavNode)
  • navnodeId – Die Id des aktuellen Navigationskonten (Dokumenttyp NavNode)
  • navtarget – Der Pfad des aktuellen Navigationsziels (Dokumenttyp NavTarget)
  • navtargetId – Die Id des aktuellen Navigationsziels (Dokumenttyp NavTarget)
  • language – Die aktuelle Sprache
  • site – Die aktuelle Subsite
  • template – Das aktuell gerenderte Template einschließlich des Dokumentpfades

Die Ausgabe der MDC-Schlüssel erfolgt durch Erweiterung des Log-Pattern in der logback.xml mit Hilfe des Platzhalters %X{MDC-SCHLÜSSEL} (bspw. %X{customer} für die Ausgabe des aktuellen Customers).

Error Logmeldungen

Log-Meldungen der CAE mit dem LogLevel Error können in ein dedizierte Error-Logfile geschrieben werden. Dieses Logfile kann dann bspw. für eine Überwachung genutzt werden.

Die Aktivierung des Error-Logfiles wird über die Build-Property cae_logs_with_error_log (CAE-Webapplikation) durchgeführt:

  • cae_logs_with_error_log=false (Default): kein dediziertes Error-Logfile
  • cae_logs_with_error_log=true: Aktivierung des dedizierten Error-Logfile

Die Error-Meldungen werden in das Log-File webapp-cae-error.log geschrieben.

Mandantenspezifische Logmeldungen

Log-Meldungen einzelner Mandanten können anhand des Customer-Schlüssels des MDC in ein mandantenspezifischen Log-File geschrieben werden. Die Aktivierung der mandantenspezifischen Log-Files erfolgt auf Basis einzelner Mandanten. Die kommaseparierte Liste der Mandanten mit dedizierten Log-Files wird in der Build-Property cae_logs_with_customer_log (CAE-Webapplikation) durchgeführt:

  • cae_logs_with_customer_log=MANDANT1,MANDANT2: Aktivierung der mandantenspezifischen Log-Files für MANDANT1 und MANDANT2

Die mandantenspezifischen Log-Meldungen des Mandanten werden in das Log-File webapp-cae_.log geschrieben.