Configurer Error Reporting pour .NET

Activer la bibliothèque

Vous pouvez envoyer des rapports d'erreurs à Error Reporting depuis des applications .NET à l'aide de la bibliothèque Error Reporting pour .NET.

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.

    Si vous n'en possédez pas déjà un, vous devez en créer un.

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

    Accéder à la page de sélection du projet

  3. Vérifiez que la facturation est activée pour votre projet Google Cloud. Découvrez comment vérifier que la facturation est activée pour votre projet.

  4. Activez Error Reporting API .

    Activer l'API

Installer la bibliothèque cliente

La bibliothèque Error Reporting pour .NET vous permet de surveiller et d'afficher les erreurs signalées par les applications .NET exécutées depuis presque n'importe quel emplacement.

Pour en savoir plus sur l'installation, consultez la documentation sur la bibliothèque Error Reporting pour .NET. 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 de la bibliothèque Error Reporting pour .NET. Consultez la documentation de référence de l'API .NET.

Signaler des erreurs

Installez les bibliothèques cloud avec la commande suivante :

Gestionnaire de packages

PM> Install-Package Google.Cloud.Diagnostics.AspNetCore -Version 2.0.1

CLI .NET

> dotnet add package Google.Cloud.Diagnostics.AspNetCore --version 2.0.1

Si vous utilisez un environnement flexible App Engine, consultez la section Environnement flexible App Engine.

Exécuter des applications sur Google Cloud

L'utilisation de la bibliothèque Error Reporting pour .NET 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 .NET dans les environnements Google Cloud suivants.

Environnement flexible App Engine

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

La bibliothèque Error Reporting pour .NET peut être utilisée 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 Cloud Console.

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

Instance

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 Google Cloud Console, 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é, vérifiez qu'il dispose du rôle Rédacteur Error Reporting dans la section IAM et administration de Cloud Console.

Exécuter en local et depuis un autre emplacement

Pour utiliser la bibliothèque Error Reporting pour .NET 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 la bibliothèque Error Reporting pour .NET.

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

Après le déploiement, vous pouvez afficher les rapports d'erreurs dans le tableau de bord Error Reporting de Cloud Console.

Accéder au tableau de bord Error Reporting

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

Configurer Error Reporting pour les applications .NET Core

Pour utiliser la bibliothèque cliente Google.Cloud.Diagnostics.AspNetCore, procédez comme suit :

  1. Cliquez avec le bouton droit sur la solution dans Visual Studio et sélectionnez Gérer les packages Nuget pour la solution.

  2. Cochez la case Inclure la version préliminaire.

  3. Recherchez et installez le package nommé Google.Cloud.Diagnostics.AspNetCore.

  4. Une fois le client Google.Cloud.Diagnostics.AspNetCore installé, ajoutez la directive d'utilisation suivante aux fichiers de code source de votre application si vous souhaitez personnaliser les informations sur les erreurs envoyées à Error Reporting :

     using Google.Cloud.Diagnostics.AspNetCore;
    

Puis, procédez comme suit pour consigner les rapports d'erreurs personnalisés depuis votre application :

  1. Créez ou modifiez la méthode ConfigureServices dans le fichier Startup.cs de votre application, puis appelez services.AddGoogleExceptionLogging() :

    services.AddGoogleExceptionLogging(options =>
    {
        options.ProjectId = "YOUR-GOOGLE-PROJECT-ID";
        options.ServiceName = "ShoppingCartService";
        options.Version = "0.01";
    });
    
  2. Modifiez la méthode Configure dans le fichier Startup.cs de votre application, puis appelez app.UseGoogleExceptionLogging() avant d'appeler app.UseStaticFiles() et app.UseMvc().

    // Use before handling any requests to ensure all unhandled exceptions are reported.
    app.UseGoogleExceptionLogging();
    

L'exemple suivant illustre la journalisation d'erreurs pour signaler un événement d'erreur personnalisé à des fins d'ingestion par Error Reporting :

throw new Exception("Generic exception for testing Stackdriver Error Reporting");