Fehlerdaten mit Error Reporting erfassen

In diesem Dokument sind die von Error Reporting unterstützten Umgebungen aufgeführt. Außerdem finden Sie hier Links zu sprachspezifischen Anleitungen für Anwendungsentwickler. Wir empfehlen, die sprachenspezifischen Clientbibliotheken zu verwenden oder sich auf automatisch erfasste Logeinträge zu verlassen. Sie können aber auch Fehlerdaten mit der Cloud Logging API oder der Error Reporting API schreiben. Wenn Sie beispielsweise Cloud Run verwenden, werden Ausnahmen, die in stderr geschrieben wurden, automatisch an Cloud Logging gesendet.

Error Reporting ist ein globaler Dienst, der auf Cloud Logging basiert. Logeinträge können analysiert werden, wenn alle folgenden Bedingungen erfüllt sind:

  • Assured Workloads sind deaktiviert. Weitere Informationen finden Sie unter Assured Workloads-Übersicht.
  • Vom Kunden verwaltete Verschlüsselungsschlüssel (CMEK) sind in allen Protokoll-Buckets deaktiviert, in denen der Protokolleintrag gespeichert wird. Informationen zum Ermitteln der CMEK-Konfiguration für einen Log-Bucket finden Sie unter Aktivierung von Schlüsseln prüfen.
  • Der Log-Bucket erfüllt eine der folgenden Bedingungen:
    • Der Log-Bucket wird im selben Projekt gespeichert, in dem die Logeinträge stammen.
    • Die Logeinträge wurden an ein Projekt weitergeleitet und dann in einem zugehörigen Log-Bucket gespeichert.
Wenn Sie Ihre Protokolleinträge in Protokoll-Buckets mit aktivierter CMEK speichern, können Sie die Fehlerberichte weiterhin verwenden. Sie müssen jedoch die Clientbibliotheken für Error Reporting oder die Error Reporting API verwenden. Weitere Informationen finden Sie unter Error Reporting API – Übersicht und Error Reporting API – Clientbibliotheken.

Virtual Private Cloud-Unterstützung

Die Fehlermeldung ist ein von Virtual Private Cloud (VPC) unterstützter Dienst.

Um das Risiko einer Daten-Exfiltration zu verringern, können Sie mit VPC Service Controls einen Dienstperimeter um Ihre von Google verwalteten Dienste herum erstellen. Informationen zu VPC Service Controls und zum Erstellen eines Dienstparameters finden Sie in der Dokumentation zu VPC Service Controls.

Umgebungen so konfigurieren, dass Fehlerdaten automatisch gemeldet werden

Informationen zu umgebungsspezifischen Konfigurationsanforderungen finden Sie in den folgenden Anleitungen:

Apps mithilfe von Clientbibliotheken analysieren

Informationen zum Konfigurieren Ihrer Anwendung zum Senden von Fehlerberichten finden Sie in den sprachspezifischen Konfigurationsanleitungen:

Fehlerdaten mit einer API schreiben

Sie können Fehlerereignisse in Ihrem Google Cloud-Projekt melden, indem Sie die Methode „Error Reporting API“ report oder die Methode „Cloud Logging API“ write ausführen.

  • Wenn Sie eine API-Schlüssel-Authentifizierung benötigen, müssen Sie die Error Reporting API verwenden. Wenn Sie ein Fehlerereignis mit der Error Reporting API melden möchten, führen Sie die Methode report aus und formatieren Sie den Anfragetext der Methode als ReportedErrorEvent-Objekt.

    Wenn Sie die Error Reporting API verwenden, werden Logeinträge mit korrekt formatierten Fehlermeldungen automatisch generiert und in Cloud Logging geschrieben. Diese Logeinträge werden in ein Protokoll geschrieben, dessen logName so formatiert ist:

    projects/PROJECT_ID/clouderrorreporting.googleapis.com%2Freported_errors

    Da Logeinträge durch Aufrufe von report generiert werden, können Datenaufnahmekosten in Cloud Logging anfallen. Informationen dazu, welche Logeinträge aufgenommen werden, finden Sie unter Ausschlussfilter.

    Wenn Sie Fehlerereignisse mit der Error Reporting API melden, gilt der Rest dieses Dokuments nicht.

  • Wenn Sie die Cloud Logging API verwenden möchten, müssen Sie das LogEntry-Objekt so formatieren, dass es einen Stack-Trace oder ein ReportedErrorEvent-Objekt enthält. Weitere Informationen zu den Formatierungsanforderungen finden Sie unter Formatierungsfehler in Protokollen.