Configurer Error Reporting pour .NET

Vous pouvez envoyer des rapports d'erreurs à Error Reporting depuis des applications .NET à l'aide de l'ensemble de bibliothèques Google.Cloud.Diagnostics.

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. Assurez-vous que la facturation est activée pour votre projet Cloud. Découvrez comment vérifier que la facturation est activée pour votre projet.

  4. Activez Error Reporting API .

    Activer l'API

  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. Assurez-vous que la facturation est activée pour votre projet Cloud. Découvrez comment vérifier que la facturation est activée pour votre projet.

  7. Activez Error Reporting API .

    Activer l'API

Installer la bibliothèque cliente

L'ensemble de bibliothèques Google.Cloud.Diagnostics vous permet de surveiller et d'afficher les erreurs signalées par les applications .NET exécutées presque n'importe où.

  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 bibliothèque Google.Cloud.Diagnostics.AspNetCore. 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 :

  • Documentation Google.Cloud.Diagnostics.AspNetCore3
  • Documentation Google.Cloud.Diagnostics.AspNetCore
  • Documentation Google.Cloud.Diagnostics.Common
  • Signaler des erreurs

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

  • Documentation Google.Cloud.Diagnostics.AspNetCore3
  • Documentation Google.Cloud.Diagnostics.AspNetCore
  • Documentation Google.Cloud.Diagnostics.Common
  • Exécuter des applications sur Google Cloud

    L'utilisation de l'ensemble de bibliothèques Google.Cloud.Diagnostics nécessite le rôle Identity and Access Management de rédacteur 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.

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

    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 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 l'ensemble de bibliothèques Google.Cloud.Diagnostics en dehors de Google Cloud, y compris en les exécutant sur votre propre station de travail, sur les ordinateurs de votre centre de données ou sur les instances de VM d'un autre fournisseur cloud, vous devez fournir votre ID de projet Google Cloud et les identifiants du compte de service appropriés directement à l'ensemble de bibliothèques Google.Cloud.Diagnostics.

    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.