Activer le Débogueur de capture instantanée pour les applications .NET dans Azure App Service

Remarque

Si vous utilisez une préversion de .NET Core ou si votre application référence le SDK Application Insights, directement ou indirectement via un assembly dépendant, suivez les instructions permettant d’activer le Débogueur de capture instantanée pour d’autres environnements en vue d’inclure le package NuGet Microsoft.ApplicationInsights.SnapshotCollector avec l’application.

Le Débogueur de capture instantanée prend en charge les applications ASP.NET et ASP.NET Core qui s’exécutent sur Azure App Service dans des plans de service Windows.

Lorsque vous utilisez le Débogueur de capture instantanée, nous vous recommandons d'exécuter votre application avec les niveaux de service De base ou supérieur. Pour la plupart des applications :

• La mémoire disponible ou l’espace disque avec les niveaux de service Gratuit et Partagé est insuffisant pour enregistrer les captures instantanées.
• Actuellement, le niveau Consommation n’est pas disponible pour le Débogueur de capture instantanée.

Bien que le débogueur de capture instantanée est préinstallé dans le cadre du runtime d’App Services, vous devez l’activer pour obtenir des captures instantanées pour votre application App Service. L’installation sans code du Débogueur de capture instantanée suit la politique de support .NET Core.

Azure portal

Une fois que vous avez déployé votre application web .NET Appe Services :

1. Accédez à votre application App Service dans le portail Azure.

2. Dans le menu de gauche, sélectionnez Paramètres>Application Insights.

   

3. Cliquez sur Activer Application Insights.

   • Si vous disposez d’une ressource Application Insights existante, sélectionnez cette option sous Modifier votre ressource.

4. Sous Instrumenter votre application, sélectionnez l’onglet .NET.

5. Positionnez les deux commutateurs du Débogueur de capture instantanée sur Activé.

   

6. Le Débogueur de capture instantanée est désormais activé.

Désactiver le Débogueur de capture instantanée

Pour désactiver le Débogueur de capture instantanée pour votre ressource App Services :

1. Accédez à votre application App Service dans le portail Azure.
2. Dans le menu de gauche, sélectionnez Paramètres>Application Insights.
3. Positionnez les commutateurs du Débogueur de capture instantanée sur Désactivé.

Azure Resource Manager

Vous pouvez également définir des paramètres d’application dans le modèle Resource Manager pour activer le Débogueur de capture instantanée et le Profileur. Par exemple :

{
  "apiVersion": "2023-12-01",
  "name": "[parameters('webSiteName')]",
  "type": "Microsoft.Web/sites",
  "location": "[resourceGroup().location]",
  "dependsOn": [
    "[variables('hostingPlanName')]"
  ],
  "tags": { 
    "[concat('hidden-related:', resourceId('Microsoft.Web/serverfarms', variables('hostingPlanName')))]": "empty",
    "displayName": "Website"
  },
  "properties": {
    "name": "[parameters('webSiteName')]",
    "serverFarmId": "[resourceId('Microsoft.Web/serverfarms', variables('hostingPlanName'))]"
  },
  "resources": [
    {
      "apiVersion": "2015-08-01",
      "name": "appsettings",
      "type": "config",
      "dependsOn": [
        "[parameters('webSiteName')]",
        "[concat('AppInsights', parameters('webSiteName'))]"
      ],
      "properties": {
        "APPINSIGHTS_INSTRUMENTATIONKEY": "[reference(resourceId('Microsoft.Insights/components', concat('AppInsights', parameters('webSiteName'))), '2014-04-01').InstrumentationKey]",
        // "Turn on" a Snapshot Debugger version
        "APPINSIGHTS_SNAPSHOTFEATURE_VERSION": "1.0.0",
        "DiagnosticServices_EXTENSION_VERSION": "~3",
        "ApplicationInsightsAgent_EXTENSION_VERSION": "~2"
      }
    }
  ]
},

Générez du trafic vers votre application pouvant déclencher une exception. Attendez ensuite 10 à 15 minutes le temps que des captures instantanées soient envoyées à l’instance Application Insights.

Activer le Débogueur de capture instantanée pour les autres régions cloud

Seules les régions Azure Government et Microsoft Azure géré par 21Vianet nécessitent la modification de leurs points de terminaison par le biais d’une chaîne de connexion Application Insights.

Propriété de chaîne de connexion	Cloud US Government	China Cloud
SnapshotEndpoint	https://snapshot.monitor.azure.us	https://snapshot.monitor.azure.cn

Pour plus d’informations sur les autres substitutions de connexion, consultez la documentation Application Insights.

Configurer le Débogueur de capture instantanée

Activer l’authentification Microsoft Entra pour l’ingestion d’instantanés

Le Débogueur de capture instantanée prend en charge l’authentification Microsoft Entra pour l’ingestion d’instantanés. Pour que tous les instantanés de votre application soient ingérés, votre application doit être authentifiée et fournir les paramètres d’application requis à l’agent Débogueur de capture instantanée.

À ce jour, Débogueur de capture instantanée ne prend en charge l’authentification Microsoft Entra ID que lorsque vous référencez et configurez Microsoft Entra à l’aide du Kit de développement logiciel (SDK) Application Insights dans votre application.

Pour activer Microsoft Entra ID pour l’ingestion d’instantanés dans votre ressource App Services :

1. Ajoutez l’identité managée qui s’authentifie auprès de votre ressource Application Insights sur votre instance App Service. Vous pouvez créer l’une ou l’autre des options suivantes :

   • Ajouter une identité managée affectée par le système.
   • Ajouter une identité managée affectée par l’utilisateur.

2. Configurez et activez Microsoft Entra ID dans votre ressource Application Insights. Pour plus d’informations, consultez la documentation suivante.

3. Ajoutez les paramètres d’application suivants. Ce paramètre indique à l’agent de Débogueur de capture instantanée quelle identité managée utiliser :

Pour l’identité affectée par le système :

Paramètre d'application	Valeur
APPLICATIONINSIGHTS_AUTHENTICATION_STRING	Authorization=AD

Pour l’identité affectée par l’utilisateur :

Paramètre d'application	Valeur
APPLICATIONINSIGHTS_AUTHENTICATION_STRING	Authorization=AD;ClientID={Client ID of the User-Assigned Identity}

Scénarios non pris en charge

Vous trouverez ci-dessous des scénarios dans lesquels Snapshot Collector n’est pas pris en charge :

Scénario	Effets secondaires	Recommandation
Vous utilisez le SDK Snapshot Collector directement depuis votre application (.csproj) et avez activé l’option avancée « Interop ».	Le SDK Application Insights local (y compris la télémétrie Snapshot Collector) sont perdus et aucune capture instantanée n’est disponible. Votre application peut se bloquer au démarrage avec System.ArgumentException: telemetryProcessorTypedoes not implement ITelemetryProcessor. En savoir plus sur la fonctionnalité Application Insights « Interop ».	Si vous utilisez l’option avancée « Interop », utilisez l’injection Snapshot Collector sans code (activée via le portail Azure).

Étapes suivantes

• Affichez les captures instantanées dans le portail Azure.
• Résoudre les problèmes du Débogueur de capture instantanée.