Overview

Die Error Reporting API bietet:

  • Ein einfacher Endpunkt zum Melden von Fehlern aus Ihrem laufenden Dienst.
  • Lesezugriff auf Fehlergruppen und die zugehörigen Fehler.

Erste Schritte

Aktivieren Sie die Error Reporting API.

Rollen, die zum Aktivieren von APIs erforderlich sind

Zum Aktivieren von APIs benötigen Sie die IAM-Rolle „Service Usage-Administrator“ (roles/serviceusage.serviceUsageAdmin), die die Berechtigung serviceusage.services.enable enthält. Weitere Informationen zum Zuweisen von Rollen

API aktivieren

Verwendung der API autorisieren

Der Zugriff auf die Error Reporting API wird durch IAM-Rollen und ‑Berechtigungen (Identity and Access Management) gesteuert. Weitere Informationen zur Authentifizierung und Autorisierung für Google Cloud APIs finden Sie im Authentifizierungsleitfaden.

Datenmodell

Die Error Reporting API definiert drei Entitäten: Fehlerereignisse, Fehlergruppen und Statistiken zu Fehlergruppen. Das Objekt error group stats ist das Objekt, mit dem die meisten Nutzer am häufigsten interagieren.

Fehlerereignisse

Ein ErrorEvent stellt ein einzelnes Auftreten eines Fehlers in Ihrer Anwendung dar. Das Objekt enthält Informationen zum Fehler, z. B. den Zeitpunkt, zu dem er aufgetreten ist, den Kontext, in dem er aufgetreten ist, und die zurückgegebene Fehlermeldung. Ein Fehlerereignis ist garantiert mindestens 30 Tage nach der Generierung verfügbar.

Fehlergruppen

ErrorGroup-Objekte sind logisch gruppierte Sammlungen von Fehlerereignissen. Die Gruppierung basiert auf Informationen im Stacktrace des Fehlerereignisses. Eine Fehlergruppe ist ein einfaches Objekt, das nur den Namen, die Gruppen-ID und alle zugehörigen Tracking-Probleme für die Gruppe enthält.

Verwenden Sie die Methode update dieser Ressource, um die URLs für Tracking-Probleme zu aktualisieren.

Statistiken zu Fehlergruppen

ErrorGroupStats-Objekte enthalten detaillierte Informationen zu einer Fehlergruppe und sind die API-Objekte, mit denen Sie am häufigsten interagieren. Das groupStats-Objekt enthält unter anderem Informationen dazu, wann ein Fehlerereignis in dieser Gruppe zum ersten und letzten Mal aufgetreten ist, die Anzahl der Fehlerereignisse und die Anzahl der betroffenen Nutzer. Dieses Objekt ist nützlich, wenn Sie Widgets und benutzerdefinierte Dashboards erstellen.

Vorgänge

Die Error Reporting API unterstützt die folgenden Vorgänge:

  • Neues Fehlerereignis melden
  • Statistiken zu Fehlergruppen auflisten
  • Fehlerereignisse auflisten
  • Fehlergruppen abrufen
  • Tracking-Probleme einer Fehlergruppe aktualisieren

Fehlerereignisse melden

Sie können Fehlerereignisse aus Ihren laufenden Diensten melden, indem Sie sie in ReportedErrorEvent schreiben. Dadurch werden korrekt formatierte Fehlermeldungen in Cloud Logging generiert. Der resultierende Logname wird als projects/<PROJECT_ID>/clouderrorreporting.googleapis.com%2Freported_errors formatiert. Durch Verwendung dieser Methode können geringe Datenaufnahmekosten in Cloud Logging entstehen. Hinweise zur Kontrolle dieser Kosten finden Sie unter Log-Ausschlüsse.

Sie können auch neue Fehlerereignisse an Error Reporting melden, indem Sie Fehlerereignis-Entitäten aus Ihrem laufenden Dienst zusammenstellen und an die Methode events.report senden.

Statistiken zu Fehlergruppen auflisten

Wenn Sie eine Liste mit Statistiken zu Fehlergruppen abrufen möchten, senden Sie eine Anfrage an die Methode groupStats.list. Sie können einen oder mehrere Abfrageparameter übergeben, um die zurückgegebenen Gruppenstatistiken zu filtern.

Fehlerereignisse auflisten

Wenn Sie eine Liste der Fehlerereignisse abrufen möchten, die zu einer bestimmten Fehlergruppe gehören, senden Sie eine Anfrage an die Methode events.list. Sie können eine Filterbedingung an diese Anfragen übergeben, um nur die Fehlerereignisse abzurufen, die zwischen einer bestimmten Start- und Endzeit aufgetreten sind oder die bestimmten Dienstkontexten entsprechen.

Fehlergruppen abrufen

Wenn Sie eine bestimmte Fehlergruppenressource abrufen möchten, senden Sie eine Anfrage an die Methode groups.get.

Fehlergruppen aktualisieren

Wenn Sie die mit einer Fehlergruppe verknüpften Tracking-Problem-URLs aktualisieren möchten, senden Sie eine aktualisierte ErrorGroup-Ressource an die Methode groups.update.