Fehlerdaten mit Error Reporting erfassen

In diesem Dokument werden die von Error Reporting unterstützten Umgebungen aufgeführt und es wird auf sprachspezifische Anleitungen für Anwendungsentwickler verwiesen. Wir empfehlen, die sprachspezifischen Clientbibliotheken zu verwenden oder sich auf automatisch erfasste Logeinträge zu verlassen. Sie können jedoch 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 werden, automatisch an Cloud Logging gesendet.

Error Reporting ist ein globaler Dienst, der auf Cloud Logging basiert und Logeinträge analysieren kann, wenn alle folgenden Bedingungen erfüllt sind:

  • Assured Workloads ist deaktiviert. Weitere Informationen finden Sie unter Übersicht über Assured Workloads.
  • Vom Kunden verwaltete Verschlüsselungsschlüssel (CMEK) sind für alle Log-Buckets deaktiviert, in denen der Logeintrag gespeichert wird. In Error Reporting können keine Logeinträge in Log-Buckets mit aktiviertem CMEK gespeichert werden. Informationen dazu, wie Sie die CMEK-Konfiguration für einen Log-Bucket ermitteln, finden Sie unter Schlüsselaktivierung prüfen.
  • Der Log-Bucket erfüllt eine der folgenden Bedingungen:
    • Der Log-Bucket wird im selben Projekt gespeichert, aus dem die Logeinträge stammen.
    • Die Logeinträge wurden an ein Projekt weitergeleitet und dieses Projekt hat die Logeinträge dann in einem eigenen Log-Bucket gespeichert.

Unterstützung von Virtual Private Cloud

Error Reporting 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 für Ihre von Google verwalteten Dienste 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 mit Clientbibliotheken instrumentieren

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

Fehlerdaten mit einer API schreiben

Sie können Fehlerereignisse für Ihr Google Cloud -Projekt melden, indem Sie die Error Reporting API-Methode report oder die Cloud Logging API-Methode 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 Log 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 für Cloud Logging anfallen. Informationen dazu, wie Sie steuern, welche Logeinträge aufgenommen werden, finden Sie unter Ausschlussfilter.

    Wenn Sie Fehlerereignisse über die 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 Stacktrace oder ein ReportedErrorEvent-Objekt enthält. Weitere Informationen zu den Formatierungsanforderungen finden Sie unter Fehler in Logs formatieren.