Abrufen von API-Analysen in Azure API Management

  • Artikel

GILT FÜR: Entwickler | Basic | Basic v2 | Standard | Standard v2 | Premium

Azure API Management bietet Analysen für Ihre APIs, damit Sie ihre Nutzung und Leistung analysieren können. Verwenden Sie Analysen für die allgemeine Überwachung und Problembehandlung Ihrer APIs. Weitere Überwachungsfunktionen, einschließlich Metriken und Ressourcenprotokollen in nahezu Echtzeit für die Diagnose und Überwachung, finden Sie im Tutorial: Überwachen veröffentlicher APIs.

Screenshot der API-Analyse im Portal.

Informationen zu API-Analysen

  • API Management stellt Analysen mithilfe eines Azure Monitor-basierten Dashboards bereit. Das Dashboard aggregiert Daten in einem Azure Log Analytics-Arbeitsbereich.

  • In den klassischen API Management-Dienstebenen umfasst Ihre API-Verwaltungsinstanz auch ältere integrierte Analysen im Azure-Portal, und Analysedaten können mithilfe der API-Management-REST-API aufgerufen werden. Entsprechende Daten werden im Azure Monitor-basierten Dashboard und integrierten Analysen angezeigt.

Wichtig

  • Das Azure Monitor-basierte Dashboard ist die empfohlene Methode für den Zugriff auf Analysedaten.
  • Ältere integrierte Analysen sind in den v2-Ebenen nicht verfügbar.

Mit API Analytics analysieren Sie die Nutzung und Leistung der APIs in Ihrer API Management-Instanz über mehrere Dimensionen hinweg, einschließlich:

  • Zeit
  • Geografie
  • APIs
  • API-Vorgänge
  • Produkte
  • Abonnements
  • Benutzer
  • Requests

Hinweis

  • API Analytics stellen Daten zu Anforderungen bereit, einschließlich fehlgeschlagener und nicht autorisierter Anforderungen.
  • Geografiewerte basieren ungefähr auf der IP-Adresszuordnung.
  • Es kann eine Verzögerung von 15 Minuten oder mehr bei der Verfügbarkeit von Analysedaten geben.

Azure Monitor-basiertes Dashboard

Um das Azure Monitor-basierte Dashboard zu verwenden, müssen Sie einen Log Analytics-Arbeitsbereich als Datenquelle für API Management-Gatewayprotokolle konfigurieren.

Wenn Sie einen konfigurieren müssen, sind hier im Folgenden kurz Schritte zum Senden von Gatewayprotokollen an einen Log Analytics-Arbeitsbereich aufgeführt. Weitere Informationen finden Sie im Tutorial: Überwachen veröffentlichter APIs. Dies ist eine einmalige Aufgabe.

  1. Navigieren Sie im Azure-Portal zu Ihrer API Management-Instanz.
  2. Im linken Menü, unter Überwachung die Option Diagnoseeinstellungen>+ Diagnoseeinstellung hinzufügen auswählen.
  3. Geben Sie einen beschreibenden Namen für die Diagnoseeinstellung ein.
  4. Wählen Sie in Protokollen Protokolle im Zusammenhang mit dem ApiManagement-Gateway aus.
  5. Wählen Sie in den ZieldetailsAn Log Analytics senden aus, und wählen Sie einen Log Analytics-Arbeitsbereich im selben oder einem anderen Abonnement aus. Wenn Sie einen Arbeitsbereich erstellen müssen, lesen Sie Erstellen eines Log Analytics-Arbeitsbereichs.
  6. Übernehmen Sie Standardwerte für andere Einstellungen, oder passen Sie sie nach Bedarf an. Wählen Sie Speichern.

Zugreifen auf das Dashboard

Nachdem ein Log Analytics-Arbeitsbereich konfiguriert wurde, greifen Sie auf das Azure Monitor-basierte Dashboard zu, um die Nutzung und Leistung Ihrer APIs zu analysieren.

  1. Navigieren Sie im Azure-Portal zu Ihrer API Management-Instanz.
  2. Wählen Sie im Menü auf der linken Seite unter Überwachung die Option Insights aus. Das Analysedashboard wird geöffnet.
  3. Wählen Sie einen Zeitraum für Daten aus.
  4. Wählen Sie eine Berichtskategorie für Analysedaten aus, z. B. Zeitachse, Geografie usw.

Ältere integrierte Analysen

In bestimmten API Management-Dienstebenen sind auch integrierte Analysen im Azure-Portal verfügbar, und Analysedaten können mithilfe der REST-API für API-Management aufgerufen werden.

Integrierte Analysen – Portal

So greifen Sie auf die integrierte Analyse im Azure-Portal zu:

  1. Navigieren Sie im Azure-Portal zu Ihrer API Management-Instanz.
  2. Wählen Sie im Menü auf der linken Seite unter Überwachung die Option Analysen aus.
  3. Wählen Sie einen Zeitbereich für die Daten aus, oder geben Sie einen benutzerdefinierten Zeitbereich ein.
  4. Wählen Sie eine Berichtskategorie für Analysedaten aus, z. B. Zeitachse, Geografie usw.
  5. Filtern Sie den Bericht optional nach mindestens einer zusätzlichen Kategorie.

Analysen – REST-API

Verwenden Sie Berichtevorgänge in der API Management REST-API, um Analysedaten für Ihre API Management-Instanz abzurufen und zu filtern.

Verfügbare Vorgänge geben Berichtsdatensätze nach API, Geografie, API-Vorgängen, Produkt, Anforderung, Abonnement, Uhrzeit oder Benutzer zurück.

Zugehöriger Inhalt