Instrumenter des applications C# pour Error Reporting

Vous pouvez envoyer des rapports d'erreurs à Error Reporting depuis C# des applications à l'aide du Ensemble de bibliothèques Google.Cloud.Diagnostics Utilisez l'ensemble de bibliothèques Google.Cloud.Diagnostics pour créer des groupes d'erreurs dans les cas suivants :

• Un bucket de journaux contenant vos entrées de journal contient des clés de chiffrement gérées par le client (CMEK).
• Le bucket de journaux remplit l'une des conditions suivantes :
  • Le bucket de journaux est stocké dans le même projet que les entrées de journal.
  • Les entrées de journal ont été acheminées vers un projet, qui a été stocké dans un bucket de journaux qui lui appartient.
• Vous souhaitez signaler des événements d'erreur personnalisés.

Error Reporting est intégré à certains services Google Cloud, tels que Cloud Functions, 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 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. 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.

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. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Error Reporting API .

   Enable the 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. Make sure that billing is enabled for your Google Cloud project.

7. Enable the Error Reporting API .

   Enable the API

Installer la bibliothèque cliente

La Ensemble de bibliothèques Google.Cloud.Diagnostics vous permet de surveiller et d'afficher les erreurs signalées par Applications C# exécutées depuis presque n'importe quel environnement

1. Pour les applications qui ciblent ASP.NET Core 3 ou une version ultérieure, utilisez la bibliothèque Google.Cloud.Diagnostics.AspNetCore3. Vous pouvez installer cette bibliothèque à partir de NuGet.
2. Pour les applications qui ciblent des versions antérieures d'ASP.NET Core, utilisez la Google.Cloud.Diagnostics.AspNetCore bibliothèque. Vous pouvez installer cette bibliothèque à partir de NuGet.
3. Pour les applications qui ciblent des frameworks autres que ASP.NET Core, utilisez la bibliothèque Google.Cloud.Diagnostics.Common. Vous pouvez installer cette bibliothèque à partir de NuGet.

Pour en savoir plus sur l'installation, consultez la documentation de l'ensemble de bibliothèques Google.Cloud.Diagnostics. Vous pouvez également signaler d'éventuels problèmes à l'aide de l'outil de suivi des problèmes.

Configurer la bibliothèque cliente

Pour obtenir plus d'informations et des exemples, consultez les ressources suivantes :

Google.Cloud.Diagnostics.AspNetCore3 documentation

Documentation Google.Cloud.Diagnostics.AspNetCore

Google.Cloud.Diagnostics.Common documentation

Exécuter des applications sur Google Cloud

Pour créer des groupes d'erreurs à l'aide de projects.events.report, votre compte de service doit disposer du rôle Rédacteur Error Reporting (roles/errorreporting.writer).

Certains services Google Cloud attribuent automatiquement le rôle "Rédacteur de rapports d'erreurs" (roles/errorreporting.writer) au compte de service approprié. Toutefois, vous devez attribuer ce rôle au service approprié pour certains services.

Environnement flexible App Engine

App Engine attribue automatiquement le rôle de rédacteur pour Error Reporting (roles/errorreporting.writer) à votre compte de service par défaut.

Vous pouvez utiliser l'ensemble de bibliothèques Google.Cloud.Diagnostics 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. Les messages écrits par App Engine dans stderr sont analysés, et Error Reporting les affiche s'ils contiennent une trace de pile.

Consultez la page Afficher les erreurs pour découvrir comment afficher des erreurs et des données d'exceptions relatives à votre application dans la console Google Cloud.

Google Kubernetes Engine

Pour utiliser Error Reporting avec Google Kubernetes Engine, effectuer les opérations suivantes:

1. Assurez-vous que le compte de service à utiliser par votre conteneur a été attribué au rôle Rédacteur Error Reporting (roles/errorreporting.writer).

   Vous pouvez utiliser le compte de service Compute Engine par défaut ou un compte de service personnalisé.

   Pour en savoir plus sur l'attribution de rôles, consultez la page Gérer l'accès aux projets, aux dossiers et aux organisations.

2. Créez votre cluster et attribuez-lui le rôle cloud-platform niveau d'accès.

   Par exemple, la commande de création suivante spécifie la portée d'accès cloud-platform et un compte de service :

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

Remarque : Une fois le cluster créé, vous ne pouvez plus modifier son compte de service.

Compute Engine

Pour utiliser Error Reporting avec des instances de VM Compute Engine, procédez comme suit :

1. Assurez-vous que le compte de service à utiliser par votre instance de VM a reçu le rôle Rédacteur Error Reporting (roles/errorreporting.writer).

   Vous pouvez utiliser le compte de service Compute Engine par défaut ou un compte de service personnalisé.

   Pour en savoir plus sur l'attribution de rôles, consultez la page Gérer l'accès aux projets, aux dossiers et aux organisations.

2. Dans la console Google Cloud, accédez à la page Instances de VM :

   Accéder à la page Instances de VM

   Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Compute Engine.

3. Sélectionnez l'instance de VM sur laquelle vous souhaitez recevoir le cloud-platform niveau d'accès.

4. Cliquez sur Arrêter, puis sur Modifier.

5. Dans la section Identité et accès à l'API, sélectionnez un compte de service doté du rôle Rédacteur Error Reporting (roles/errorreporting.writer).

6. Dans la section Niveaux d'accès, sélectionnez Autoriser l'accès complet à l'ensemble des API Cloud, puis enregistrez vos modifications.

7. Cliquez sur Démarrer/Réactiver.

Cloud Functions

Les fonctions Cloud Run accorde les autorisations Rôle de rédacteur pour Error Reporting (roles/errorreporting.writer) automatiquement à votre compte de service par défaut.

La Ensemble de bibliothèques Google.Cloud.Diagnostics peuvent être utilisées sans avoir à fournir explicitement identifiants de connexion.

Les fonctions Cloud Run sont configurées pour utiliser Error Reporting automatiquement. Les exceptions JavaScript non gérées apparaîtront dans Logging et seront traitées par Error Reporting sans avoir à utiliser l'ensemble de bibliothèques Google.Cloud.Diagnostics.

Remarque : Les entrées de journal sont traitées automatiquement si elles contiennent une trace de pile, et ne spécifient aucune gravité de journal ou une gravité de journal d'au moins ERROR, sans qu'il soit nécessaire d'utiliser l'ensemble de bibliothèques Google.Cloud.Diagnostics.

Exemple

Pour obtenir plus d'informations et des exemples, consultez les ressources suivantes :

Google.Cloud.Diagnostics.AspNetCore3 documentation

Google.Cloud.Diagnostics.AspNetCore documentation

Google.Cloud.Diagnostics.Common documentation

Exécuter des applications dans un environnement de développement local

Pour utiliser la Ensemble de bibliothèques Google.Cloud.Diagnostics dans un environnement de développement local, par exemple en exécutant la bibliothèque sur votre propre poste de travail, vous devez fournir votre Ensemble de bibliothèques Google.Cloud.Diagnostics avec les identifiants par défaut de l'application locale. Pour en savoir plus, consultez S'authentifier auprès d'Error Reporting.

Pour utiliser les exemples .NET de cette page dans un environnement de développement local, installez et initialisez gcloud CLI, puis configurez le service Identifiants par défaut de l'application à l'aide de vos identifiants utilisateur.

1. Install the Google Cloud CLI.

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

   gcloud init

3. 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.

   Note: If the gcloud CLI prints a warning that your account doesn't have the serviceusage.services.use permission, then some gcloud CLI commands and client libraries might not work. Ask an administrator to grant you the Service Usage Consumer IAM role (roles/serviceusage.serviceUsageConsumer), then run the following command:

   gcloud auth application-default set-quota-project PROJECT_ID

Pour en savoir plus, consultez Set up authentication for a local development environment.

La méthode projects.events.report est également compatible avec les clés API. Si vous souhaitez utiliser des clés API pour l'authentification, vous n'avez pas besoin de configurer un fichier d'identifiants par défaut de l'application local. Pour en savoir plus, consultez Créer une clé API dans la documentation sur l'authentification Google Cloud

Afficher les rapports d'erreurs

Dans la console Google Cloud, accédez à la page Error Reporting:

Accéder à Error Reporting

Vous pouvez également accéder à cette page à l'aide de la barre de recherche.

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