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 über TCP an das Analyse-Subsystem gesendet, und bei einem Netzwerkausfall versucht das Gateway es 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.
Tipp: Wenn die Analysedashboards in Ihren Benutzerschnittstellen die erwarteten API-Ereignisse nicht anzeigen, ist die häufigste Ursache ein Kommunikationsfehler zwischen Ihrem Gateway und den Analysesubsystemen. Überprüfen Sie die Protokolle des Gateway-und des Analysesubsystems.

Sie können mehrere Gateway-und Analyseservices in allen API Connect -Bereitstellungstypen außer OpenShift -CR der höchsten Ebenebereitstellen. Nach der Registrierung eines Gateway-Service in der Benutzerschnittstelle von Cloud Manager ordnen Sie diesem Gateway-Service einen Analyseservice zu. Alle API-Ereignisdaten, die das Gateway generiert, werden an den zugehörigen Analyseservice gesendet. Demselben Analyseservice können mehrere Gateways zugeordnet werden. Sie können demselben Gateway nicht mehrere Analyseservices zuordnen.

Jeder Analyseservice in Ihrer API Connect -Implementierung speichert API-Ereignisdaten nur von den Gateways, denen er zugeordnet ist. Wenn Sie Analysedaten anzeigen, müssen Sie auswählen, von welchem Analyseservice Sie die Daten anzeigen wollen. API Connect bietet keine aggregierte Ansicht aller Analysedaten aus allen Analyseservices. Wenn Sie über mehrere Analyseservices verfügen und die Daten aus allen kombinieren möchten, können Sie die Daten exportieren oder auslagern und manuell eigene Berichte erstellen.

Wenn Sie die CR der höchsten Ebene unter OpenShift oder Cloud Pak for Integrationverwenden, besteht Ihre API Connect -Bereitstellung aus einem Gateway-Service und einem Analyseservice. Alle API-Aufrufe in Ihrer API Connect -Implementierung werden vom einen Gateway-Service verarbeitet und alle generierten API-Ereignisdatensätze werden vom einen Analyseservice gespeichert.

Für Ihre APIs gespeicherte Analysedaten anpassen

Hinweis: Welche API-Verbraucheranalysen im Entwicklerportal angezeigt werden, hängt von den Konfigurationseinstellungen für die Sichtbarkeit ab. Weitere Informationen finden Sie unter Analyse im Entwicklerportal konfigurieren.
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:
  • none: API-Ereignisse werden nicht protokolliert.
  • activity: Protokolliert den URI der API-Ressource. activity ist die Standardprotokolleinstellung für erfolgreiche API-Aufrufe.
  • header : Protokolliert die API-Ressource-URI und die HTTP -Header.
  • nutzlast : Logs API-Ressourcen-URI, HTTP -Header sowie Anfrage- und Antwortnutzlasten. payload ist die Standardprotokolleinstellung für fehlgeschlagene API-Aufrufe, da die Antwortnutzdaten möglicherweise nützliche Informationen zur Fehlerursache enthalten.

Je detaillierter die Einstellung activity log ist, desto größer sind die API-Ereignisdatensätze und desto größer ist der Bedarf an persistentem Speicher für das Analysesubsystem. Weitere Informationen zum Konfigurieren der Aktivitätenprotokollierung finden Sie unter Aktivitätenprotokollrichtlinie.

Wenn Sie bestimmte Anpassungen an Ihren API-Ereignisdaten vornehmen wollen, gibt es zwei Methoden:

Aufbewahrung und Rollover von Analysedaten

API-Ereignisdaten belegen persistenten Speicherplatz auf Ihrem Analysesubsystem. Um sicherzustellen, dass nicht zu wenig persistenter Speicherplatz verfügbar ist, werden API-Ereignisdaten zusammengefasst und die ältesten API-Ereignisdatensätze gelöscht. Analytics API-Ereignisdatensätze werden für eine maximale Anzahl von Tagen aufbewahrt, die durch Ihr Bereitstellungsprofil definiert ist. Zusammenfassende Analysedaten, die aus den API-Ereignisdatensätzen erstellt wurden, werden für 1 Jahr aufbewahrt. Wie lange die Analysedaten gespeichert werden, können Sie mit den Einstellungen Aufbewahrung und Rollover ändern.

Zugriff auf Ihre Analysedaten

Sie können Ihre Analysedaten in den Benutzerschnittstellen von Cloud Manager, API Manager, und Developer Portal anzeigen.
  • Der Cloudbenutzer mit Administratorberechtigung kann die Gesamtzahl der API-Aufrufdatenträger und Aufrufdatenträger pro Gateway in der Cloud Manager -Benutzerschnittstelle anzeigen. Eigner von Provider-Organisationen können es dem Cloudbenutzer mit Administratorberechtigung ermöglichen, Analysedaten und einzelne API-Ereignisdaten für ihre Provider-Organisation anzuzeigen.
  • 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.
    Hinweis: Wenn zwei Gateway-Services für einen Katalog mit einer Portalsite konfiguriert sind, müssen diese beiden Gateway-Services demselben Analyseservice zugeordnet werden. Wenn sie verschiedenen Analyseservices zugeordnet sind, werden keine Analysedaten in der Portalbenutzerschnittstelle angezeigt.

    Diese Einschränkung bedeutet, dass Analysedaten nicht auf den Developer Portal-Sites einer Disaster-Recovery-Implementierung mit zwei Rechenzentren verfügbar sind, auf denen zwei Analysesubsysteme implementiert sind.

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.

Weitere Informationen zum Offloading finden Sie unter Offload auf Fremdsysteme.