API-Analyse – Übersicht

Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation
weitere Informationen

In diesem Thema wird Edge API Analytics vorgestellt.

Video: Schauen Sie sich ein kurzes Video an, um einen Überblick über die Edge API Analytics-Dienste zu erhalten.

API durch Analysen verbessern

Edge API Analytics sammelt und berechnet eine Fülle von Informationen, die über API-Proxys fließen. Sie können diese Daten in der Edge-Benutzeroberfläche mit Grafiken und Diagrammen visualisieren oder die Rohdaten für die Offlineanalyse mit den Edge Management 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?

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

Durch einen kontinuierlichen Prozess des Sammelns, Analysierens und Visualisierens von Daten hilft Edge API Analytics Ihrem API-Team, seine APIs zu verbessern, und unterstützt App-Entwickler bei der Verbesserung ihrer Apps:

alt_text
  • 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 Operations-Team möchte die 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?

Edge API Analytics sammelt und analysiert ein breites Spektrum von Daten, die über API-Proxys fließen, wie z. B.:

  • 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?

Edge sammelt nativ eine Fülle 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 mithilfe der StatisticsCollector-Richtlinie. Sobald die benutzerdefinierten Daten extrahiert sind, können Sie die Daten mithilfe der Analyse-UI oder -API untersuchen. Ein vollständiges Beispiel zum Erfassen benutzerdefinierter Analysedaten findet sich unter Analysieren des API-Nachrichteninhalts mit benutzerdefinierten Analysen.

Unterschiede zwischen Analytics-Daten und API-Überwachungsdaten

In diesem Abschnitt werden einige geringfügige Unterschiede zwischen von Edge Analytics erfassten Daten und dem API-Monitoring beschrieben. Da API-Monitoring und Analytics unterschiedliche Datenpipelines verwenden, kann es zu geringfügigen Unterschieden zwischen den von Monitoring und Analytics generierten benutzerdefinierten Berichten kommen. Es können beispielsweise Abweichungen bei den gemeldeten Ergebnissen für Zeitüberschreitungsfehler auftreten – sowohl Back-End-Zeitüberschreitungen (HTTP-Statuscode 504 in der Anfrage) als auch Clientzeitüberschreitungen (HTTP-Statuscode 499). Diese können in benutzerdefinierten Analytics-Berichten mit dem Statuscode 200 angezeigt werden, in benutzerdefinierten Monitoringberichten jedoch mit dem Statuscode 504 oder 499.

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 dem Aufruf eines API-Proxys kann es bis zu 10 Minuten dauern, bis die Daten zur Anzeige oder über Verwaltungs-API-Aufrufe zugänglich sind.
  • Datenaufbewahrung – Der Zeitraum, in dem Analysedaten von Edge abhängig vom Tarif aufbewahrt werden. Je nach Plan sind die Analysedaten für die letzten 30, 60, 90 oder 365 Tage verfügbar.

Wie greife ich auf meine Analysedaten zu?

Edge API Analytics bietet Datenvisualisierungstools, die in die Edge-Benutzeroberfläche integriert sind. 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).

Darüber hinaus können Sie Analysedaten mithilfe der Edge-Verwaltungs-API herunterladen. Nach dem Herunterladen können Sie diese Daten in Ihre eigenen Datenvisualisierungstools oder Ihr Analysesystem importieren.

Analytics-Dashboards

Die Edge-Benutzeroberfläche bietet eine Reihe vordefinierter Dashboards, mit denen Sie Analysedaten anzeigen können. Die folgenden Abbildungen zeigen beispielsweise das Dashboard für die Proxy-Leistung:

Dieses Dashboard enthält Diagramme für:

  • Gesamtzahl der Zugriffe - Die Gesamtzahl der API-Anfragen, die von Edge 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 (Apigee-Seite) als auch Zielfehler (Back-End-Dienste).
  • 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 einen benutzerdefinierten Bericht erstellen, indem Sie die in Edge integrierten Analysedaten oder benutzerdefinierte Analysedaten verwenden, die von der StatisticsCollector-Richtlinie erfasst wurden.

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 Sie unter Benutzerdefinierte Berichte erstellen und verwalten.

Analytics API

Verwenden Sie die Edge-Verwaltungs-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://api.enterprise.apigee.com/v1/o/org_name/environments/test/stats/apiproxy?"select=sum(message_count)&timeRange=6/24/2018%2000:00~6/24/2018%2023:59&timeUnit=hour" \
-u email:password

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 Verwenden der Metrik-APIs zum Messen der API-Programmleistung.

Analysedaten in Google Cloud exportieren

Sie können die Edge Management API verwenden, um alle Analysedaten für einen ganzen Tag aus Edge in Ihr eigenes Daten-Repository 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.

alt_text

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 werden von meiner App angezeigt?
  • 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 auf oder ab?
  • Kontingent: Hat die API ein Kontingent? Und wie stehe ich als App-Entwickler in Sachen Kontingent da?

Weitere Informationen:

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 Edge Analytics-Daten zu diesem Proxy erfassen. Aber wie sieht es mit Messwerten zum Entwickler oder zur App aus, die das API-Proxy aufgerufen hat? Wenn Edge nicht weiß, wer einen API-Aufruf getätigt hat, kann er diese Daten nicht erfassen.

Es sind einige Schritte erforderlich, damit Edge herausfinden kann, welche Entwickler und welche Entwickler-Apps 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. Registrieren Sie App-Entwickler bei Edge. Siehe App-Entwickler registrieren.
  3. Registrieren Sie Apps und generieren Sie API-Schlüssel für Ihre Entwickler. Weitere Informationen finden Sie unter 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:API-Schlüsselrichtlinie prüfen, OAuthV2-Richtlinie und JWT-Richtlinie prüfen.
  5. Wenn Sie Edge Microgateway verwenden, muss das Analyse-Plug-in aktiviert sein (standardmäßig aktiviert). Wenn das Analyse-Plug-in deaktiviert ist, sendet Edge Microgateway keine Analysedaten an die Edge-Analyse.

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

Vergleich: API-Analysen und API Monitoring

Sie können sowohl das API-Monitoring von Edge als auch API Analytics nutzen. API Monitoring untersucht Analysedaten, um in Echtzeit kontextbezogene Einblicke in die API-Leistung zu liefern. So können Sie schnell Probleme diagnostizieren und Abhilfemaßnahmen für die Geschäftskontinuität erleichtern. Mit dem API-Monitoring können Sie schnell Fehler in Ihren APIs und Back-Ends finden. API Analytics wurde entwickelt, um eine breite Palette von Analysedaten zur Verwendung durch verschiedene Teams zu erfassen. Die Daten werden jedoch normalerweise für Analysen in Nicht-Echtzeit-Szenarien verwendet.

Einer der Hauptunterschiede zwischen API Monitoring und API Analytics ist der in das API-Monitoring integrierte Benachrichtigungsmechanismus. Bei Warnungen geben Sie einen HTTP-Statuscode (2xx/4xx/5xx), eine Latenz oder einen Fehlercodegrenzwert an, der bei Überschreitung eine Warnmeldung an Ihr Ops-Team auslöst. Benachrichtigungen können über verschiedene Kanäle wie E-Mail, Slack, Pager oder Webhooks gesendet werden, sodass Sie sofort auf Probleme reagieren können.

Einen detaillierteren Vergleich zwischen diesen Diensten finden Sie unter Vergleichen der API-Überwachung mit Edge API Analytics.

Weitere Informationen