API-Monitoring

Auf dieser Seite wird beschrieben, wie Sie mithilfe der von API Gateway automatisch erfassten Logs und Messwerte den Zustand Ihrer API Gateway APIs beobachten können.

Wenn Sie eine API erstellen, wird in API Gateway automatisch ein entsprechender verwalteter Dienst erstellt. Den Namen des erstellten verwalteten Dienstes finden Sie in der Ausgabe des folgenden Befehls:

gcloud api-gateway apis describe API_ID

Der Name Ihres Dienstes ist der Wert des Felds managedService.

Wenn Nutzer Anfragen an Ihre API senden, protokolliert API Gateway Informationen über die Anfragen und Antworten. API Gateway verfolgt außerdem drei der vier goldenen Überwachungssignale: Latenz, Traffic und Fehler. Mit diesen Nutzungs- und Leistungsmesswerten können Sie Ihre API überwachen.

Hinweis

Wenn Sie Logs und Messwerte zur Ansicht generieren möchten, stellen Sie eine API bereit und senden Sie Anfragen an die API. Wenn Sie noch keine API erstellt und in einem Gateway bereitgestellt haben, sehen Sie sich die API Gateway-Kurzanleitung an.

API-Übersicht

Wenn Sie einen Fehler in Ihrem Dienst beheben oder einfach sicherstellen wollen, dass alles wie erwartet abläuft, rufen Sie die API-Übersicht auf.

  1. Rufen Sie in der Google Cloud Console die Seite API Gateway > APIs für Ihr Projekt auf:

    Zu „APIs“

  2. Wenn Sie mehr als eine API haben, klicken Sie auf die zu überwachende API.

  3. Achten Sie darauf, dass Sie sich auf dem Tab Übersicht befinden.

Grafiken

Auf der Übersichtsseite finden Sie eine Reihe von Grafiken für einige der Messwerte. So können Sie auf einen Blick Spitzenwerte, Rückgänge oder unerwartete Aktivitäten erkennen. Mit den Filtern oben auf der Seite können Sie Folgendes tun:

  • Wählen Sie in der Drop-down-Liste Grafiken auswählen die für Sie interessanten Messwerte aus und entfernen Sie die Messwerte, die nicht angezeigt werden sollen.
  • Sie können den Umfang der Diagramme anpassen, indem Sie verschiedene Zeitspannen auswählen. Die in der Grafik angezeigten Werte werden an die Zeitspanne angepasst und auch die Punktgranularität ändert sich.

Methodentabelle

Wenn Sie die Daten weiter aufschlüsseln möchten, scrollen Sie zur Tabelle unter den Grafiken. Sie enthält Messwerte für einzelne Methoden der API. Sie haben folgende Möglichkeiten:

  • Klicken Sie links oben in der Tabelle auf das Symbol Tabelle filtern, um im Drop-down-Menü Optionen für die Filterabfrage auszuwählen. Fügen Sie zwischen den Filterabfragen ein OR ein, um nach mehreren Begriffen zu suchen.
  • Klicken Sie rechts oben in der Tabelle auf das Symbol Spaltenanzeigeoptionen, um eine Drop-down-Liste aufzurufen. Setzen Sie ein Häkchen bei den gewünschten Messwerten und entfernen Sie die Häkchen bei den Messwerten, die nicht angezeigt werden sollen.
  • Wählen Sie in der rechten oberen Ecke der Übersicht mit dem entsprechenden Auswahlelement eine Zeitspanne für die Messwerte in der Tabelle aus. Die ausgewählte Zeitspanne gilt sowohl für die Grafiken als auch für die Tabelle.

Logs

Wenn Sie ein Problem in den Messwerten feststellen, können Sie auf der Seite Log-Explorer in der Google Cloud Console die Protokolle der Anfragen und Antworten für Ihre API aufrufen.

  • Sie können Logs für einzelne Methoden der API aufrufen. Dafür klicken Sie in der Tabelle auf Logs ansehen.

  • Sie können Logs für alle Methoden der API aufrufen. Klicken Sie dafür in der unteren rechten Ecke auf Alle Logs ansehen.

  • So finden Sie API Gateway-Logs direkt in der Log-Explorer-Seite:

    1. Rufen Sie in der Google Cloud Console die Seite Logs-Explorer auf.

      Log-Explorer aufrufen

    2. Wählen Sie Produzierte API, SERVICE_NAME, aus, wobei SERVICE_NAME der Name des verwalteten Dienstes ist.

Details zur Struktur der Logs im Log-Explorer finden Sie in der Referenz zu API Gateway-Logs.

Weitere Verwendungsmöglichkeiten für Logs:

  • Machen Sie sich zuerst mit der Log-Explorer vertraut.

    Im Abfragebereich können Sie die anzuzeigenden Logeinträge einschränken. Sie können beispielsweise angeben, dass alle Anfragen mit einer Latenz von mehr als 300 Millisekunden ausgegeben werden sollen.

  • Senken konfigurieren und verwalten Sie können Logs an BigQuery streamen und dort weitere Analysen vornehmen, die unbearbeiteten Logs in Cloud Storage speichern oder die Logs an Messaging-Themen in Pub/Sub senden.

Nach einem bestimmten Nutzerprojekt filtern

So filtern Sie Messwerte für ein bestimmtes Nutzerprojekt:

  1. Rufen Sie die Projektnummer des API-Nutzerprojekts ab. Wenn Sie keine Berechtigung für den Zugriff auf das API-Nutzerprojekt haben, bitten Sie eine berechtigte Person, die Projektnummer für Sie zu ermitteln.

  2. Rufen Sie in der Google Cloud Console die Seite API Gateway > APIs für Ihr Projekt auf.

    Zu „APIs“

  3. Geben Sie in der linken oberen Ecke der Seite Übersicht die Projektnummer in das Bearbeitungsfeld Nach Projektnummer filtern ein.

  4. Klicken Sie auf Filtern.

Die Messwerte auf der Seite werden aktualisiert, sodass nur der Traffic für das angegebene Projekt angezeigt wird.

Nächste Schritte