Go-Anwendungen für Error Reporting instrumentieren

Sie können über Go Fehlerberichte an Error Reporting senden mithilfe der Error Reporting-Paket für Go Verwenden Sie das Error Reporting-Paket für Go, um Fehlergruppen für die folgenden Fälle 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 unter In Google Cloud ausführen Seite.

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. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   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

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

4. Error Reporting API aktivieren.

   Aktivieren Sie die API

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

   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

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

7. Error Reporting API aktivieren.

   Aktivieren Sie die API

Clientbibliothek installieren

Mit dem Error Reporting-Paket für Go können Sie die von Go-Anwendungen, die nahezu überall ausgeführt werden können.

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.

Anwendungen in Google Cloud ausführen

Um Fehlergruppen mithilfe der projects.events.report, Ihr Dienstkonto benötigt die Rolle „Error Reporting-Autor“ (roles/errorreporting.writer):

Einige Google Cloud-Dienste gewähren automatisch Rolle „Error Reporting-Autor“ (roles/errorreporting.writer) der entsprechenden Dienstkonto. Sie müssen diese Rolle jedoch dem entsprechenden Dienst für einige Dienste.

Flexible App Engine-Umgebung

App Engine gewährt den Rolle „Error Reporting-Autor“ (roles/errorreporting.writer) automatisch mit Ihrem Standarddienstkonto verknüpft.

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: In stderr geschriebene Fehlerlogs werden von Error Reporting automatisch verarbeitet, ohne dass dafür das Error Reporting-Paket für Go direkt angewendet werden muss.

Google Kubernetes Engine

Um Error Reporting mit Google Kubernetes Engine zu verwenden, Gehen Sie so vor:

1. Prüfen Sie, ob das von Ihrem Container zu verwendende Dienstkonto gewährte Rolle „Error Reporting-Autor“ (roles/errorreporting.writer):

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

   Informationen zum Gewähren von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten

2. Cluster erstellen und dem Cluster die cloud-platform Zugriffsbereich.

   Der folgende Befehl zum Erstellen gibt beispielsweise die cloud-platform an. Zugriffsbereich und ein Dienstkonto:

   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: Gehen Sie so vor:

1. Prüfen Sie, ob das von Ihrer VM-Instanz zu verwendende Dienstkonto gewährte Rolle „Error Reporting-Autor“ (roles/errorreporting.writer):

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

   Informationen zum Gewähren 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 Sie erhalten möchten. cloud-platform Zugriffsbereich.

4. Klicken Sie auf Beenden und dann auf Bearbeiten.

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

6. Gehen Sie im Abschnitt Zugriffsbereiche so vor: Wählen Sie Uneingeschränkten Zugriff auf alle Cloud APIs zulassen aus und speichern Sie Ihre Änderungen.

7. Klicken Sie auf Starten/Fortsetzen.

Beispiel

Im folgenden Beispiel wird die Verwendung der Go-Clientbibliothek veranschaulicht 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.

Anwendungen in einer lokalen Entwicklungsumgebung ausführen

So verwenden Sie das Error Reporting-Paket für Go in einer lokalen Entwicklungsumgebung: wie das Ausführen der Bibliothek auf Ihrer eigenen Workstation, müssen Sie das Error Reporting-Paket für Go mit den Standardanmeldedaten für lokale Anwendungen. 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. 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 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 Datei mit den Standardanmeldedaten für Anwendungen einrichten. Weitere Informationen unter Erstellen eines API-Schlüssels in der Dokumentation zur Google Cloud-Authentifizierung.

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.