API-Analyse – Übersicht

Sie sehen sich die Dokumentation zu Apigee Edge an.
Sehen Sie sich die Apigee X-Dokumentation an. info

In diesem Thema wird Edge API Analytics vorgestellt.

API durch Analysen verbessern

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

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

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

Edge 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 mithilfe der StatisticsCollector-Richtlinie. Nachdem die benutzerdefinierten Daten extrahiert wurden, können Sie sie 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-Monitoring-Daten

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.
• Datenaufbewahrung: Wie lange Analysedaten aufbewahrt werden, hängt von Ihrem Abo ab:
  • Standard: 30 Tage
  • Enterprise: 3 Monate
  • Enterprise Plus: 14 Monate
  Weitere Informationen finden Sie unter Apigee API Management-Preise.

Wie greife ich auf meine Analysedaten zu?

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

Weiter können Sie Analysedaten mithilfe der Edge Management 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 einsehen 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 (von Apigee) als auch Zielfehler (von den Backend-Diensten).
• Durchschnittliche TPS – Die durchschnittliche Anzahl von API-Anfragen und die daraus resultierenden Antworten pro Sekunde.

Weitere vordefinierte Dashboards sind:

• Cacheleistung
• Entwicklerengagement
• Gerätenutzung
• Fehlercodeanalyse
• GeoMap
• Latenzanalyse
• Leistung der Zielsysteme
• Traffic-Zusammensetzung

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 benutzerdefinierte Berichte erstellen, indem Sie die in der StatisticsCollector-Richtlinie erfassten Analysedaten aus Edge oder benutzerdefinierten Analysen verwenden.

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:

  

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

  

Weitere Informationen finden Sie unter Benutzerdefinierte Berichte erstellen und verwalten.

Analytics API

Verwenden Sie die Edge Management 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 Mess-APIs zum Messen der API-Programmleistung verwenden.

Analysedaten in Google Cloud exportieren

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

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 Sie unter:

• Drupal 7: Analysen zur App-Nutzung anzeigen
• Drupal 8: Apps überwachen
• Integriertes Portal: nicht verfügbar

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

• Benutzerdefinierte Berichte erstellen und mit App-Entwicklern teilen. Weitere Informationen finden Sie unter Benutzerdefinierte Berichte erstellen.
• Verwenden der Edge-Verwaltungs-API zur Erfassung von Daten über einen längeren Zeitraum, um sie offline mit App-Entwicklern zu teilen. Weitere Informationen finden Sie unter Mess-APIs zum Messen der API-Programmleistung verwenden.

Wie erstelle ich umfassende Analysedaten?

Was verstehen wir unter einer umfassenden Analyse? Sie können beispielsweise einen API-Proxy erstellen, und Edge 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 Edge nicht weiß, wer einen API-Aufruf gemacht hat, kann es diese Daten nicht erfassen.

Es sind einige Schritte erforderlich, damit Edge 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. Weitere Informationen finden Sie unter API-Produkte verwalten.
2. App-Entwickler bei Edge registrieren Weitere Informationen finden Sie unter App-Entwickler registrieren.
3. Anwendungen registrieren und API-Schlüssel für Ihre Entwickler generieren. 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 das Edge Microgateway verwenden, muss das Analytics-Plug-in aktiviert sein. Es ist standardmäßig aktiviert. Wenn das Analyse-Plug-in deaktiviert ist, sendet das Edge Microgateway keine Analysedaten an Edge Analytics.

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. Beim API-Monitoring werden Analysedaten untersucht, um in Echtzeit kontextbezogene Einblicke in die API-Leistung zu erhalten. So können Sie Probleme schnell diagnostizieren und Maßnahmen für die Geschäftskontinuität ergreifen. Mit API-Monitoring können Sie schnell Problemstellen in Ihren APIs und Back-Ends finden. API-Analysen sind für die Erfassung einer Vielzahl von Analysedaten für verschiedene Teams konzipiert. Die Daten werden jedoch in der Regel für Analysen in nicht Echtzeit verwendet.

Einer der Hauptunterschiede zwischen API-Monitoring und API-Analyse ist der in API-Monitoring integrierte Benachrichtigungsmechanismus. Bei Benachrichtigungen geben Sie einen HTTP-Statuscode (2xx/4xx/5xx), eine Latenz oder einen Fehlercode-Grenzwert an, der bei Überschreitung eine Benachrichtigung an Ihr Operationsteam auslöst. Benachrichtigungen können über verschiedene Kanäle gesendet werden, z. B. E-Mail, Slack, Pager oder Webhooks. So können Sie Probleme sofort beheben.

Einen detaillierteren Vergleich dieser Dienste finden Sie unter API-Monitoring mit Edge API Analytics vergleichen.

Weitere Informationen

• Analyse-Dashboards verwenden
• Benutzerdefinierte Berichte erstellen und verwalten
• Messwert-APIs verwenden
• API-Nachrichteninhalt mit benutzerdefinierten Analysen analysieren