Apigee Analytics – Übersicht

Sie lesen die Dokumentation zu Apigee X.
Apigee Edge-Dokumentation aufrufen

Auf dieser Seite wird Apigee Analytics vorgestellt.

Video: In diesem kurzen Video erhalten Sie einen Überblick über die Apigee API Analytics-Dienste.

API durch Analysen verbessern

Apigee Analytics erfasst und berechnet eine Fülle von Informationen, die über API-Proxys fließen. Sie können diese Daten mit Grafiken und Diagrammen in der Apigee UI visualisieren oder die Rohdaten für die Offlineanalyse mithilfe der Apigee APIs herunterladen.

Mit Analytics erhalten Sie Antworten auf häufig gestellte Fragen wie:

  • Wie entwickelt sich der API-Traffic im Laufe der Zeit?
  • Welche API-Methoden sind am beliebtesten?
  • Wer sind meine Top-Entwickler?
  • Wann werden API-Antworten am schnellsten zurückgegeben? Wann am langsamsten?
  • Aus welcher geografischen Region kommt der meiste API-Traffic?

Sie können Daten für einen bestimmten Hostnamen oder für die gesamte Umgebung analysieren.

Antworten auf Fragen wie diese helfen dabei, APIs zu verbessern, Probleme zu beheben und fundiertere Geschäftsentscheidungen in Bezug auf Ihr API-Programm zu treffen.

API Analytics ermöglicht Optimierungen

Dank der kontinuierlichen Erfassung, Analyse und Visualisierung von Daten hilft Apigee API Analytics Ihrem API-Team, APIs zu verbessern. Weiter können Anwendungsentwickler ihre Anwendungen optimieren:

Datenströme werden von Anwendungen über API-Proxys übertragen. Im Anschluss informiert die Datenanalyse die Aktionen von App-Entwicklern, API-Teams, operativen Teams und Geschäftsinhabern.
  • API-Team – Das API-Team nutzt interne Systeme, um interessante APIs zu erstellen. Das API-Team möchte wissen, wie das API-Programm insgesamt läuft, wie einzelne APIs funktionieren und wie sie ihre APIs verbessern können.
  • App-Entwickler: Wenn Sie Analysedaten mit App-Entwicklern teilen, erhalten Sie bessere Anwendungen. Diese Entwickler modernisieren Ihre API und erstellen kreative Anwendungen, mit denen Sie Ihren Umsatz steigern können. Mithilfe von Analytics wissen App-Entwickler, wie sich Anwendungen entwickeln und wie viel sie zum Endergebnis Ihres Unternehmens beitragen. App-Entwickler möchten wissen, wie sie ihre Anwendungen verbessern können.
  • Ops-Team – Das Betriebsteam möchte Traffic-Muster verstehen und vorhersehen, wann Back-End-Ressourcen hinzugefügt oder andere wichtige Anpassungen vorgenommen werden müssen.
  • Geschäftsinhaber – Der Geschäftsinhaber möchte sehen, wie sich seine API-Investition bezahlt macht und wo er in Sachen APIs in die Zukunft investieren soll.

Welche Daten werden erfasst und analysiert?

Apigee API Analytics erfasst und analysiert ein breites Spektrum an Daten, die über API-Proxys übertragen werden, darunter:

  • Antwortzeit
  • Anfragelatenz
  • Größe der Anfrage
  • Zielfehler
  • API-Produktname
  • E-Mail-Adresse des Entwicklers
  • App-Name
  • Viele andere

Eine vollständige Liste der durch API Analytics erfassten Daten finden Sie in der Referenz zu Analysemesswerten, -dimensionen und -filtern.

Wie erfasse ich benutzerdefinierte Analysedaten?

Apigee erfasst nativ eine Vielzahl von Daten. Möglicherweise möchten Sie auch benutzerdefinierte Analysedaten für Ihre API-Proxys, Anwendungen, Produkte oder Entwickler erheben. Sie können beispielsweise Analysedaten aus Abfrageparametern, Anfrageheadern, Anfrage- und Antworttexten oder Variablen erheben, die Sie in Ihren APIs definieren.

Sie erfassen benutzerdefinierte Analysedaten mit der benutzerdefinierten Erfassung von Analysedaten und untersuchen die Daten mithilfe der Analyse-UI oder -API. Ein vollständiges Beispiel zum Erfassen benutzerdefinierter Analysedaten findet sich unter Analysieren des API-Nachrichteninhalts mit benutzerdefinierten Analysen.

Wann und wie lange sind meine Analysedaten verfügbar?

Es gibt zwei Zeitintervalle, die steuern, wann und wie lange Ihre Analysedaten angezeigt werden können:

  • Datenverzögerungsintervall – Nach einem Aufruf an einen API-Proxy kann es bis zu 10 Minuten dauern, bis die Daten zur Anzeige oder für API-Aufrufe verfügbar sind.
  • Verfügbarkeit von Analysen - Der Zeitraum, in dem Analysedaten (einschließlich Monetarisierungs- und Sense-Daten, falls zutreffend) über Apigee verfügbar werden, unterscheidet sich je nach Plan. Je nach Plan sind die Analysedaten möglicherweise für die letzten 30 oder 90 Tage oder für 14 Monate verfügbar.

Wo werden meine Analysedaten gespeichert?

Sie haben den Standort Ihrer Analysedaten bei der Installation von Apigee oder Apigee Hybrid festgelegt. Gültige Standorte sind eine Teilmenge der Compute Engine-Regionen, die in Schritt 1: Umgebungsvariablen definieren aufgeführt sind.

Wie greife ich auf meine Analysedaten zu?

Apigee Analytics bietet in die Apigee-Benutzeroberfläche integrierte Datenvisualisierungstools. Diese Tools umfassen vordefinierte Analyse-Dashboards und benutzerdefinierte Berichte, in denen Daten in Grafiken und Diagrammen angezeigt werden. Außerdem können Sie Daten nach verschiedenen Dimensionen aufschlüsseln (darunter API-Proxy, IP-Adresse oder HTTP-Statuscode).

Weiter können Sie Analysedaten mithilfe der Apigee API herunterladen. Nach dem Herunterladen können Sie diese Daten in Ihre eigenen Datenvisualisierungstools oder Ihr Analysesystem importieren.

Analytics-Dashboards

Die Apigee UI bietet eine Reihe vordefinierter Dashboards, mit denen Sie Analysedaten einsehen können. Die folgenden Abbildungen zeigen beispielsweise das Dashboard für die API-Proxy-Leistung:

Dieses Dashboard enthält Diagramme für:

  • Gesamtzahl der Zugriffe – Die Gesamtzahl der API-Anfragen, die von Apigee für eine API-Umgebung in einer Organisation empfangen wurden.
  • Erfolgreicher Traffic: Die Gesamtzahl der Anfragen, die zu einer erfolgreichen Antwort geführt haben. Fehlerantworten zählen nicht.
  • Traffic-Fehler – Die Gesamtzahl aller nicht erfolgreichen API-Anfragen. Das heißt, Anfragen, die keine Antwort bedingt haben. Die Anzahl umfasst sowohl Proxy-Fehler (von Apigee) als auch Zielfehler (von den Back-End-Diensten).
  • Durchschnittliche TPS – Die durchschnittliche Anzahl von API-Anfragen und die daraus resultierenden Antworten pro Sekunde.

Weitere vordefinierte Dashboards sind:

Weitere Informationen zu den vordefinierten Dashboards finden sich unter Verwenden der Analyse-Dashboards.

Benutzerdefinierte Berichte

Mit benutzerdefinierten Berichten können Sie bestimmte API-Messwerte aufschlüsseln und genau die Daten anzeigen, die Sie interessieren. Sie können mithilfe der in Apigee integrierten Analysedaten benutzerdefinierte Berichte erstellen.

Beim Erstellen eines benutzerdefinierten Berichts wählen Sie die Daten aus, die Sie interessieren (Messwerte), gruppieren die Daten auf sinnvolle Weise (Dimensionen) und filtern optional die zurückgegebenen Daten anhand bestimmter Merkmale der Daten (Filter).

Sie können den im benutzerdefinierten Bericht angezeigten Diagrammtyp auch als Spalten- oder Liniendiagramm festlegen. Folgende Bilder zeigen Diagrammbeispiele für Transaktionen pro Sekunde, gruppiert nach API-Proxy:

  • Spalte: Jeder API-Proxy wird durch eine andere Spalte dargestellt:

    Benutzerdefiniertes Säulendiagramm

  • Zeile: Jeder API-Proxy wird durch eine andere Zeile dargestellt:

    Benutzerdefiniertes Liniendiagramm

Weitere Informationen finden sich unter Erstellen und Verwalten benutzerdefinierter Berichte.

Analytics API

Verwenden Sie die Apigee API, um Analysedaten herunterzuladen. Beispielsweise können Sie die API verwenden, um Ihre eigenen Visualisierungstools zu erstellen, die Sie in Portale oder benutzerdefinierte Anwendungen einbetten können.

Hier sehen Sie ein Beispiel für einen API-Aufruf zum Abruf von Analysedaten von API-Proxys:

curl "https://apigee.googleapis.com/v1/organizations/myorg/environments/test/stats/apiproxy?"select=sum(message_count)&timeRange=6/24/20120%2000:00~6/24/2020%2023:59&timeUnit=hour" \
  -X POST \
  -H "Authorization: Bearer $TOKEN"

Der Aufruf gibt Folgendes zurück:

  • Die Summe der Anfragen (Anzahl der Nachrichten) pro API-Proxy
  • Über einen Zeitraum von 24 Stunden
  • Nach Stunde gruppiert

Der Abfrageparameter timeRange gibt den Zeitraum in folgender Form an:

?timeRange=MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM

Beachten Sie die Angabe %20 vor HH:MM. Der Parameter timeRange erfordert ein URL-codiertes Leerzeichen vor HH:MM oder ein +-Zeichen wie in MM/DD/YYYY+HH:MM~MM/DD/YYYY+HH:MM.

Weitere Informationen finden Sie unter Metric API verwenden.

Analysedaten an die GCP exportieren

Sie können die Apigee API verwenden, um alle Analysedaten für einen ganzen Tag von Apigee in ein eigenes Datenrepository wie Google Cloud Storage oder BigQuery zu exportieren. Anschließend können Sie die leistungsstarke Funktionen für Abfragen und maschinelles Lernen von Google Cloud BigQuery und TensorFlow nutzen, um Ihre eigene Datenanalyse durchzuführen.

Weitere Informationen finden Sie unter Daten aus Analytics exportieren.

Wie gebe ich Daten für Anwendungsentwickler frei?

Wenn Sie sich App-Entwickler als Kunden vorstellen, sollten Sie dafür sorgen, dass ihnen die Tools und Informationen zur Verfügung stehen, mit denen sie Ihre API optimal nutzen können.

Anwendungen senden Daten über API-Proxys. Die Analyse der Daten hilft App-Entwicklern, den Status ihrer Anwendungen zu verstehen.

App-Entwickler interessieren sich nicht nur für die Qualität ihrer Anwendungen, sondern auch für Ihre APIs. Die Drupal-basierten Entwicklerportale enthalten eine optionale Seite zur Anwendungsleistung, auf der App-Entwickler auf wichtige Messwerte für ihre Anwendungen zugreifen können. Auf dieser Seite finden Entwickler Informationen zu folgenden Themen:

  • Fehler: Welche API-Fehler treten bei meiner App auf?
  • Leistung: Ist die API im Moment langsam? Welche API-Methoden sind grundsätzlich langsam oder nur derzeit langsam?
  • Verfügbarkeit: Ist die API im Moment aktiv oder inaktiv?
  • Kontingent: Hat die API ein Kontingent? Und wie stehe ich als App-Entwickler in Sachen Kontingent da?

Weitere Informationen finden sich unter Anwendungen überwachen in der Drupal 8-Dokumentation.

Darüber hinaus können Sie Analysen auf folgende Arten für Ihre Entwickler freigeben:

Wie erstelle ich umfassende Analysedaten?

Was verstehen wir unter einer umfassenden Analyse? Sie können beispielsweise einen API-Proxy erstellen, und Apigee erfasst dann Analysedaten zu diesem Proxy. Aber wie sieht es mit Messwerten zum Entwickler oder zur App aus, die das API-Proxy aufgerufen hat? Wenn Apigee nicht weiß, wer einen API-Aufruf gemacht hat, kann es diese Daten nicht erfassen.

Es sind einige Schritte erforderlich, damit Apigee herausfinden kann, welche Entwickler und welche Entwickleranwendungen Ihre API-Proxys aufrufen. Hier eine Liste dieser Schritte mit Links zu detaillierteren Informationen:

  1. Erstellen eines oder mehrerer API-Produkte, d. h. eine Gruppe von API-Proxys mit einem Serviceplan. Siehe API-Produkte verwalten.
  2. App-Entwickler bei Apigee registrieren: Weitere Informationen finden Sie unter App-Entwickler registrieren.
  3. Anwendungen registrieren und API-Schlüssel für Ihre Entwickler verwalten. Siehe Anwendungen registrieren und API-Schlüssel verwalten.
  4. Fügen Sie Sicherheitsrichtlinien zu Ihren API-Proxys hinzu, die API-Schlüssel und/oder Sicherheitstoken prüfen. Siehe folgende Themen: VerifyAPIKey-Richtlinie, OAuthV2-Richtlinie und VerifyJWT-Richtlinie.

In folgenden Anleitungen werden Sie durch die erforderlichen Schritte geführt, mit denen Sie Analysen für Entwickler und Anwendungen aufrufen können: APIs durch erforderliche API-Schlüssel sichern und APIs mit OAuth sichern

Weitere Informationen