C#-Anwendungen für Error Reporting instrumentieren

Mithilfe des Bibliothekensatzes Google.Cloud.diagnostic können Sie Fehlerberichte von C#-Anwendungen an Error Reporting senden. Verwenden Sie den Bibliothekensatz von Google.Cloud.diagnostic, um in den folgenden Fällen Fehlergruppen zu erstellen:

• Ihr Log-Bucket hat vom Kunden verwaltete Verschlüsselungsschlüssel (CMEK).
• Ihre Log-Buckets befinden sich nicht in der Region global.
• Sie möchten benutzerdefinierte Fehlerereignisse melden.

Error Reporting ist in einige Google Cloud-Dienste wie App Engine, Compute Engine und Google Kubernetes Engine eingebunden. In Error Reporting sehen Sie die in Cloud Logging protokollierten Fehler der auf diesen Diensten ausgeführten Anwendungen. Weitere Informationen finden Sie auf dieser Seite unter In Google Cloud ausführen.

Sie können Fehlerdaten auch mithilfe von Logging an Error Reporting senden. Informationen zu den Datenformatierungsanforderungen finden Sie unter Fehlermeldungen in Logging formatieren.

Hinweise

1. Melden Sie sich bei Ihrem Google Cloud-Konto an. Wenn Sie mit Google Cloud noch nicht vertraut sind, erstellen Sie ein Konto, um die Leistungsfähigkeit unserer Produkte in der Praxis sehen und bewerten zu können. Neukunden erhalten außerdem ein Guthaben von 300 $, um Arbeitslasten auszuführen, zu testen und bereitzustellen.

2. Wählen Sie in der Google Cloud Console auf der Seite der Projektauswahl ein Google Cloud-Projekt aus oder erstellen Sie eines.

   Hinweis: Wenn Sie die Ressourcen, die Sie in diesem Verfahren erstellen, nicht behalten möchten, erstellen Sie ein Projekt, anstatt ein vorhandenes Projekt auszuwählen. Wenn Sie fertig sind, können Sie das Projekt löschen und dadurch alle mit dem Projekt verknüpften Ressourcen entfernen.

   Zur Projektauswahl

3. Die Abrechnung für das Google Cloud-Projekt muss aktiviert sein.

4. Error Reporting API aktivieren.

   Aktivieren Sie die API

5. Wählen Sie in der Google Cloud Console auf der Seite der Projektauswahl ein Google Cloud-Projekt aus oder erstellen Sie eines.

   Hinweis: Wenn Sie die Ressourcen, die Sie in diesem Verfahren erstellen, nicht behalten möchten, erstellen Sie ein Projekt, anstatt ein vorhandenes Projekt auszuwählen. Wenn Sie fertig sind, können Sie das Projekt löschen und dadurch alle mit dem Projekt verknüpften Ressourcen entfernen.

   Zur Projektauswahl

6. Die Abrechnung für das Google Cloud-Projekt muss aktiviert sein.

7. Error Reporting API aktivieren.

   Aktivieren Sie die API

Clientbibliothek installieren

Mit den Bibliotheken von Google.Cloud.diagnostic können Sie die von C#-Anwendungen gemeldeten Fehler im Blick behalten und aufrufen. Dabei ist es in den meisten Fällen unerheblich, wo die Anwendungen ausgeführt werden.

1. Verwenden Sie für Anwendungen, die auf ASP.NET Core 3 oder höher ausgerichtet sind, die Bibliothek Google.Cloud.Diagnostics.AspNetCore3. Sie können diese Bibliothek über NuGet installieren.
2. Verwenden Sie für Anwendungen, die auf ältere Versionen von ASP.NET Core abzielen, die Google.Cloud.Diagnostics.AspNetCore-Bibliothek. Sie können diese Bibliothek über NuGet installieren.
3. Verwenden Sie für Anwendungen, die nicht auf ASP.NET Core-Frameworks abzielen, die Google.Cloud.Diagnostics.Common-Bibliothek. Sie können diese Bibliothek über NuGet installieren.

Weitere Informationen zur Installation finden Sie in der Dokumentation zur Google.Cloud.Diagnostics-Reihe von Bibliotheken. Probleme können Sie über die Problemverfolgung melden.

Clientbibliothek konfigurieren

Weitere Informationen und Beispiele finden Sie in den folgenden Ressourcen:

Dokumentation zu Google.Cloud.Diagnostics.AspNetCore3

Dokumentation zu Google.Cloud.Diagnostics.AspNetCore

Dokumentation zu Google.Cloud.Diagnostics.Common

Anwendungen in Google Cloud ausführen

Zum Erstellen von Fehlergruppen mit projects.events.report benötigt Ihr Dienstkonto die Rolle Error Reporting-Autor (roles/errorreporting.writer).

Einige Google Cloud-Dienste weisen dem entsprechenden Dienstkonto automatisch die Rolle „Error Reporting-Autor“ (roles/errorreporting.writer) zu. Bei einigen Diensten müssen Sie diese Rolle jedoch dem entsprechenden Dienstkonto zuweisen.

Flexible App Engine-Umgebung

In der App Engine wird Ihrem Standarddienstkonto automatisch die Rolle „Error Reporting-Autor“ (roles/errorreporting.writer) zugewiesen.

Die Google.Cloud.Diagnostics-Bibliotheken-Gruppe können verwendet werden, ohne dass Anmeldedaten explizit angegeben werden müssen.

Error Reporting wird für Anwendungen in flexiblen App Engine-Umgebungen automatisch aktiviert. Es ist keine zusätzliche Einrichtung erforderlich. Von App Engine in stderr geschriebene Nachrichten werden analysiert und von Error Reporting angezeigt, falls sie einen Stacktrace enthalten.

Eine Anleitung zum Aufrufen von Fehler- und Ausnahmedaten für Ihre Anwendung in der Google Cloud Console finden Sie unter Fehler anzeigen.

Google Kubernetes Engine

So verwenden Sie Error Reporting mit Google Kubernetes Engine:

1. Prüfen Sie, ob dem Dienstkonto, das von Ihrem Container verwendet werden soll, die Rolle „Error Reporting-Autor“ (roles/errorreporting.writer) gewährt wurde.

   Sie können entweder das Compute Engine-Standarddienstkonto oder ein benutzerdefiniertes Dienstkonto verwenden.

   Informationen zum Zuweisen von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.

2. Erstellen Sie den Cluster und gewähren Sie ihm den Zugriffsbereich cloud-platform.

   Mit dem folgenden Befehl zum Erstellen werden beispielsweise der Zugriffsbereich cloud-platform und ein Dienstkonto angegeben:

   gcloud container clusters create CLUSTER_NAME --service-account  SERVICE_ACCT_NAME --scopes=cloud-platform
   

Hinweis: Nachdem Sie einen Cluster erstellt haben, können Sie sein Dienstkonto nicht mehr ändern.

Compute Engine

So verwenden Sie Error Reporting mit Compute Engine-VM-Instanzen:

1. Prüfen Sie, ob dem Dienstkonto, das von Ihrer VM-Instanz verwendet werden soll, die Rolle „Error Reporting-Autor“ (roles/errorreporting.writer) gewährt wurde.

   Sie können entweder das Compute Engine-Standarddienstkonto oder ein benutzerdefiniertes Dienstkonto verwenden.

   Informationen zum Zuweisen von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.

2. Wählen Sie im Navigationsbereich der Google Cloud Console Compute Engine und dann VM-Instanzen aus:

   Zu Seite VM-Instanzen

3. Wählen Sie die VM-Instanz aus, die den Zugriffsbereich cloud-platform erhalten soll.

4. Klicken Sie auf Beenden und dann auf Bearbeiten.

5. Wählen Sie im Abschnitt Identität und API-Zugriff ein Dienstkonto mit der Rolle „Error Reporting-Autor“ (roles/errorreporting.writer) aus.

6. Wählen Sie im Abschnitt Zugriffsbereiche die Option Uneingeschränkten Zugriff auf alle Cloud APIs zulassen aus und speichern Sie dann die Änderungen.

7. Klicken Sie auf Starten/Fortsetzen.

Beispiel

Weitere Informationen und Beispiele finden Sie in den folgenden Ressourcen:

Dokumentation zu Google.Cloud.Diagnostics.AspNetCore3

Dokumentation zu Google.Cloud.Diagnostics.AspNetCore

Dokumentation zu Google.Cloud.Diagnostics.Common

Anwendungen in einer lokalen Entwicklungsumgebung ausführen

Wenn Sie den Bibliothekensatz Google.Cloud.Diagnose in einer lokalen Entwicklungsumgebung verwenden möchten, z. B. zum Ausführen der Bibliothek auf Ihrer eigenen Workstation, müssen Sie dem Bibliothekensatz von Google.Cloud.Diagnose die Standardanmeldedaten der lokalen Anwendung zur Verfügung stellen. Weitere Informationen finden Sie unter Bei Error Reporting authentifizieren.

Wenn Sie die .NET-Beispiele auf dieser Seite aus einer lokalen Entwicklungsumgebung heraus verwenden möchten, installieren und initialisieren Sie die gcloud CLI und richten dann die Standardanmeldedaten für Anwendungen mit Ihren Nutzeranmeldedaten ein.

1. Installieren Sie die Google Cloud CLI.

2. Führen Sie folgenden Befehl aus, um die gcloud CLI zu initialisieren:

   gcloud init

3. Erstellen Sie lokale Anmeldedaten zur Authentifizierung für Ihr Google-Konto:

   gcloud auth application-default login

   Hinweis: Wenn die gcloud CLI eine Warnung ausgibt, dass Ihr Konto nicht die Berechtigung serviceusage.services.use hat, funktionieren einige gcloud CLI-Befehle und Clientbibliotheken möglicherweise nicht. Bitten Sie einen Administrator, Ihnen die IAM-Rolle "Service Usage-Nutzer" (roles/serviceusage.serviceUsageConsumer) zuzuweisen, und führen Sie dann den folgenden Befehl aus:

   gcloud auth application-default set-quota-project PROJECT_ID

Weitere Informationen: Authentifizierung für eine lokale Entwicklungsumgebung einrichten.

Die projects.events.report-Methode unterstützt auch API-Schlüssel. Wenn Sie API-Schlüssel für die Authentifizierung verwenden möchten, müssen Sie keine lokale Datei mit den Standardanmeldedaten für Anwendungen einrichten. Weitere Informationen: Erstellen eines API-Schlüssels in der Dokumentation zur Google Cloud-Authentifizierung.

Fehlerberichte ansehen

Wählen Sie im Navigationsbereich der Google Cloud Console Error Reporting und dann Ihr Google Cloud-Projekt aus:

Gehen Sie zu Error Reporting.

Weitere Informationen finden Sie unter Fehler anzeigen.