Schlüsselkonzepte der API Connect Analytik

Ein Überblick über die Funktionsweise der API Connect Analytik.

Wie Gateway-und Analyseservices zusammenarbeiten

Wenn ein Benutzer eine Ihrer veröffentlichten APIs aufruft, erstellt das Gateway, das den API-Aufruf verarbeitet, einen API-Ereignisdatensatz, der Details des API-Aufrufs, wie z. B. Anwendungs-ID, aktuelle Zeit, Ergebniscode usw., enthält. Eine vollständige Liste aller Daten, die in einem API-Ereignisdatensatz gespeichert sind, finden Sie unter API event record field reference. Das Gateway puffert API-Ereignisdatensätze für jeden API-Aufruf, bis ein Schwellenwert für die Anzahl der Ereignisse oder die abgelaufene Zeit erreicht wird. Wenn dieser Schwellenwert erreicht ist, werden die API-Ereignisse in einer Massenoperation an das Analysesubsystem gesendet. API-Ereignisse werden vom Gateway per TCP an das Management-Subsystem gesendet, und im Falle eines Netzwerkfehlers versucht es das Gateway erneut. Das Gateway speichert jedoch nicht gesendete API-Ereignisdatensätze und versucht es nicht unbegrenzt oft erneut, so dass die Zustellung jedes API-Ereignisdatensatzes nicht garantiert ist.

Für Ihre APIs gespeicherte Analysedaten anpassen

Hinweis: Welche API-Konsumentenanalyse im Developer Portal angezeigt wird, hängt von den Sichtbarkeitskonfigurationseinstellungen ab. Weitere Informationen finden Sie unter Konfigurieren von Analysen im Entwicklerportal.
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.

Wenn Sie bestimmte Anpassungen an Ihren API-Ereignisdaten vornehmen wollen, können Sie ein Gateway-Script oder die Operation set-variable in den Definitionen jeder API verwenden, die Sie anpassen wollen. Siehe Daten mit einem Gateway-Script oder einer Operation zum Festlegen von Variablen anpassen.

Zugriff auf Ihre Analysedaten

Sie können Ihre Analysedaten in den Benutzeroberflächen von API Manager und Entwicklerportal anzeigen.
  • In der Benutzerschnittstelle von API Manager kann der Eigner der Provider-Organisation Analysedaten für APIs anzeigen, die in ihren Katalogen veröffentlicht werden.
  • In der Benutzerschnittstelle Developer Portal kann der API-Konsument Analysedaten für APIs anzeigen, die in ihrer Konsumentenorganisation veröffentlicht wurden.
Die maximale Anzahl API-Ereignisse, auf die über die Benutzerschnittstellen zugegriffen werden kann, beträgt 10.000. Die maximale Anzahl an Ereignisdatensätzen, die pro Seite in den Benutzerschnittstellen angezeigt werden können, beträgt 200.

Sie können auf Ihre Analysedaten auch über die Toolkit-CLI oder die REST APIzugreifen.

Sie können den Benutzerzugriff auf Analysedaten mit Benutzerrollen und Berechtigungenverwalten. Weitere Informationen zur Sichtbarkeit benutzerbasierter Analysedaten finden Sie unter Kataloge, Bereiche und Analysen .

Sie können Analysedaten aus Ihren Benutzerschnittstellen exportieren. Der Benutzerschnittstellenexport ist jedoch keine praktische Methode, wenn Sie mehr als 200 API-Ereignisdatensätze exportieren möchten. Verwenden Sie die Toolkit-CLI oder die REST-API, um mehr als 200 API-Ereignisdatensätze auf einmal zu exportieren. Wenn Sie denken, dass Sie alle Ihre Analysedaten regelmäßig exportieren möchten, ziehen Sie die Auslagerung Ihrer Analysedaten auf ein Drittanbietersystemin Betracht.

Analysedaten auf ein Drittanbietersystem auslagern

Die API-Ereignisdaten, die von Ihren Gateways empfangen werden, können an ein System eines anderen Anbieters übertragen werden, anstatt oder zusätzlich vom Analysesubsystem gespeichert zu werden.

Sie können Ihre Analysedaten auf einen AWS S3 -oder Splunk -Server auslagern. Weitere Informationen zum Offloading finden Sie unter Offloading von Analysedaten.