Einblick in Azure API Management

GILT FÜR: Alle API Management-Ebenen

Einblick ist die Fähigkeit, den internen Zustand eines Systems zu verstehen, von den Daten, die es produziert, und der Möglichkeit, diese Daten zu untersuchen, bis zum Beantworten von Fragen dazu, was passiert ist und warum.

Azure API Management unterstützt Organisationen dabei, die Verwaltung aller APIs zu zentralisieren. Da es als einziger Einstiegspunkt für den gesamten API-Datenverkehr fungiert, ist es der ideale Ort, um die APIs zu beobachten.

Übersicht

Azure API Management ermöglicht Ihnen die Verwendung des verwalteten Gateways oder des selbst gehosteten Gateways, entweder selbst bereitgestellt oder mithilfe einer Azure Arc Erweiterung.

Die folgende Tabelle fasst sämtliche von API Management für den Betrieb von APIs unterstützten Observabilityfunktionen sowie die Bereitstellungsmodelle zusammen, die sie unterstützen. Diese Funktionen können von API-Herausgebern und anderen verwendet werden, die über Berechtigungen zum Betreiben oder Verwalten der API Management-Instanz verfügen.

Hinweis

Für API-Consumer, die das Entwicklerportal verwenden, ist ein integrierter API-Bericht verfügbar. Es liefert nur Informationen über die individuelle API-Nutzung in den vorangegangenen 90 Tagen. Derzeit ist der integrierte API-Bericht im Entwicklerportal für die v2-Dienstebenen nicht verfügbar.

Werkzeug Hilfreich für Datenabstand4 Aufbewahrung Stichproben Datenart Unterstützte Bereitstellungsmodelle
Anforderungsablaufverfolgung (API Inspector) Testen und Debuggen Sofort Letzte 100 Traces Aktivierung auf Anforderung Anfrageverfolgungen Verwaltet, Selbstgehostet, Azure Arc, Workspace
Integrierte Analysen Berichterstellung und Überwachung Minuten Lebensdauer 100 % Berichte und Protokolle Verwaltet
Azure Monitor-Metriken Berichterstellung und Überwachung Minuten 90 Tage (Upgrade zum Verlängern) 100 % Metriken Verwaltet, Selbstgehostet2, Azure Arc
Azure Monitor-Protokolle Berichterstellung, Überwachung und Debuggen Minuten 31 Tage/5 GB (Upgrade zur Verlängerung) 100 % (anpassbar) Protokolle Verwaltet1, selbstgehostet3, Azure Arc3
Azure-Anwendung Insights Berichterstellung, Überwachung und Debuggen Sekunden 90 Tage/5 GB (zum Verlängern Upgrade durchführen) Benutzerdefiniert Protokolle, Metriken Verwaltet1, Selbstgehostet1, Azure Arc1, Arbeitsbereich1
Protokollierung über Azure Event Hubs Benutzerdefinierte Szenarien Sekunden Vom Benutzer verwaltet Benutzerdefiniert Benutzerdefiniert Verwaltet1, selbstgehostet1, Azure Arc1
OpenTelemetry Überwachung Minuten Vom Benutzer verwaltet 100 % Metriken Selbstgehostet2

1 Optional, abhängig von der Konfiguration des Features in Azure API Management.
2 Optional, abhängig von der Konfiguration des Gateways.
3 Das selbst gehostete Gateway sendet derzeit keine Diagnoseprotokolle an Azure Monitor. Es ist jedoch möglich, Protokolle lokal dort zu konfigurieren und persistent zu speichern, wo das selbstgehostete Gateway bereitgestellt ist. Weitere Informationen finden Sie unter Konfigurieren lokaler Metriken und Protokolle für selbst gehostetes Gateway.
4 Mit Ausnahme der Anforderungsablaufverfolgung erfolgt die gesamte Protokollierung in der API-Verwaltung asynchron.

Bewährte Vorgehensweisen

Die folgenden Methoden können Ihre API-Observability verbessern:

  • Granulare Überwachung: Aktivieren Sie Metriken pro Methode , um detaillierte Einblicke in Reaktionszeiten und Fehlerraten zu erhalten.
  • Überwachung der Tail-Latenz: Konfigurieren Sie Warnungen pro Methode für die Tail-Latenz (z. B. 90., 95. oder 99. Perzentil), da die durchschnittliche Latenz irreführend sein kann. Um dieses Feature zu implementieren, verwenden Sie Kusto Query Language (KQL), um Protokolle an einen Log Analytics Arbeitsbereich weiterzuleiten.
  • Proaktive Warnung: Richten Sie Warnungen pro Methode für Fehlerraten und niedrige Erfolgsraten ein, verwenden Sie Die Raten anstelle von Zählungen, um die Genauigkeit sicherzustellen.
  • Verteilte Ablaufverfolgung: Aktivieren Sie die Ablaufverfolgung , um Leistungsengpässe zu identifizieren und Probleme zu beheben.
  • Ressourcentags: Anwenden von Tags auf APIs für die genaue Kostennachverfolgung und -zuordnung.