Go-Anwendungen für Error Reporting instrumentieren

Mithilfe des Error Reporting-Pakets für Go können Sie Fehlerberichte von Go-Anwendungen an Error Reporting senden. Mit dem Error Reporting-Paket für Go können Sie Fehlergruppen für die folgenden Fälle erstellen:

• Ein Log-Bucket, das Ihre Logeinträge enthält, hat vom Kunden verwaltete Verschlüsselungsschlüssel (CMEK).
• 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.
• Sie möchten benutzerdefinierte Fehlerereignisse melden.

Error Reporting ist in einige Google Cloud -Dienste wie Cloud Functions, 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 im Abschnitt Auf Google Cloudausfü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

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

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

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

Enable the Error Reporting API .

Enable the API

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

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

Enable the Error Reporting API .

Enable the API

Clientbibliothek installieren

Mit dem Error Reporting-Paket für Go können Sie die von Go-Anwendungen gemeldeten Fehler im Blick behalten und abrufen. Dabei ist es in den meisten Fällen unerheblich, wo die Anwendungen ausgeführt werden.

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-Autor (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-Funktionen

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

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

Cloud Run ist automatisch für die Verwendung von Error Reporting konfiguriert. Unverarbeitete JavaScript-Ausnahmen werden in Logging angezeigt und von Error Reporting verarbeitet, ohne dass dafür das Error Reporting-Paket für Go angewendet werden muss.

Flexible App Engine-Umgebung

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

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.

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-Autor (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
   

Compute Engine

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

1. Achten Sie darauf, dass dem Dienstkonto, das von Ihrer VM-Instanz verwendet werden soll, die Rolle Error Reporting-Autor (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, für die Sie den cloud-platform-Zugriffsbereich festlegen möchten.

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 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 sehen Sie, wie ein benutzerdefiniertes Fehlerereignis mit der Go-Clientbibliothek gemeldet wird:

// 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 Ihrem eigenen Arbeitsplatz 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 Bei Error Reporting authentifizieren.

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

1. Install the Google Cloud CLI.

2. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

3. To initialize the gcloud CLI, run the following command:

   gcloud init

4. If you're using a local shell, then create local authentication credentials for your user account:

   gcloud auth application-default login

   You don't need to do this if you're using Cloud Shell.

   If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.

Weitere Informationen unter Set up authentication for a local development environment.

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 unter Erstellen eines API-Schlüssels in der Google Cloud Authentifizierungsdokumentation.

Fehlerberichte 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 Fehler anzeigen.