API-Monitoring

Auf dieser Seite wird beschrieben, wie Sie mithilfe der von Cloud Endpoints automatisch erfassten Logs und Messwerte den Zustand der eigenen APIs beobachten können. Endpoints schreibt Informationen zu allen Anfragen, die Nutzer an Ihre API senden, und zu allen Antworten in Logs. Endpoints verfolgt außerdem drei der vier goldenen Überwachungssignale: Latenz, Traffic und Fehler. Mit diesen Nutzungs- und Leistungsmesswerten können Sie Ihre API überwachen.

Vorbereitung

Stellen Sie Ihre API bereit und senden Sie Anfragen an die API, um Logs und Messwerte zur Ansicht zu generieren. Wenn noch nichts eingerichtet ist, folgen Sie der Schnellstartanleitung für Endpoints.

API-Übersicht

Wenn Sie einen Fehler in Ihrem Dienst beheben oder einfach für einen reibungslosen Ablauf sorgen möchten, rufen Sie die API-Übersicht auf.

  1. Rufen Sie in der Google Cloud Console die Seite Endpoints > Dienste für Ihr Projekt auf:

    Zur Seite "Endpoints-Dienste"

  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

Im oberen Bereich sehen Sie Grafiken für einige der Messwerte. Hier können Sie auf einen Blick Spitzenwerte und Rückgänge ablesen. Sie haben folgende Möglichkeiten:

  • Wählen Sie in der rechten oberen Ecke der ersten Grafik über die Drop-down-Liste Grafiken auswählen die für Sie interessanten Messwerte aus und entfernen Sie die Messwerte, die nicht angezeigt werden sollen. Jeder Eintrag in der Drop-down-Liste enthält ein Fragezeichen. Wenn Sie den Zeiger darauf halten, wird eine Beschreibung des betreffenden Messwerts eingeblendet.

  • In der rechten oberen Ecke der Übersicht können 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:

  • Wählen Sie in der rechten oberen Ecke der Tabelle über die Drop-down-Liste Spalten auswählen die für Sie interessanten Messwerte aus und entfernen Sie die, die nicht angezeigt werden sollen. Auch hier haben die Einträge ein Fragezeichen. Wenn Sie den Zeiger auf dieses Fragezeichen bewegen, wird eine Beschreibung angezeigt.

  • 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, rufen Sie die Seite Loganzeige in der Google Cloud Console auf, um die Protokolle der Anfragen und Antworten für Ihre API anzusehen.

  • 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 Endpoints-Logs direkt in der Loganzeige:

    1. Rufen Sie in der Cloud Console die Seite Stackdriver > Logging auf:

      Zur Seite "Loganzeige"

    2. Wählen Sie Produzierte APISERVICE_NAME aus, wobei SERVICE_NAME der Name des Endpoints-Diensts ist.

Details zur Struktur der Logs in der Loganzeige finden Sie in der Referenz zu Endpoints-Logs.

Weitere Verwendungsmöglichkeiten für Logs:

  • Machen Sie sich mit der Loganzeige vertraut.
  • Exportieren Sie Ihre Logs mit der Loganzeige. 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.
  • Durch erweiterte Logfilter lassen sich die anzuzeigenden Logeinträge einschränken. Sie können beispielsweise angeben, dass alle Anfragen mit einer Latenz von mehr als 300 Millisekunden angezeigt werden sollen.

Nach einem bestimmten Nutzerprojekt filtern

API-Nutzer können die anzuzeigenden Messwerte nach einem bestimmten Nutzerprojekt filtern. Dafür müssen sie mit jeder Anfrage einen API-Schlüssel senden. Cloud Endpoints identifiziert anhand des Schlüssels das Projekt, dem die aufrufende Anwendung zugeordnet ist. Der API-Schlüssel muss daher im Google Cloud-Projekt des API-Nutzers erstellt worden sein. Informationen zum Einschränken des Zugriffs auf Ihre API mit einem API-Schlüssel finden Sie unter API-Zugriff mit API-Schlüsseln einschränken.

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 Cloud Console die Seite Endpoints > Dienste für Ihr Projekt auf.

    Zur Seite "Endpoints-Dienste"

  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 aus dem angegebenen Projekt angezeigt wird.

Benachrichtigungen

Die von Endpoints erfassten Messwerte stehen auch in Cloud Monitoring zur Verfügung. Mit Monitoring können Sie Benachrichtigungen einrichten, die über Latenz, Traffic und Fehler informieren. Die Sättigung ist das einzige goldene Signal, für das Sie keine Benachrichtigung mit Endpoints-Messwerten einrichten können. Welche Messwerte Sie zur Überwachung der Sättigung benötigen, hängt von Ihrer Anwendung ab. In Cloud Monitoring finden Sie eine Liste der verfügbaren Messwerte zur Einrichtung von Benachrichtigungen für die Sättigung.

So richten Sie Benachrichtigungen ein:

  1. Erstellen Sie einen Arbeitsbereich für Ihr Projekt, falls Sie noch keinen haben. Achten Sie darauf, dass die Projekt-ID für die von Endpoints überwachte API dem Konto zugeordnet ist.

  2. Erstellen Sie eine Benachrichtigungsrichtlinie zum Einrichten von Benachrichtigungen für die goldenen Signale. Dafür geben Sie die folgenden Werte ein:

    • Latenz

      1. Geben Sie als Bedingungsart Metric Threshold ein.
      2. Geben Sie als Ressourcentyp Produced API ein.
      3. Geben Sie als Messwert Request latencies ein.
      4. Geben Sie einen Schwellenwert ein. Sie werden benachrichtigt, wenn er erreicht ist. Folgen Sie den übrigen Anleitungen im Benachrichtigungsleitfaden.
    • Traffic

      1. Geben Sie als Bedingungsart Metric Threshold ein.
      2. Geben Sie als Ressourcentyp Produced API ein.
      3. Geben Sie als Messwert Request count ein.
      4. Geben Sie einen Schwellenwert ein. Sie werden benachrichtigt, wenn er erreicht ist. Folgen Sie den übrigen Anleitungen im Benachrichtigungsleitfaden.
    • Fehler

      1. Geben Sie als Bedingungsart Metric Threshold ein.
      2. Geben Sie als Ressourcentyp Produced API ein.
      3. Geben Sie als Messwert Request count ein.
      4. Geben Sie als Antwortcodeklasse 5xx ein.
      5. Geben Sie einen Schwellenwert ein. Sie werden benachrichtigt, wenn er erreicht ist. Folgen Sie den übrigen Anleitungen im Benachrichtigungsleitfaden.

Weitere Informationen