API-Monitoring

Auf dieser Seite wird beschrieben, wie Sie den Status Ihrer API Gateway APIs mithilfe der Logs und Messwerte überwachen können, die API Gateway automatisch für Sie speichert.

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

gcloud api-gateway apis describe API_ID

Der Name des Dienstes ist der Wert des Felds managedService.

Wenn Nutzer Anfragen an Ihre API senden, protokolliert API Gateway Informationen zu den 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.

Hinweise

Stellen Sie eine API bereit und senden Sie Anfragen an diese, um Logs und Messwerte für die Ansicht zu generieren. Wenn Sie noch keine API erstellt und für ein Gateway bereitgestellt haben, lesen Sie die Kurzanleitung zu API Gateway.

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:

    Zur Seite „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 zu einigen Messwerten, sodass Sie Spitzen, Rückgänge oder unerwartete Aktivitäten sofort erkennen können. Mit den Filtern oben auf der Seite können Sie Folgendes tun:

  • Über die Drop-down-Liste Grafiken auswählen können Sie Grafiken für Messwerte aufrufen, die Sie interessieren, und nicht relevante Messwerte entfernen.
  • Passen Sie den Umfang der Diagramme an, indem Sie einen Zeitraum auswählen. Damit wird der Zeitraum der angezeigten Werte angepasst, was auch die Punktgranularität ändert.

Methodentabelle

Wenn Sie die Daten weiter aufschlüsseln möchten, scrollen Sie unter den Diagrammen nach einer Tabelle mit Messwerten für einzelne Methoden in Ihrer API. Sie können:

  • Klicken Sie in der oberen linken Ecke der Tabelle auf das Symbol Tabelle filtern, um optimierte Filterabfrageoptionen aus der Drop-down-Tabelle auszuwählen. Fügen Sie zwischen jeder Filterabfrage ein OR ein, um nach mehreren Begriffen zu suchen.
  • Klicken Sie in der oberen rechten Ecke der Tabelle auf das Symbol Spaltenanzeigeoptionen, um eine Drop-down-Liste aufzurufen. Aktivieren Sie die gewünschten Messwerte und deaktivieren Sie die, 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 Logs der Anfragen und Antworten für Ihre API ansehen.

  • 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 auf der Seite „Log-Explorer“:

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

      Zur Seite „Log-Explorer“

    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.

    Geben Sie im Abfragebereich die Logeinträge an, die Sie ansehen möchten, z. B. um alle Anfragen mit einer Latenz von mehr als 300 Millisekunden abzurufen.

  • 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.

    Zur Seite „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