Logging der Audit-Actions

Der CARA Server erlaubt das separate Logging der gespeicherten Audit-Actions..

Das Audit-Action-Logging verwendet den Log4j Mapped Diagnostic Context, um eine frei konfigurierbare Auswahl der im Logfile ausgegebenen Daten zu unterstützen.

Vorgehensweise

  • Definieren Sie in der Datei log4j.xml für CARA-WS einen separaten Appender für das Logging der Audit-Events. Geben Sie diesem Appender einen eindeutigen Namen.

  • Achten Sie darauf, in der Appender-Definition eine separate Datei für die Audit-Event-Log-Ausgabe anzugeben (falls es sich um einen Datei-basierten Appender handelt).

  • Bei Verwendung von FileAppender besteht die Möglichkeit, das Logfile entweder bei jeder Initialisierung von Log4j zu überschreiben oder neue Einträge hinten anzuhängen. Hierzu dient ein XML-Element <param name="Append" value="true|false"/>.

  • Definieren Sie innerhalb des Appenders ein Layout der Klasse org.apache.log4j.PatternLayout. Dieses unterstützt einen Parameter mit name="ConversionPattern". Der Wert dieses Parameters ist ein Template für die auszugebenden Log-Messages.

  • Den Wert eines Platzhalters können Sie in der Form %X{Platzhaltername} an beliebiger Stelle in das ConversionPattern einfügen.

  • Definieren Sie einen neuen Logger mit name="AUDIT_ACTION_LOGGER". Sein Log-Level muss auf INFO gestellt sein, da alle Messages mit diesem Level ausgegeben werden. Der Logger muss mittels <appender-ref> auf den neuen Appender verweisen.

  • Um die Audit-Event Log-Ausgaben ausschließlich an den dedizierten Appender zu leiten, verwenden Sie im <logger>-Tag das XML-Attribut additivity="false".

Beispiel

Ein Beispiel für eine Log4j-Konfiguration befindet sich im Lieferumfang des CARA-Servers in der Datei log4j.default.xml.

  • Beispiel-Appender: AUDIT_ACTION_LOGGER_FILE

  • Beispiel-Logger: AUDIT_ACTION_LOGGER

Unterstützte MDC-Platzhalter

Je Audit-Action-Log-Message werden folgende Werte im MDC registriert:

Platzhaltername Beschreibung

auditAction_id

CARA-Datenbank-ID der gespeicherten Audit-Action

auditAction_configuration

CARA-Konfiguration der gespeicherten Audit-Action

auditAction_auditEvent_id

CARA-Datenbank-ID des zugehörigen Audit-Events

auditAction_workflowEvent_id

CARA-Datenbank-ID des zugehörigen Workflow-Events

auditAction_module_id

ID des ausführenden Moduls in der CARA-Datenbank

auditAction_module_name

Name des ausführenden Moduls in der CARA-Datenbank.

auditAction_status_code

Statuscode der gespeicherten Audit-Action.

auditAction_status_name

Bezeichnung des Statuscode der gespeicherten Audit-Action

Mögliche Werte:

  • Neu

  • Erfolg

  • Fehler

  • Modul nicht gefunden

  • Workflow-Handler nicht gefunden

Viele Werte sind optional. Sind diese nicht gesetzt, wird dies durch folgenden Text angezeigt: (null)