Zusätzlich können Log-Gruppen erstellt und verwaltet werden, um spezifische Filterkriterien zu speichern und Benachrichtigungen bei neuen relevanten Einträgen zu erhalten.

Die API unterstützt damit sowohl die manuelle Analyse als auch eine automatisierte Überwachung von Systemereignissen.

Zur Nutzung der Schnittstellen sind entsprechende Zugriffsrechte erforderlich.

Inhaltsverzeichnis:

1. Unterstützte Methoden

Angabe aller unterstützten Methoden.

2. Ressourcen: Felder in Logs

2.1 Wichtige Datenfelder in Logs

Logs im System basieren auf Daten aus Elasticsearch und unterliegen daher keiner starren Struktur. Dennoch gibt es zentrale Felder, die in nahezu allen Log-Einträgen vorkommen und für Filter, Sortierung oder Auswertung genutzt werden können.

Die folgende Übersicht listet die wichtigsten dieser Felder:

Hinweis: Weitere Felder können abhängig vom Ursprung und Kontext des Logs vorhanden sein. Die tatsächliche Struktur einzelner Log-Einträge kann abweichen.

Beispiel:

Der folgende Log-Eintrag stammt aus dem System und zeigt typische Felder, wie sie von Elasticsearch geliefert werden. Optional enthaltene Felder wie agent, host oder tags können je nach Ursprung des Logs variieren.

2.2 Programme, die Logs erzeugen

Das Feld app in einem Logeintrag gibt an, welches Programm oder welcher Dienst das Log erzeugt hat. Die folgende Übersicht listet die möglichen Programme auf, die in der Praxis als app-Wert erscheinen können – inklusive einer kurzen Beschreibung ihrer Aufgabe innerhalb des Shop-Systems.

3. Methoden für Logs

Über die nachfolgenden Endpunkte lassen sich Log-Einträge aus dem System abrufen. Die Logs enthalten detaillierte Informationen zu Ereignissen im Shop, wie z. B. Fehlermeldungen, Debug-Ausgaben oder sicherheitsrelevante Hinweise.

Einträge können gefiltert und sortiert sowie einzeln nach ihrer ID geladen werden.

Für den Zugriff auf diese Daten sind entsprechende Leseberechtigungen erforderlich.

3.1 GET logmanager/logs

Über diesen Endpunkt kann eine Liste mit Logeinträgen abgefragt werden.

Die Ergebnisse lassen sich nach Zeitstempel, Schweregrad (severity), Shop, Subshop, Logger, Session-ID oder weiteren Feldern filtern und sortieren. Standardmäßig wird nach dem Feld @timestamp sortiert. Für die Abfrage kann ein Zeitraum mit filter_gte[createdAt] und filter_lte[createdAt] angegeben werden. Der Zugriff ist auf maximal 300 Einträge pro Anfrage begrenzt, eine Paginierung erfolgt über nextPageToken.

Die maximale Anzahl an Ergebnissen beträgt 10.000 - auch bei Paginierung. Darüber hinausgehende Daten können nicht abgerufen werden.

Zur Verfügung stehen Logs verschiedener Anwendungen (z. B. shop, restapi) und Quellen (z. B. filebeat). Sie enthalten strukturierte Metadaten und Fehlermeldungen, die zur Analyse von Prozessen oder Fehlern im Shop dienen. Um die tatsächlichen Logdateien oder Pfade zu ermitteln, kann das Feld log.file.path genutzt werden.

Beispiel

Zugriff auf bis zu 100 Logs aller Art im Zeitraum 2025.03.24–2025.04.24

Antwort:

Filterfelder:

logger (wenn nicht spezifiziert - alle), createdAt (statt @timestamp), weitere Felder eines Logs wie subshopId, severity, app

Sortierfelder:

Es ist möglich, Logs nach unterschiedlichen Feldern zu sortieren (z.B. nach sessionId.keyword), aber standardmäßig wird nur die Sortierung nach @timestamp genutzt.

Fehlercodes:

3.2 GET logmanager/logs/{id}

Diese Methode lädt ein einzelnes Log-Ereignis anhand seiner ID.

Es werden alle zugehörigen Felder wie Zeitstempel, Quelle, Schweregrad, Nachricht und Kontextinformationen zurückgegeben.

Für die Nutzung dieser Methode müssen entsprechende Leserechte für Logs vorhanden sein.

Beispiel:

Antwort:

Fehlercodes:

4. Methoden für Log-Gruppen

Über die folgenden Endpunkte lassen sich Log-Gruppen im Shop-System erstellen, abrufen, aktualisieren und löschen. Log-Gruppen definieren, welche Arten von Logs beobachtet werden sollen – z. B. nach Schweregrad, Subshop oder Quelle – und bilden damit die Grundlage für gezielte Auswertungen und Benachrichtigungen.

Zusätzlich können Benachrichtigungseinstellungen einer Gruppe konfiguriert werden, um über neue Log-Einträge regelmäßig informiert zu werden.

Zur Nutzung der Schnittstellen sind entsprechende Rechte zum Verwalten von Logs erforderlich.

4.1 GET logmanager/groups

Mit diesem Endpunkt lassen sich Log-Gruppen abfragen. Eine Log-Gruppe bündelt bestimmte Log-Einträge anhand eines konfigurierbaren Filters, z. B. nach Schweregrad oder Zeitraum. Die Ergebnisliste kann über Filter- und Sortierparameter gezielt eingeschränkt werden.

Für den Zugriff auf diese Daten sind entsprechende Leseberechtigungen erforderlich.

Beispiel:

Antwort:

Filterfelder:

id, name, description, notificationId, filter, createdAt

Sortierfelder:

id, name, description, createdAt

Fehlercodes:

4.2 GET logmanager/groups/{id}

Mit diesem Endpunkt kann eine einzelne Log-Gruppe anhand ihrer ID abgerufen werden.

Die Log-Gruppe enthält Metadaten wie Name, Beschreibung, Erstellungszeitpunkt, Filter und einen optionalen Verweis auf eine Benachrichtigungskonfiguration.

Für den Zugriff sind entsprechende Leseberechtigungen erforderlich.

Beispiel:

Antwort:

Fehlercodes:

4.3 GET logmanager/groups/{id}/logs

Mit diesem Endpunkt kann eine Liste von Logs abgerufen werden, die zu einer bestimmten Log-Gruppe gehören. Die ID der Log-Gruppe muss in der URL übergeben werden.

Die Abfrage unterstützt Filterung, Sortierung sowie die Paginierung über die Parameter from, size, sort und pageToken.

Für den Zugriff müssen entsprechende Leseberechtigungen vorhanden sein.

Beispiel:

Antwort:

Fehlercodes:

4.4 GET logmanager/groups/{id}/notifications

Mit diesem Endpunkt können die Benachrichtigungseinstellungen einer bestimmten Log-Gruppe abgerufen werden. Dazu gehören u. a. die Empfänger, der Benachrichtigungszeitraum und der Zeitpunkt des letzten Versands. Die ID der Log-Gruppe muss in der URL übergeben werden.

Für den Zugriff sind entsprechende Leseberechtigungen erforderlich.

Beispiel:

Antwort:

Fehlercodes: