ldproxy

Audit Logging

Optionen

NameDefaultBeschreibungTypSeit
enabled
false
Wenn true, wird das Audit-Logging für alle APIs eingeschaltet. Einzelne APIs können in der API-Konfiguration explizit deaktiviert werden. Audit-Logging ist global deaktiviert, wenn false.
boolean
4.8
retries
3
Gibt an, wie oft der Schreibprozess bei Fehlern wiederholt werden soll. Sollte auf 0 gesetzt werden, falls keine Wiederholungen erwünscht sind. Wenn das Schreiben nach der angegebenen Anzahl von Wiederholungen fehlschlägt, wird der Log-Eintrag ins Anwendungsprotokoll geschrieben.
number
4.8
pathPrefix
{api}/{date}
Gibt den Pfad an, der der Log-Datei vorangestellt werden soll. Dabei werden {api} und {date} jeweils mit der API-ID bzw. dem ISO-Datum der Anfrage ersetzt. Beispielsweise könnten die Log-Dateien für {api}/foo/{date}/bar unter resources/logs/audit/vineyards/foo/2026-06-03/bar gespeichert werden.
string
4.8
type
JSON
Gibt an, in welchem Format die Logs gespeichert werden. Unterstützt werden momentan JSON und JSON_PRETTY (formatiertes JSON).
string
4.8
headers
included: [ '*' ], excluded: []
Die included-Liste gibt an, welche Header geloggt werden sollen. Die excluded-Liste gibt an welche Header aus included nicht geloggt werden sollen. Der spezielle Wert * kann für beide Listen verwendet werden und umfasst alle Header. Wenn excluded: [ '*' ], werden keine Header geloggt.
object
4.8
claims
included: [], excluded: []
Gibt an, welche Claims aus dem Token geloggt werden sollen und welche explizit nicht geloggt werden sollen. Verwendet die gleiche included/excluded-Logik wie headers.
object
4.8
httpStatus
included: [ '200' ], excluded: []
Gibt an, für welche HTTP-Statuscodes Anfragen geloggt werden sollen und welche explizit nicht geloggt werden sollen. Verwendet die gleiche included/excluded-Logik wie headers.
object
4.8

Speicherung

Die Log-Einträge werden im Ressourcen-Store im Verzeichnis logs/audit abgelegt. Der Dateiname entspricht der Request-ID aus dem Anwendungsprotokoll.

Beispiel


auditLog:
 enabled: true
 retries: 3
 type: JSON_PRETTY
 pathPrefix: "mysubdirectory/{api}/{date}"
 headers:
   included: [ "*" ]
   excluded: [ "Accept" ]
 claims:
   included: [ "*" ]
   excluded: [ ]
 httpStatus:
   included: [ "200" ]
   excluded: [ ]
ImpressumDatenschutzerklärung