Déboguer un service cloud Azure dans Visual Studio

Visual Studio vous offre différentes options de débogage des machines virtuelles et de Azure Cloud Services.

Prérequis

• Un compte Azure. Si vous n’avez pas de compte Azure, activez vos avantages Azure pour les abonnés Visual Studio ou inscrivez-vous pour bénéficier d’un essai gratuit.

Déboguer votre service cloud sur votre ordinateur local

Vous pouvez gagner du temps et de l’argent en utilisant l’émulateur de calcul Azure pour déboguer votre service cloud sur une machine locale. Déboguer un service localement avant de le déployer vous permet d’améliorer la fiabilité et les performances, tout en évitant les coûts de temps de calcul. Certaines erreurs peuvent toutefois se produire quand vous exécutez un service cloud directement dans Azure. Vous pouvez déboguer ces erreurs si vous activez le débogage distant quand vous publiez votre service, puis attachez le débogueur à une instance de rôle.

L’émulateur simule le service de calcul Azure et s’exécute dans votre environnement local pour vous permettre de tester et déboguer votre service cloud avant son déploiement. Il gère le cycle de vie de vos instances de rôle et donne accès aux ressources simulées, telles que le stockage local. Quand vous déboguez ou exécutez votre service à partir de Visual Studio, le programme démarre automatiquement l’émulateur comme une application d’arrière-plan, puis déploie votre service vers l’émulateur. Vous pouvez utiliser l’émulateur pour voir votre service en cours d’exécution dans l’environnement local. Vous pouvez exécuter la version complète ou express de l’émulateur. Consultez Utilisation de l’émulateur express pour exécuter et déboguer un service cloud localement.

Pour déboguer votre service cloud sur votre ordinateur local

1. Dans la barre de menus, sélectionnez Déboguer>Démarrer le débogage pour exécuter votre projet de service cloud Azure. Vous pouvez aussi appuyer sur F5. Un message s'affiche, indiquant que l'émulateur de calcul est en cours de démarrage. Une icône s’affiche dans la zone de notification pour confirmer le démarrage de l’émulateur.

   

2. Affichez l’interface utilisateur de l’émulateur de calcul en ouvrant le menu contextuel de l’icône Azure dans la zone de notification, puis en sélectionnant Afficher l’interface utilisateur de l’émulateur de calcul.

   Le volet gauche de l'interface utilisateur montre les services actuellement déployés sur l'émulateur de calcul et les instances de rôle en cours d'exécution sur chaque service. Vous pouvez sélectionner le service ou des rôles pour afficher les informations liées au cycle de vie, aux journaux et aux diagnostics dans le volet de droite. Si vous placez le focus dans la marge supérieure d’une fenêtre incluse, celle-ci se développe pour remplir le volet droit.

3. Parcourez l’application en choisissant des commandes dans le menu Déboguer et en définissant des points d’arrêt dans votre code. À mesure que vous parcourez l'application dans le débogueur, les volets sont mis à jour avec l'état actuel de l'application. Lorsque vous arrêtez le débogage, le déploiement de l’application est supprimé. Si votre application inclut un rôle web et que vous avez réglé la propriété Action de démarrage pour démarrer le navigateur web, Visual Studio démarre votre application web dans le navigateur. Si vous modifiez le nombre d’instances d’un rôle dans la configuration du service, vous devez arrêter votre service cloud, puis redémarrer le débogage afin de pouvoir déboguer ces nouvelles instances du rôle.

   Notes

   Quand vous cessez l’exécution ou le débogage de votre service, les émulateurs de calcul et de stockage locaux ne s’arrêtent pas. Vous devez les arrêter explicitement à partir de la zone de notification.

Déboguer un service cloud dans Azure

L’activation du débogage à distance pour un service cloud à l’aide de la procédure décrite dans cette section n’entraîne pas de baisse des performances ni de coûts supplémentaires. N’utilisez pas le débogage distant pour un service de production, car cela peut avoir un impact pour les clients qui utilisent ce service.

Notes

Quand vous publiez un service cloud à partir de Visual Studio, vous pouvez activer IntelliTrace pour tous les rôles de ce service qui ciblent .NET Framework 4 ou .NET Framework 4.x. Avec IntelliTrace, vous pouvez examiner des événements qui se sont déjà produits dans une instance de rôle et reproduire le contexte de ce moment-là. Consultez Débogage d’un service cloud publié avec IntelliTrace et Visual Studio et Utilisation d’IntelliTrace.

Pour activer le débogage à distance pour un service cloud (support étendu)

1. Ajoutez un point de terminaison à ServiceDefinition.csdef pour le port msvsmon par défaut. Pour Visual Studio 2022, il s’agit du port 4026. Pour Visual Studio 2019, il s’agit du port 4024.

   <Endpoints>
      <InputEndpoint name="RemoteDebug" protocol="tcp" port="4026" localPort="4026" />
   </Endpoints>
   

   Notes

   D’autres versions de Visual Studio ont des ports différents. Consultez Attributions de port au débogueur à distance.

2. Si vous ciblez .NET 4.8, veillez à ouvrir le fichier ServiceConfiguration.Cloud.cscfg et à vérifier la valeur de l’attribut osFamily sur l’élément ServiceConfiguration au moment de la publication de services cloud (support étendu). Pour un projet .NET 4.8, utilisez osFamily="7".

3. Ouvrez le menu contextuel du projet Azure, puis sélectionnez Publier.

4. Sélectionnez l’environnement Intermédiaire et la configuration Débogage.

   Il s’agit simplement d’une indication. Vous pouvez choisir d’exécuter vos environnements de test dans un environnement de production. L’activation du débogage distant sur l’environnement de production risque toutefois d’avoir un impact pour les utilisateurs. Vous pouvez choisir la configuration Release, mais la configuration Debug présente l’avantage de simplifier le débogage.

   

5. Suivez les étapes habituelles décrites dans Services cloud (support étendu), mais en activant la case à cocher Activer le Bureau à distance pour tous les rôles.

   Vous serez invité à créer un nom d'utilisateur et un mot de passe pour l'utilisateur du Bureau à distance. Vous en aurez besoin plus tard pour vous connecter à cette machine virtuelle.

6. Passez à l’écran suivant, passez en revue vos paramètres et, quand vous êtes prêt, cliquez sur Publier et attendez que le déploiement se termine.

7. Connectez-vous au portail Azure et accédez au service cloud (support étendu) que vous souhaitez déboguer.

8. Choisissez Rôles et instances dans le volet de gauche, puis choisissez le rôle que vous souhaitez déboguer à distance.

9. Cliquez sur Connexion dans la fenêtre contextuelle Instance de rôle à droite, puis choisissez le bouton Connexion pour télécharger un fichier Bureau à distance qui vous permettra de vous connecter à la machine virtuelle. Connectez-vous à l’aide des informations d’identification que vous avez créées précédemment, au moment de l’activation du Bureau à distance.

   

10. Sur la machine virtuelle Azure distante, installez les outils Débogueur distant Visual Studio 2022 comme décrit dans Débogage à distance.

11. À partir du bureau sur la machine virtuelle, exécutez la commande D:\Program Files\Microsoft Visual Studio 17.0\Common7\IDE\Remote Debugger\x64\msvsmon.exe. Veillez à l’exécuter en tant qu’administrateur.

12. Acceptez les invites d’autorisation d’accès à travers le pare-feu. Vous devez voir un message indiquant que msvsmon.exe a commencé à écouter les connexions.

    

13. Dans le portail Azure, ouvrez le groupe de ressources et récupérez l’adresse IP publique du service cloud (support étendu).

    

Pour attacher le débogueur à un service cloud (support étendu) dans Azure

Notes

Dans la mesure du possible, vous devez déboguer avec la configuration Debug choisie dans le processus Publier. Cependant, si vous déboguez une configuration Release, dans Visual Studio, utilisez Ctrl+Q pour rechercher « Uniquement mon code » et décochez Activer Uniquement mon code dans Outils>Options>Débogage>Général. Les builds Release sont optimisées et ne sont donc pas considérées comme « Mon code ».

1. Choisissez Déboguer>Attacher au processus (ou appuyez surCtrl+Alt+P).

2. Conservez le type de connexion Par défaut.

3. Entrez la cible de connexion en utilisant votre adresse IP et le port {ipaddress}:4026.

4. Définissez Attacher à sur Automatique.

5. Connectez-vous à l’aide des mêmes informations d’identification que celles de l’utilisateur du Bureau à distance.

6. Sélectionnez Afficher des processus pour tous les utilisateurs. Si vous déboguez un rôle de travail, attachez à WaWorkerHost.exe. Si vous déboguez un rôle web, attachez au processus w3wp.exe. Pour un rôle d’API web, choisissez WaIISHost.exe.

7. Définissez des points d’arrêt (accédez à la ligne et appuyez sur F9), accédez à l’URL publique du site et reproduisez le scénario à déboguer.

Limitations du débogage distant dans Azure

Le débogage à distance présente les limitations suivantes :

• Quand le débogage distant est activé, vous ne pouvez pas publier un service cloud dans lequel un rôle comporte plus de 25 instances.

• Le débogueur utilise les ports 30400 à 30424, 31400 à 31424 et 32400 à 32424. Si vous essayez d’utiliser ces ports, vous ne pourrez pas publier votre service, et l’un des messages d’erreur suivants s’affichera dans le journal des activités Azure :

  • Erreur lors de la validation du fichier .cscfg par rapport au fichier .csdef. La plage de ports réservée « range » pour le point de terminaison Microsoft.WindowsAzure.PlugIns.RemoteDebugger.Connector du rôle « rôle » chevauche une plage ou un port déjà défini.
  • L’allocation a échoué. Réessayez ultérieurement, essayez de réduire la taille de la machine virtuelle ou le nombre d'instances de rôle, ou essayez de déployer dans une autre région.

Débogage de Azure App Service

Vous pouvez déboguer des programmes qui s'exécutent dans Azure App Service à l'aide de la boîte de dialogue Attacher au processus dans Visual Studio.

Remarque

Cette option est disponible uniquement pour Azure App Service à partir de Visual Studio 2022 17.1.

Pour déboguer un service Windows Azure App Service

1. Sous Déboguer, sélectionnez Attacher au processus.

2. Dans Type de connexion, remplacez la valeur par défaut par Microsoft Azure App Services, puis sélectionnez Rechercher...

3. Dans la boîte de dialogue qui s’ouvre, sélectionnez un nom sous Nom de l’abonnement.

   

   Remarque

   Vous devez être connecté à un compte Microsoft avec accès à l'abonnement qui contient votre service Azure App Service.

4. Filtrez la vue sur le critère Groupe de ressources ou Type de ressource, ou effectuez une recherche par nom.

5. Ensuite, sélectionnez le service App Service que vous souhaitez déboguer, puis sélectionnez OK.

   Ceci active le débogage à distance sur votre service App Service et affiche la liste des processus disponibles pour l’attachement.

   

6. Sélectionnez le processus cible de l’attachement, puis choisissez Attacher pour démarrer le débogage.

Contenu connexe

• Utilisez IntelliTrace pour collecter un journal des appels et des événements à partir d’un serveur de mise en production. Consultez Débogage d’un service cloud publié avec IntelliTrace et Visual Studio.

• Utilisez les Diagnostics Azure pour collecter des informations détaillées du code actuellement exécuté dans des rôles qui sont eux-mêmes exécutés dans l’environnement de développement ou dans Azure. Consultez Collecter des données de journalisation avec les diagnostics Azure.

• Pour d’autres scénarios de débogage à distance, consultez Débogage à distance.