Politik des Aktivitätsprotokolls

Online bearbeiten

Konfigurieren Sie die Aktivitätenprotokollrichtlinie, um die Detaillierungsebene der in API-Ereignissen gespeicherten Daten zu verwalten.

Wenn Sie eine API in der Benutzerschnittstelle von API Manager konfigurieren, wählen Sie aus, welche Daten in den API-Ereignisdatensätzen für Aufrufe dieser API mit der Eigenschaft activity log gespeichert werden. Die Eigenschaft activity log hat separate Einstellungen für erfolgreiche API-Aufrufe und für fehlgeschlagene API-Aufrufe. Die Aktivitätenprotokolloptionen lauten wie folgt:
  • keine - API-Ereignisse werden nicht protokolliert.
  • activity - Protokolliert den URI der API-Ressource. activity ist die Standardprotokolleinstellung für erfolgreiche API-Aufrufe.
  • header - Protokolliert den URI der API-Ressource und die Header von HTTP.
  • payload - Protokolliert API-Ressourcen-URI, HTTP Header sowie Request- und Response-Payloads. payload ist die Standardprotokolleinstellung für fehlgeschlagene API-Aufrufe, da die Antwortnutzdaten möglicherweise nützliche Informationen zur Fehlerursache enthalten.
Hinweis:

Wenn Ihr Gateway so konfiguriert ist, dass alle API-Aufrufe mit einem OAuth -Anbieter authentifiziert werden, werden die Daten, die sich auf den Aufruf OAuth beziehen, nur dann in die API-Ereignisdaten aufgenommen, wenn der Aufruf OAuth fehlschlägt. Eine erfolgreiche OAuth -Authentifizierung wird nicht in den API-Ereignisdaten aufgezeichnet.

Wichtig: Die maximale Größe der API-Ereignisaufzeichnung beträgt 19 MB. Das Analyse-Subsystem lehnt alle API-Ereignisdatensätze ab, die größer als 19 MB sind.

Protokolleinstellung in der Benutzerschnittstelle von API Manager definieren

  1. Wählen Sie in der Ansicht Entwickeln von API Manager die API aus, mit der Sie arbeiten wollen. Wenn Sie mit der Ansicht „Entwicklung“ der Benutzeroberfläche des API-Managers noch nicht vertraut sind, lesen Sie den Abschnitt „Arbeiten mit API-Definitionen “.
  2. Wählen Sie die Registerkarte Gateway aus, erweitern Sie Gateway-und Portaleinstellungenund wählen Sie dann Aktivitätenprotokollaus.
  3. Wählen Sie Aktiviertund anschließend die bevorzugte Protokolleinstellung für Erfolgsinhalt und Fehlerinhaltaus:
    • keine - API-Ereignisse werden nicht protokolliert.
    • activity - Protokolliert den URI der API-Ressource. activity ist die Standardprotokolleinstellung für erfolgreiche API-Aufrufe.
    • header - Protokolliert den URI der API-Ressource und die Header von HTTP.
    • payload - Protokolliert API-Ressourcen-URI, HTTP Header sowie Request- und Response-Payloads. payload ist die Standardprotokolleinstellung für fehlgeschlagene API-Aufrufe, da die Antwortnutzdaten möglicherweise nützliche Informationen zur Fehlerursache enthalten.
  4. Klicken Sie auf Speichern, um Ihre Änderungen zu speichern.

Protokolleinstellung in Quelle für DataPower® API Gateway definieren

Verwenden Sie die Erweiterung activity-log , um Ihre Protokollierungsvorgaben zu konfigurieren.

activity-log:
  success-content: <success log setting: none, activity, header, payload>
  error-content: <failure log setting: none, activity, header, payload>
  enabled: <if activity logging is enabled: true or false>
Hinweis: Wenn die Nutzdatenprotokollierung aktiviert ist, muss für das Gateway die Erfassung der Nutzdatenpufferung ebenfalls aktiviert sein.
activity-log:
  success-content: <success log setting: none, activity, header, payload>
  error-content: <failure log setting: none, activity, header, payload>
  enabled: <if activity logging is enabled: true or false>
buffering: true
Beispiel
Keine Protokollierung erfolgreicher Aufrufe, Headerprotokollierung für fehlgeschlagene Aufrufe
activity-log:
    success-content: none
    error-content: header
    enabled: true
Aktivitätsprotokollierung inaktivieren
activity-log:
    enabled: false