Aktivitätenprotokoll

Verwenden Sie die Richtlinie Aktivitätenprotokoll , um Ihre Protokollierungsvorgaben für die API-Aktivität zu konfigurieren, die in IBM® API Connect Analytics gespeichert ist. Die Vorgaben, die Sie angeben, setzen die Standardeinstellungen zum Erfassen und Speichern von Details der API-Aktivität außer Kraft.

Gateway-Unterstützung

Tabelle 1. Tabelle, in der angegeben wird, welche Gateways diese Richtlinie unterstützen, sowie die entsprechende Richtlinienversion
Gateway Richtlinienversion
DataPower® Gateway (v5 compatible) 1.0.0

In diesem Abschnitt wird beschrieben, wie Sie die Richtlinie in der Assembly-Benutzerschnittstelle konfigurieren können. Details zur Konfiguration der Richtlinie in Ihrer OpenAPI -Quelle finden Sie unter activity-log.

Wenn Sie DataPower API Gatewayverwenden, können Sie Ihre Protokollierungsvorgaben mithilfe des API-Designeditors konfigurieren. Weitere Informationen finden Sie unter Aktivitätenprotokollierung konfigurieren (OpenAPI 2.0) oder unter Aktivitätenprotokollierung konfigurieren (OpenAPI 3.0).

Produktinfo

Es ist ein API-Ereignisdatensatz für jedes API-Ausführungsereignis auf dem Gateway-Server vorhanden. Standardmäßig lautet der Inhaltstyp, der erfasst und in API-Ereignisdatensätzen gespeichert wird, activity, wenn die API-Ausführung erfolgreich abgeschlossen wird, und payload, wenn die API-Ausführung mit einem Fehlercode abgeschlossen wird. Wenden Sie die Richtlinie Aktivitätenprotokoll auf Ihre Assembly an, um den Typ des Inhalts zu ändern, der in diesen API-Ereignisdatensätzen protokolliert werden soll. Weitere Informationen zu API-Ereignisdatensätzen finden Sie unter API event record field reference.
Hinweis: Wenn die Nutzdatenprotokollierung aktiviert ist, muss für das Gateway die Erfassung der Nutzdatenpufferung ebenfalls aktiviert sein. Aktivieren Sie die Pufferung wie folgt in der API-YAML:
x-ibm-configuration:
  ...
  activity-log:
    enabled: true
    error-content: payload
    success-content: payload
  ...
  buffering: true
Hinweis:

Aktivitätenprotokoll-Richtlinien, die zum Protokollieren von Analysedaten bei Erfolg aufrufen, gelten nicht für den OAuth-Provider. Der OAuth-Provider protokolliert Analysedaten für Fehlerfälle, protokolliert jedoch keine erfolgreichen Fälle.

Eigenschaften

Die folgende Tabelle enthält die Richtlinieneigenschaften, gibt an, ob eine Eigenschaft erforderlich ist, enthält die gültigen Werte und die Standardwerte für Eingaben und gibt den jeweiligen Datentyp der Werte an.

Tabelle 2. Eigenschaften der Richtlinie Aktivitätenprotokoll
Eigenschaftsbezeichnung Erforderlich Beschreibung Datentyp
Titel Ja Ein Titel für die Richtlinie ist erforderlich, aber ein Standardwert, activity-log , wird bereitgestellt. Zeichenfolge
Beschreibung Nein Eine Beschreibung der Richtlinie. Zeichenfolge
Inhalt Ja Definiert den Typ des zu protokollierenden Inhalts, wenn die Operation erfolgreich ist.
Die gültigen Werte sind im Folgenden aufgelistet:
  • none: Gibt an, dass keine Protokollierung stattfindet.
    Einschränkung: Mit dieser Option werden Benachrichtigungen für Anwendungsentwickler deaktiviert, die Ihr CMS Portal verwenden.
  • activity: Protokolliert nur Aufrufe (nur der Ressourcen-URI wird aufgezeichnet).
  • header: Protokolliert Aktivität und Header.
  • payload: Protokolliert Aktivität, Header und Nutzdaten (die ursprüngliche Anforderung, falls vorhanden, und die endgültige Antwort).

Der Standardwert ist activity.

 Zeichenfolge
Fehlerinhalt Nein Gibt an, welche Inhalte bei Auftreten eines Fehlers protokolliert werden sollen.
Die gültigen Werte sind im Folgenden aufgelistet:
  • none: Gibt an, dass keine Protokollierung stattfindet.
    Einschränkung: Mit dieser Option werden Benachrichtigungen für Anwendungsentwickler deaktiviert, die Ihr CMS Portal verwenden.
  • activity: Protokolliert nur Aufrufe (nur der Ressourcen-URI wird aufgezeichnet).
  • header: Protokolliert Aktivität und Header.
  • payload: Protokolliert Aktivität, Header und Nutzdaten (die ursprüngliche Anforderung, falls vorhanden, und die endgültige Antwort).

Der Standardwert ist payload.

 Zeichenfolge