Frontend Log Service

Über den Frontend Log Service werden und können Clientseitige Javascript Konsolenausgaben in das Backend geschrieben. Zur Abfrage der Einträge stellt das BPC einen vorgefertigten Process Monitor zur Verfügung.

Der Frontend Log Service bietet folgende Funktionalitäten:

Erstellt bei Initialisierung den Opensearch Index 'bpc-frontend-logging'.
Der Frontend Log Service kann über die Core Konfiguration Frontend Logging aktivieren, aktiviert bzw. deaktiviert werden. Per Default ist das Frontend Logging aktiviert.
Das Loglevel kann über die Core Konfiguration Frontend Log Level gesteuert werden. Ist das Loglevel beispielsweise auf 'info' gesetzt und befindet sich an einer beliebigen Stelle der Anwendung ein Methodenaufruf für die Javascript-Methoden console.error, console.warn oder console.info, so werden die Argumente, die an diese Methden gereicht werden vom Backend geloggt. Per Default ist das Loglevel auf 'warn' gesetzt.

Daten eines Frontend Logs

Feld

Inhalt

timestampUTC

der Zeitstempel an dem der Client Log abgesetzt wurde

level

Debug, Log, Info, Warning, Error

message

Inhalt der Konsolenausgabe

sessionId

Session Id der aktuellen Benutzersitzung

Datenbereinigung

Da beim Frontend Log Service unter Umständen große Datenmengen generiert werden, findet eine periodische Datenbereinigung statt. Per Default werden Einträge gelöscht, die älter als 4 Wochen sind. Dies kann über zwei Einstellungen in der Konfigurationsdatei [karaf]/etc/de.virtimo.bpc.core.cfg konfiguriert werden.

...
de.virtimo.bpc.core.frontendlogging.cleanupPeriodInMinutes=60
de.virtimo.bpc.core.frontendlogging.deleteEntriesOlderThan=1 year ago
...

Beispiel: Alle 60 Minuten werden Einträge gelöscht welche älter als 1 Jahr sind

Das Löschen wird nur durchgeführt, wenn die beiden Einstellungen gesetzt sind. Weitere sinnvolle Werte für 'deleteEntriesOlderThan': 14 days ago, 3 weeks ago, 1 month ago, 3 months ago, 6 years ago

Endpunkt

Method Endpoint

Method	Endpoint
`POST`	`/cxf/bpc-core/frontendLogging/{sessionId}`
Description Saves the logs provided in the body to the OpenSearch index `bpc-frontend-logging`.
Path Parameter `sessionId` the id of the session
Returns HTTP Status Code `200` : OK
Required Access Rights A logged in user or API Key is required.

POST

/cxf/bpc-core/frontendLogging/{sessionId}

Description

Saves the logs provided in the body to the OpenSearch index bpc-frontend-logging.

Path Parameter

sessionId: the id of the session

Returns

HTTP Status Code

200 : OK

Required Access Rights

A logged in user or API Key is required.

Keywords: