Tutorial: Überwachen von veröffentlichten APIs

  • Artikel

GILT FÜR: Alle API Management-Ebenen

Mit Azure Monitor können Sie Metriken oder Protokolle aus Ihrem Azure API Management-Dienst visualisieren, abfragen, weiterleiten und archivieren sowie ggf. notwendige Maßnahmen ergreifen.

In diesem Tutorial lernen Sie Folgendes:

  • Anzeigen von Metriken Ihrer API
  • Einrichten einer Warnungsregel
  • Anzeigen von Aktivitätsprotokollen
  • Aktivieren und Anzeigen von Ressourcenprotokollen

Hinweis

API Management unterstützt eine Reihe zusätzlicher Tools zum Beobachten von APIs, einschließlich integrierter Analysen und Integration in Application Insights. Weitere Informationen

Voraussetzungen

Anzeigen von Metriken Ihrer API

Von API Management werden jede Minute Metriken ausgegeben, sodass Sie nahezu in Echtzeit einen Überblick über den Zustand und die Integrität Ihrer APIs erhalten. Im Anschluss finden Sie die beiden am häufigsten verwendeten Metriken. Eine Liste aller verfügbaren Metriken finden Sie unter unterstützte Metriken.

  • Kapazität: Unterstützt Sie beim Treffen von Entscheidungen über Upgrades/Downgrades Ihrer API Management-Dienste. Die Metrik wird minütlich ausgegeben und gibt die zum Zeitpunkt der Meldung geschätzte Gatewaykapazität wieder. Der Wert der Metrik kann zwischen 0 und 100 liegen und wird basierend auf Gatewayressourcen wie CPU und Speicherauslastung berechnet.
  • Anforderungen: Unterstützt Sie bei der Analyse von API-Datenverkehr, der Ihre API Management-Dienste durchläuft. Die Metrik wird pro Minute ausgegeben und gibt die Anzahl der Gatewayanforderungen mit Dimensionen an. Filtern Sie Anforderungen nach Antwortcodes, Speicherort, Hostname und Fehlern.

Wichtig

Die folgenden Metriken sind ab Mai 2019 veraltet und werden im August 2023 eingestellt: Total Gateway Requests (Gatewayanforderungen gesamt), Successful Gateway Requests (Erfolgreiche Gatewayanforderungen), Unauthorized Gateway Requests (Nicht autorisierte Gatewayanforderungen), Failed Gateway Requests (Fehlgeschlagene Gatewayanforderungen), Other Gateway Requests (Sonstige Gatewayanforderungen). Migrieren Sie zur Metrik „Anforderungen“, die eine entsprechende Funktionalität bietet.

Screenshot: Übersicht über Metriken in API Management

So greifen Sie auf Metriken zu:

  1. Navigieren Sie im Azure-Portal zu Ihrer API Management-Instanz. Überprüfen Sie auf der Seite Übersicht auf der Registerkarte Überwachen die Schlüsselmetriken für Ihre APIs.

  2. Um Metriken im Detail zu untersuchen, wählen Sie im linken Menü Metriken aus.

    Screenshot des Elements „Metriken“ im Menü „Überwachung“ im Portal.

  3. Wählen Sie im Dropdownmenü die gewünschten Metriken aus. Beispiel: Anforderungen.

  4. Im Diagramm ist die Gesamtanzahl von API-Aufrufen gezeigt. Passen Sie den Zeitbereich an, um sich auf die relevanten Zeiträume zu konzentrieren.

  5. Das Diagramm kann anhand der Dimensionen der Metrik Anforderungen gefiltert werden. Wählen Sie beispielsweise Filter hinzufügen und anschließend die Kategorie des Back-End-Antwortcodes aus, und geben Sie 500 als Wert ein. Das Diagramm zeigt die Anzahl von Anforderungen an, für die im API-Back-End ein Fehler auftrat.

Einrichten einer Warnungsregel

Sie können Warnungen auf der Grundlage von Metriken und Aktivitätsprotokollen empfangen. Konfigurieren Sie in Azure Monitor eine Warnungsregel, um eine Aktion auszuführen, wenn sie ausgelöst wird. Gängige Aktionen umfassen:

  • Senden einer E-Mail-Benachrichtigung
  • Aufrufen eines Webhooks
  • Aufrufen einer Azure-Logik-App

So konfigurieren Sie eine exemplarische Warnungsregel auf der Grundlage einer Anforderungsmetrik:

  1. Navigieren Sie im Azure-Portal zu Ihrer API Management-Instanz.

  2. Wählen Sie im linken Menü Warnungen aus.

    Screenshot der Option „Warnungen“ im Menü „Überwachung“ im Portal.

  3. Wählen Sie + Erstellen>Warnungsregel aus.

  4. Im Fenster Signal auswählen auf der Registerkarte Bedingung:

    1. Wählen Sie unter Signaltyp die Option Metriken aus.
    2. Wählen Sie unter Signalname die Option Anforderungen aus.
    3. Geben Sie unter Warnungslogik einen Schwellenwert an, bei dem es sich um die Anzahl der Vorkommen handelt, nach der die Warnung ausgelöst werden soll.
    4. Wählen Sie im Abschnitt Split by dimensions (Nach Dimensionen aufteilen) unter Dimensionsname die Kategorie für den Gatewayantwortcode aus.
    5. Wählen Sie unter Dimensionswerte die Option 4xx (für Clientfehler wie nicht autorisierte oder ungültige Anforderungen) aus. Wenn der Dimensionswert nicht angezeigt wird, wählen Sie Benutzerdefinierten Wert hinzufügen aus, und geben Sie 4xx ein.
    6. Akzeptieren Sie unter Zeitpunkt der Auswertung die Standardeinstellungen, oder wählen Sie andere Einstellungen aus, um zu konfigurieren, wie oft die Regel ausgeführt wird. Wählen Sie Weiter aus.

    Screenshot des Konfigurierens der Warnungslogik im Portal.

  5. Wählen Sie auf der Registerkarte Aktionen eine oder mehrere Aktionsgruppen aus, oder erstellen Sie sie, um Benutzer über die Warnung zu benachrichtigen und eine Aktion auszuführen. Erstellen Sie beispielsweise eine neue Aktionsgruppe, um eine Benachrichtigungs-E-Mail an admin@contoso.com zu senden. Ausführliche Schritte finden Sie unter Erstellen und Verwalten von Aktionsgruppen im Azure-Portal.

    Screenshot des Konfigurierens von Benachrichtigungen für eine neue Aktionsgruppe im Portal.

  6. Geben Sie auf der Registerkarte Details von Warnungsregel erstellen einen Namen und eine Beschreibung der Warnungsregel ein, und wählen Sie den Schweregrad aus.

  7. Konfigurieren Sie optional die verbleibenden Einstellungen. Wählen Sie dann auf der Registerkarte Überprüfen + erstellen die Option Erstellen aus.

  8. Testen Sie nun die Warnungsregel, indem Sie die Konferenz-API ohne API-Schlüssel aufrufen. Zum Beispiel:

    curl GET https://apim-hello-world.azure-api.net/conference/speakers HTTP/1.1

    Eine Warnung wird basierend auf dem Auswertungszeitraum ausgelöst und sendet eine E-Mail an admin@contoso.com.

    Warnungen werden auch auf der Seite Warnungen für die API Management-Instanz angezeigt.

    Screenshot von Warnungen im Portal.

Aktivitätsprotokolle

Aktivitätsprotokolle geben Einblick in die Vorgänge in Ihren API Management-Diensten. Mit dem Aktivitätsprotokoll können Sie die Antworten auf die Fragen „Was“, „Wer“ und „Wann“ für alle Schreibvorgänge (PUT, POST, DELETE) ermitteln, die für Ihre API Management-Dienste durchgeführt wurden.

Hinweis

Aktivitätsprotokolle enthalten keine Lesevorgänge (GET) oder Vorgänge, die im Azure-Portal oder mithilfe der ursprünglichen Management-APIs durchgeführt wurden.

Sie können in Ihrem API Management-Dienst auf Aktivitätsprotokolle oder in Azure Monitor auf Protokolle all Ihrer Azure-Ressourcen zugreifen.

Screenshot des Aktivitätsprotokolls im Portal.

So zeigen Sie das Aktivitätsprotokoll an:

  1. Navigieren Sie im Azure-Portal zu Ihrer API Management-Instanz.

  2. Wählen Sie Aktivitätsprotokoll aus.

    Screenshot des Elements „Aktivitätsprotokoll“ im Menü „Überwachung“ im Portal.

  3. Wählen Sie den gewünschten Filterbereich und anschließend Anwenden aus.

Ressourcenprotokolle

Ressourcenprotokolle (Azure Monitor-Protokolle) bieten umfassende Informationen zu API Management-Vorgängen und -Fehlern, die für die Überwachung und Problembehandlung relevant sind. Wenn die Protokolle über eine Diagnoseeinstellung aktiviert werden, sammeln sie Informationen zu den API-Anforderungen, die vom API Management-Gateway empfangen und verarbeitet werden.

Hinweis

Der Verbrauchstarif unterstützt keine Sammlung von Ressourcenprotokollen.

So konfigurieren Sie Ressourcenprotokolle:

  1. Navigieren Sie im Azure-Portal zu Ihrer API Management-Instanz.

  2. Wählen Sie Diagnoseeinstellungen aus.

    Screenshot des Elements „Diagnoseeinstellungen“ im Menü „Überwachung“ im Portal.

  3. Wählen Sie +Diagnoseeinstellung hinzufügen aus.

  4. Wählen Sie die zu sammelnden Protokolle oder Metriken aus.

    Sie haben mehrere Optionen, wohin Sie die Protokolle und Metriken senden können. Beispielsweise können Sie Ressourcenprotokolle zusammen mit Metriken in einem Speicherkonto archivieren, an Event Hub streamen oder an einen Log Analytics-Arbeitsbereich senden.

    Tipp

    Wenn Sie einen Log Analytics-Arbeitsbereich auswählen, können Sie die Daten in der ressourcenspezifischen „ApiManagementGatewayLogs“-Tabelle oder in der allgemeinen „AzureDiagnostics“-Tabelle speichern. Es wird empfohlen, die ressourcenspezifische Tabelle für Protokollziele zu verwenden, die diese unterstützen. Weitere Informationen

  5. Nachdem Sie Details für ein oder mehrere Protokollziele konfiguriert haben, wählen Sie Speichern aus.

Hinweis

Das Hinzufügen eines Diagnoseeinstellungsobjekts kann zu einem Fehler führen, wenn die MinApiVersion-Eigenschaft Ihres API Management-Diensts auf eine höhere API-Version als 2022-09-01-preview festgelegt ist.

Weitere Informationen finden Sie unter Erstellen von Diagnoseeinstellungen zum Senden von Plattformprotokollen und Metriken an verschiedene Ziele.

Anzeigen von Diagnosedaten in Azure Monitor

Wenn Sie die Sammlung von Protokollen oder Metriken in einem Log Analytics-Arbeitsbereich aktiviert haben, kann es ein paar Minuten dauern, bis die Daten in Azure Monitor angezeigt werden.

So zeigen Sie die Daten an:

  1. Navigieren Sie im Azure-Portal zu Ihrer API Management-Instanz.

  2. Wählen Sie im linken Menü die Option Protokolle aus.

    Screenshot des Elements „Protokolle“ im Menü „Überwachung“ im Portal.

  3. Führen Sie Abfragen aus, um die Daten anzuzeigen. Es stehen mehrere Beispielabfragen zur Verfügung. Sie können aber auch eine eigene Abfrage verwenden. Mit der folgenden Abfrage werden beispielsweise die Daten der letzten 24 Stunden aus der Tabelle „ApiManagementGatewayLogs“ abgerufen:

    ApiManagementGatewayLogs
| where TimeGenerated > ago(1d)

    Screenshot des Abfragens der „ApiManagementGatewayLogs“-Tabelle im Portal.

Weitere Informationen zur Verwendung von Ressourcenprotokollen für API Management finden Sie hier:

Ändern von API-Protokollierungseinstellungen

Wenn Sie eine Diagnoseeinstellung erstellen, um die Sammlung von Ressourcenprotokollen zu aktivieren, wird die Protokollierung standardmäßig für alle APIs mit Standardeinstellungen aktiviert. Sie können die Protokollierungseinstellungen für alle APIs anpassen oder für einzelne APIs überschreiben. Passen Sie beispielsweise die Samplingrate oder die Ausführlichkeit der Daten an, oder deaktivieren Sie die Protokollierung für einige APIs.

Ausführliche Informationen zu den Protokollierungseinstellungen finden Sie unter Referenz zu Einstellungen für die Diagnoseprotokollierung.

So konfigurieren Sie Protokollierungseinstellungen für alle APIs

  1. Wählen Sie im linken Menü Ihrer API Management-Instanz APIs>Alle APIs aus.
  2. Wählen Sie die Registerkarte Einstellungen in der oberen Leiste aus.
  3. Scrollen Sie nach unten zum Abschnitt Diagnoseprotokolle, und wählen Sie die Registerkarte Azure Monitor aus.
  4. Überprüfen Sie die Einstellungen, und nehmen Sie bei Bedarf Änderungen vor. Wählen Sie Speichern aus.

So konfigurieren Sie Protokollierungseinstellungen für eine bestimmte API

  1. Wählen Sie im linken Menü Ihrer API Management-Instanz APIs und dann den Namen der API aus.
  2. Wählen Sie die Registerkarte Einstellungen in der oberen Leiste aus.
  3. Scrollen Sie nach unten zum Abschnitt Diagnoseprotokolle, und wählen Sie die Registerkarte Azure Monitor aus.
  4. Überprüfen Sie die Einstellungen, und nehmen Sie bei Bedarf Änderungen vor. Wählen Sie Speichern aus.

Nächste Schritte

In diesem Tutorial haben Sie Folgendes gelernt:

  • Anzeigen von Metriken Ihrer API
  • Einrichten einer Warnungsregel
  • Anzeigen von Aktivitätsprotokollen
  • Aktivieren und Anzeigen von Ressourcenprotokollen

Fahren Sie mit dem nächsten Tutorial fort:

Verwenden des API-Inspektors zur Verfolgung von Aufrufen in Azure API Management