Instrumenter des applications Go pour Error Reporting

Vous pouvez envoyer des rapports d'erreurs à Error Reporting depuis des applications Go à l'aide du package Error Reporting pour Go.

Error Reporting est intégré à certains services Google Cloud, tels que App Engine, Compute Engine et Google Kubernetes Engine. Error Reporting vous permet d'afficher les erreurs qui sont consignées dans Cloud Logging par les applications exécutées sur ces services. Pour en savoir plus, consultez la section Exécuter sur Google Cloud Platform de cette page.

Vous pouvez également envoyer des données d'erreur à Error Reporting à l'aide de Logging. Pour en savoir plus sur les exigences en matière de mise en forme des données, consultez la page Formater les messages d'erreur dans Logging.

Avant de commencer

  1. Connectez-vous à votre compte Google Cloud. Si vous débutez sur Google Cloud, créez un compte pour évaluer les performances de nos produits en conditions réelles. Les nouveaux clients bénéficient également de 300 $ de crédits gratuits pour exécuter, tester et déployer des charges de travail.

  2. Dans Google Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Google Cloud.

    Accéder au sélecteur de projet

  3. Vérifiez que la facturation est activée pour votre projet Google Cloud.

  4. Activez Error Reporting API .

    Activer l'API

    5.

  5. Dans Google Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Google Cloud.

    Accéder au sélecteur de projet

  6. Vérifiez que la facturation est activée pour votre projet Google Cloud.

  7. Activez Error Reporting API .

    Activer l'API

    8.

Installer la bibliothèque cliente

Le package Error Reporting pour Go vous permet de surveiller et d'afficher les erreurs signalées par les applications Go exécutées sur n'importe quel emplacement ou presque.

  1. Installez le package à l'aide de go get :

    go get cloud.google.com/go/errorreporting

Pour en savoir plus sur l'installation, consultez la documentation sur le package Error Reporting pour Go. Vous pouvez également signaler d'éventuels problèmes à l'aide de l'outil de suivi des problèmes.

Configurer la bibliothèque cliente

Vous pouvez personnaliser le comportement du package Error Reporting pour Go. Consultez godoc.

Signaler des erreurs


// 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)
}

Consultez godoc pour découvrir, à l'aide d'exemples, comment signaler des problèmes et des erreurs.

Exécuter des applications sur Google Cloud

L'utilisation du package Error Reporting pour Go nécessite de disposer du rôle Cloud Identity and Access Management de rédacteur pour Error Reporting. La plupart des plates-formes de calcul Google Cloud attribuent ce rôle par défaut.

Vous pouvez configurer Error Reporting pour Go sur les environnements Google Cloud suivants.

Environnement flexible App Engine

App Engine attribue par défaut le rôle de rédacteur pour Error Reporting.

Le package Error Reporting pour Go peut être utilisé sans avoir à fournir explicitement des identifiants.

Error Reporting est automatiquement activé pour les applications de l'environnement flexible App Engine. Aucune configuration supplémentaire n'est requise.

Google Kubernetes Engine

Sur GKE, vous devez ajouter le niveau d'accès cloud-platform lors de la création du cluster, comme indiqué dans l'exemple de commande ci-dessous :

gcloud container clusters create example-cluster-name --scopes https://www.googleapis.com/auth/cloud-platform

Compute Engine

Lorsque vous utilisez des instances de VM Compute Engine, ajoutez le niveau d'accès cloud-platform à chaque instance. Lorsque vous créez une instance via la console Google Cloud, vous pouvez le faire dans la section Identité et accès à l'API du panneau Créer une instance. Utilisez le compte de service par défaut de Compute Engine ou un autre compte de service de votre choix, puis sélectionnez Autoriser l'accès complet à l'ensemble des API Cloud dans la section Identité et accès à l'API. Quel que soit le compte de service sélectionné, assurez-vous qu'il dispose du rôle Rédacteur Error Reporting dans la section IAM et administration de la console Google Cloud.

Exécuter en local et depuis un autre emplacement

Pour utiliser le package Error Reporting pour Go en dehors de Google Cloud, y compris en l'exécutant sur votre propre poste de travail, sur les ordinateurs de votre centre de données ou sur les instances de VM d'un autre fournisseur cloud, vous devez saisir l'ID de projet Google Cloud ainsi que les identifiants du compte de service approprié directement dans le package Error Reporting pour Go.

Vous pouvez créer et obtenir manuellement des identifiants pour le compte de service. Lorsque vous spécifiez le champ Rôle, utilisez le rôle Rédacteur Error Reporting. Pour en savoir plus sur les rôles Cloud IAM (Cloud Identity and Access Management), consultez le Guide du contrôle des accès.

Afficher les rapports d'erreurs

Dans la console Google Cloud, sélectionnez Error Reporting ou cliquez sur le bouton suivant, puis sélectionnez un projet:

Accéder à Error Reporting

Pour en savoir plus, consultez la page Afficher les erreurs.