Go-Anwendungen für Error Reporting instrumentieren

Mit dem Error Reporting-Paket für Go können Sie Fehlerereignisse direkt aus Ihren Go-Anwendungen an Error Reporting senden, um Laufzeitabstürze zu diagnostizieren und zu überwachen. Wenn Sie Ihre Anwendung mit der Bibliothek instrumentieren, können Sie benutzerdefinierte Fehlerereignisse melden und Fehler erfassen, auch wenn für Ihre Log-Buckets vom Kunden verwaltete Verschlüsselungsschlüssel (Customer-Managed Encryption Keys, CMEK) verwendet werden.

Bei Anwendungen, die in integrierten Google Cloud Diensten ausgeführt werden, einschließlich Cloud Run-Funktionen, App Engine, Compute Engine und Google Kubernetes Engine, kann Error Reporting Fehlerereignisse auch automatisch aus Cloud Logging ableiten, ohne dass das Error Reporting-Paket für Go erforderlich ist. Damit Error Reporting Fehlerereignisse aus Logs ableiten kann, müssen Ihre Logeinträge den Anforderungen an die Fehlerformatierung entsprechen und in einem Log-Bucket ohne CMEK gespeichert werden, das dem Ursprungsprojekt oder dem Zielprojekt gehört, an das die Logs weitergeleitet wurden.

Hinweis

Melden Sie sich in Ihrem Google Cloud -Konto an. Wenn Sie mit Google Cloudnoch 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.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Error Reporting API , if it is not already enabled.

Roles required to enable APIs

To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

Enable the API

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Error Reporting API , if it is not already enabled.

Roles required to enable APIs

To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

Enable the API

Clientbibliothek installieren

Mit dem Error Reporting-Paket für Go können Sie Fehlerereignisse, die von Go-Anwendungen gemeldet werden, die fast überall ausgeführt werden, überwachen und ansehen.

1. Verwenden Sie go get, um das Paket zu installieren:

   go get cloud.google.com/go/errorreporting

Weitere Informationen zur Installation finden Sie in der Dokumentation des Error Reporting-Pakets für Go. Probleme können Sie über die Problemverfolgung melden.

Clientbibliothek konfigurieren

Das Verhalten des Error Reporting-Pakets für Go kann angepasst werden. Weitere Informationen finden Sie in GoDoc.

Apps auf Google Cloudausführen

Wenn Sie Fehlergruppen mit projects.events.report erstellen möchten, benötigt Ihr Dienstkonto die Rolle „Error Reporting Writer“ (roles/errorreporting.writer).

Einige Google Cloud -Dienste weisen dem entsprechenden Dienstkonto automatisch die Rolle „Error Reporting Writer“ (roles/errorreporting.writer) zu. Für einige Dienste müssen Sie diese Rolle jedoch dem entsprechenden Dienstkonto zuweisen.

Cloud Run und Cloud Run Functions

Das von Cloud Run verwendete Standarddienstkonto hat die Berechtigungen der Rolle „Error Reporting Writer“ (roles/errorreporting.writer).

Das Error Reporting-Paket für Go kann verwendet werden, ohne dass Anmeldeinformationen explizit angegeben werden müssen.

Cloud Run ist so konfiguriert, dass Error Reporting automatisch verwendet wird. Nicht abgefangene JavaScript-Ausnahmen werden im Logging angezeigt und von Error Reporting verarbeitet, ohne dass das Error Reporting-Paket für Go verwendet werden muss.

Hinweis :Error Reporting erstellt automatisch ein Fehlerereignis, wenn ein Logeintrag einen Stacktrace enthält und der Schweregrad des Logeintrags nicht festgelegt oder auf mindestens ERROR gesetzt ist.

Flexible App Engine-Umgebung

App Engine weist Ihrem Standarddienstkonto automatisch die Rolle „Error Reporting-Autor“ (roles/errorreporting.writer) zu.

Das Error Reporting-Paket für Go kann verwendet werden, ohne dass Anmeldeinformationen 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.

Hinweis: Fehlerlog-Einträge, die in stderr geschrieben werden, werden automatisch von Error Reporting verarbeitet, ohne dass das Error Reporting-Paket für Go direkt verwendet werden muss.

Google Kubernetes Engine

So verwenden Sie Error Reporting mit Google Kubernetes Engine:

1. Achten Sie darauf, dass dem Dienstkonto, das von Ihrem Container verwendet werden soll, die Rolle „Error Reporting Writer“ (roles/errorreporting.writer) zugewiesen 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 Ihren Cluster und gewähren Sie ihm den cloud-platform-Zugriffsbereich.

   Im folgenden Beispiel wird mit dem Befehl „create“ 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 das zugehörige 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 Writer“ (roles/errorreporting.writer) zugewiesen 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. Rufen Sie in der Google Cloud Console die Seite VM-Instanzen auf:

   Zu Seite VM-Instanzen

   Wenn Sie diese Seite über die Suchleiste finden, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Compute Engine lautet.

3. Wählen Sie die VM-Instanz aus, die den cloud-platform-Zugriffsbereich 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 Writer“ (roles/errorreporting.writer) aus.

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

7. Klicken Sie auf Starten/Fortsetzen.

Beispiel

Im folgenden Beispiel wird gezeigt, wie Sie mit der Go-Clientbibliothek ein benutzerdefiniertes Fehlerereignis melden:

// Sample errorreporting_quickstart contains is a quickstart
// example for the Google Cloud Error Reporting API.
package main

import (
	"context"
	"errors"
	"log"
	"os"

	"cloud.google.com/go/errorreporting"
)

var errorClient *errorreporting.Client

func main() {
	// Set your Google Cloud Platform project ID via environment or explicitly
	projectID := os.Getenv("GOOGLE_CLOUD_PROJECT")
	args := os.Args[1:]
	if len(args) > 0 && args[0] != "" {
		projectID = args[0]
	}

	ctx := context.Background()
	var err error
	errorClient, err = errorreporting.NewClient(ctx, projectID, errorreporting.Config{
		ServiceName:    "errorreporting_quickstart",
		ServiceVersion: "0.0.0",
		OnError: func(err error) {
			log.Printf("Could not report the error: %v", err)
		},
	})
	if err != nil {
		log.Fatal(err)
	}
	defer errorClient.Close()

	err = errors.New("something went wrong")
	if err != nil {
		logAndPrintError(err)
		return
	}
}

func logAndPrintError(err error) {
	/// Client autopopulates the error context of the error. For more details about the context see:
	/// https://cloud.google.com/error-reporting/reference/rest/v1beta1/ErrorContext
	errorClient.Report(errorreporting.Entry{
		Error: err,
	})
	log.Print(err)
}

Bei GoDoc finden Sie weitere Beispiele zum Melden von Ausnahmen und Fehlern.

Apps in einer lokalen Entwicklungsumgebung ausführen

Wenn Sie das Error Reporting-Paket für Go in einer lokalen Entwicklungsumgebung verwenden möchten, z. B. wenn Sie die Bibliothek auf Ihrer eigenen Workstation ausführen, müssen Sie dem Error Reporting-Paket für Go die lokalen Standardanmeldedaten für Anwendungen zur Verfügung stellen. Weitere Informationen finden Sie unter Authentifizierung für Error Reporting.

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

1. Installieren Sie die Google Cloud CLI.

2. Wenn Sie einen externen Identitätsanbieter (IdP) verwenden, müssen Sie sich zuerst mit Ihrer föderierten Identität in der gcloud CLI anmelden.

3. Wenn Sie eine lokale Shell verwenden, erstellen Sie lokale Anmeldedaten zur Authentifizierung für Ihr Nutzerkonto:

   gcloud auth application-default login

   Wenn Sie Cloud Shell verwenden, müssen Sie das nicht tun.

   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

   Wenn ein Authentifizierungsfehler zurückgegeben wird und Sie einen externen Identitätsanbieter (IdP) verwenden, prüfen Sie, ob Sie sich mit Ihrer föderierten Identität in der gcloud CLI angemeldet haben.

Weitere Informationen finden Sie unter 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 ADC-Datei (Standardanmeldedaten für Anwendungen) einrichten. Weitere Informationen finden Sie in der Dokumentation zur Google Cloud -Authentifizierung unter API-Schlüssel erstellen.

Fehlergruppen ansehen

Rufen Sie in der Google Cloud Console die Seite Error Reporting auf:

Error Reporting aufrufen

Sie können diese Seite auch über die Suchleiste finden.

Weitere Informationen finden Sie unter Fehlergruppen ansehen und filtern.