Fehlerdaten mit Error Reporting erfassen

In diesem Dokument werden die von Error Reporting unterstützten Umgebungen aufgeführt. Außerdem enthält es Links zu sprachspezifischen Leitfäden für Anwendungsentwickler. Wir empfehlen, die sprachspezifischen Clientbibliotheken oder automatisch erfasste Logs zu verwenden. Sie können jedoch Fehlerdaten mit der Cloud Logging API oder Error Reporting API schreiben. Wenn Sie beispielsweise Cloud Run verwenden, werden in stderr geschriebene Ausnahmen automatisch an Cloud Logging gesendet.

Error Reporting ist ein globaler Dienst, der die Logs in Ihrem Google Cloud-Projekt automatisch analysiert, um Fehler zu identifizieren. Error Reporting kann jedoch nur Logeinträge analysieren, die in Cloud Logging-Buckets gespeichert sind, die sich in der Region global befinden, in denen die Quell- und Zielprojekte von Google Cloud identisch sind und in denen vom Kunden verwaltete Verschlüsselungsschlüssel (Customer-Managed Encryption Keys, CMEK) deaktiviert sind. Wenn Sie Logs an ein anderes Google Cloud-Projekt oder an regionalisierte Buckets weiterleiten oder CMEK aktivieren, werden diese Logs von Error Reporting nicht erfasst und analysiert. Informationen zum Prüfen der Konfiguration Ihrer Log-Buckets finden Sie unter Fehlerbehebung.

Virtual Private Cloud-Unterstützung

Error Reporting ist ein von Virtual Private Cloud (VPC) unterstützter Dienst.

Verwenden Sie VPC Service Controls, um einen Dienstperimeter um Ihre von Google verwalteten Dienste zu erstellen, um das Risiko der Daten-Exfiltration zu verringern. 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:

• Flexible App Engine-Umgebung
• App Engine-Standardumgebung
• Apps Script
• Cloud Functions
• Cloud Run
• Compute Engine
• Google Kubernetes Engine
• Amazon EC2

Apps mithilfe von Clientbibliotheken instrumentieren

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

• Go-Apps
• Java-Apps
• .NET-Apps
• Node.js-Anwendungen
• Python-Anwendungen
• PHP-Anwendungen
• Ruby-Apps

Fehlerdaten mit einer API schreiben

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

• Wenn eine Authentifizierung auf API-Schlüsselbasis erforderlich ist, müssen Sie die Error Reporting API verwenden. Wenn Sie ein Fehlerereignis mithilfe 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 Kosten für die Cloud Logging-Aufnahme anfallen. Unter Ausschlussfilter können Sie festlegen, welche Logs aufgenommen werden.

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

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