Configurer Cloud Debugger pour Node.js

Aperçu

Cette page explique comment configurer l'environnement et l'application Node.js pour qu'ils utilisent Cloud Debugger. Pour certains environnements, vous devez spécifier explicitement le champ d'application d'accès pour permettre à l'agent Cloud Debugger d'envoyer des données. Nous vous recommandons de définir le niveau d'accès le plus large possible, puis d'utiliser Identity and Access Management pour limiter l'accès. Conformément à cette bonne pratique, définissez le niveau d'accès sur toutes les API Cloud avec l'option cloud-platform.

Versions de langages et environnements de calcul

Cloud Debugger est disponible pour Node.js 1.9 et les versions ultérieures dans les environnements de calcul suivants :

Environnement standard App Engine Environnement flexible App Engine Compute Engine Google Kubernetes Engine Cloud Run Cloud Run pour Anthos sur Google Cloud VM et conteneurs s'exécutant ailleurs Cloud Functions

Configurer Cloud Debugger

Pour configurer Cloud Debugger, procédez comme suit :

  1. Vérifiez que l'API Cloud Debugger est activée pour votre projet.

  2. Installez et configurez le Debugger sur l'environnement de calcul que vous utilisez.

  3. Sélectionnez votre code source.

Vérifier que l'API Cloud Debugger est activée

Pour commencer à utiliser Cloud Debugger, assurez-vous que l'API Cloud Debugger est activée. Cloud Debugger est activé par défaut pour la plupart des projets.
Activer l'API Cloud Debugger

Instantanés et points de journalisation Canary

L'Agent Debugger pour Node.js peut utiliser des instantanés et des points de journalisation Canary chaque fois que vous définissez un instantané ou un point de journalisation.

L'Agent Debugger peut envoyer des instantanés et des points de journalisation afin de protéger les tâches volumineuses contre tout bug potentiel dans l'Agent Debugger, qui peut supprimer la tâche entière lorsqu'un instantané ou un point de journalisation est appliqué.

Pour remédier à ce problème, les instantanés et les points de journalisation du système de débogage sur un sous-ensemble de vos instances en cours d'exécution sont définis à chaque fois. Une fois que Debugger a vérifié l'instantané ou le point de journalisation n'affecte pas vos instances en cours d'exécution, Debugger applique ensuite l'instantané ou le point de journalisation à toutes les instances.

Pour apprendre à utiliser le débogueur en mode Canary, accédez aux pages Instantanés de débogage et Points de journalisation de débogage.

Activer les instantanés et points de journalisation Canary

Lorsque vous installez la dernière version de l'Agent Debugger, vous avez la possibilité d'activer ou de désactiver la version Canary. La version Canary est désactivée par défaut.

Quand activer les instantanés et les points de journalisation Canary

Pour protéger les charges de travail de déploiement et de production critiques, activez la version Canary lors du débogage de ces charges de travail.

Si vous disposez d'une seule instance, vous pouvez toujours déboguer en utilisant la version Canary, mais votre instance unique s'exécute sans dupliquer l'instantané ou le point de journalisation.

Quand ne pas activer les instantanés et points de journalisation Canary

N'activez pas la fonctionnalité Canary sur des charges de travail dont la durée d'exécution est inférieure à 40 secondes, par exemple les tâches utilisant Cloud Functions.

N'activez pas la version Canary si vous souhaitez un cycle de déclenchement d'instantanés plus rapide.

Pour configurer l'Agent Debugger de manière à ne pas utiliser les instantanés et les points de journalisation Canary, consultez les instructions d'installation de la plate-forme Google Cloud que vous utilisez.

App Engine

  1. Installez le package à l'aide de npm :

    npm install --save @google-cloud/debug-agent
    
  2. Activez l'agent dans la partie supérieure du script principal ou du point d'entrée de votre application (mais après @google/cloud-trace si vous l'utilisez également) :

    Pour procéder au débogage avec la version Canary activée, procédez comme suit :

    require('@google-cloud/debug-agent').start({serviceContext: {enableCanary: true}});
    

    Pour déboguer avec la version Canary non activée, définissez enableCanary sur false :

    require('@google-cloud/debug-agent').start({serviceContext: {enableCanary: false}});
    

Le débogueur est maintenant prêt à être utilisé avec l'application.

Pour découvrir comment afficher automatiquement le code source correspondant à l'application déployée sur la page "Débogage" de Cloud Console, consultez la page Sélectionner automatiquement le code source.

Google Kubernetes Engine

GCLOUD

Pour activer Debugger à l'aide de gcloud, procédez comme suit :

  1. Créez votre cluster avec l'un des niveaux d'accès suivants :

    • https://www.googleapis.com/auth/cloud-platform permet à votre cluster d'accéder à toutes les API Google Cloud.

    • https://www.googleapis.com/auth/cloud_debugger ne permet à votre cluster d'accéder qu'à l'API Debugger. Utilisez ce niveau d'accès pour renforcer la sécurité de votre cluster.

    gcloud container clusters create example-cluster-name \
           --scopes=https://www.googleapis.com/auth/cloud_debugger
    
  2. Incluez la ligne suivante dans le fichier Dockerfile pour ajouter l'agent Debugger :

    RUN  npm install --save @google-cloud/debug-agent
    
  3. Activez l'agent dans la partie supérieure du script principal ou du point d'entrée de votre application (mais après @google/cloud-trace si vous l'utilisez également) :

    Pour procéder au débogage avec la version Canary activée, procédez comme suit :

    require('@google-cloud/debug-agent').start({
      serviceContext: {
        service: 'SERVICE',
        version: 'VERSION'
        enableCanary: true,
      }
    });
    

    Pour déboguer avec la version Canary non activée, définissez enableCanary sur false :

    enableCanary: false
    

    Où :

    • SERVICE est le nom de votre application, tel que MyApp, Backend ou Frontend.
    • VERSION est une version, telle que v1.0, build_147 ou v20170714.

    Nous vous recommandons de définir ces éléments à partir de variables d'environnement. Ainsi, vous n'aurez pas à modifier le code source à chaque déploiement.

Le débogueur est maintenant prêt à être utilisé lors du déploiement de votre application en conteneur.

Pour découvrir comment afficher automatiquement le code source correspondant à l'application déployée sur la page "Débogage" de Cloud Console, consultez la page Sélectionner automatiquement le code source.

CONSOLE

Pour activer Debugger à l'aide de la console, procédez comme suit :

  1. Après avoir sélectionné le type de cluster, cliquez sur More options (Plus d'options) dans le volet Node pools (Pools de nœuds) :

    Options des pools de nœuds

  2. Sélectionnez l'une des options suivantes dans le volet Sécurité :

    • Autoriser l'accès complet à l'ensemble des API Cloud

    • Définir l'accès pour chaque API, puis sélectionner Activé pour Cloud Debugger

  3. Incluez la ligne suivante dans le fichier Dockerfile pour ajouter l'agent Debugger :

        RUN  npm install --save @google-cloud/debug-agent
    
  4. Activez l'agent dans la partie supérieure du script principal ou du point d'entrée de votre application (mais après @google/cloud-trace si vous l'utilisez également) :

    Pour procéder au débogage avec la version Canary activée, procédez comme suit :

    require('@google-cloud/debug-agent').start({
      serviceContext: {
        service: 'SERVICE',
        version: 'VERSION'
        enableCanary: true,
      }
    });
    

    Pour déboguer avec la version Canary non activée, définissez enableCanary sur false :

    enableCanary: false
    

    Où :

    • SERVICE est le nom de votre application, tel que MyApp, Backend ou Frontend.
    • VERSION est une version, telle que v1.0, build_147 ou v20170714.

    Nous vous recommandons de définir ces éléments à partir de variables d'environnement. Ainsi, vous n'aurez pas à modifier le code source à chaque déploiement.

Compute Engine

  1. Assurez-vous que vos instances Compute Engine sont créées avec l'option de niveau d'accès Autoriser l'accès complet à toutes les API Cloud ou que leur niveau d'accès correspond à l'une des options suivantes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud_debugger
  2. Installez le package à l'aide de npm :

    npm install --save @google-cloud/debug-agent
    
  3. Activez l'agent dans la partie supérieure du script principal ou du point d'entrée de votre application (mais après @google/cloud-trace si vous l'utilisez également) :

    Pour procéder au débogage avec la version Canary activée, procédez comme suit :

    require('@google-cloud/debug-agent').start({
      serviceContext: {
        service: 'SERVICE',
        version: 'VERSION',
        enableCanary: true,
      }
    });
    

    Pour déboguer avec la version Canary non activée, définissez enableCanary sur false :

    enableCanary: false
    

    Où :

    • SERVICE est le nom de votre application, tel que MyApp, Backend ou Frontend.
    • VERSION est une version, telle que v1.0, build_147 ou v20170714.

    Nous vous recommandons de définir ces éléments à partir de variables d'environnement. Ainsi, vous n'aurez pas à modifier le code source à chaque déploiement.

Le débogueur est maintenant prêt à être utilisé avec l'application.

Pour découvrir comment afficher automatiquement le code source correspondant à l'application déployée sur la page "Débogage" de Cloud Console, consultez la page Sélectionner automatiquement le code source.

Cloud Run et Cloud Run pour Anthos sur Google Cloud

  1. Installez le package à l'aide de npm :

    npm install --save @google-cloud/debug-agent
    
  2. Activez l'agent dans la partie supérieure du script principal ou du point d'entrée de votre application (mais après @google/cloud-trace si vous l'utilisez également) :

    Pour procéder au débogage avec la version Canary activée, procédez comme suit :

    require('@google-cloud/debug-agent').start({serviceContext: {enableCanary: true}});
    

    Pour déboguer avec la version Canary non activée, définissez enableCanary sur false :

    enableCanary: false
    

    Le débogueur est maintenant prêt à être utilisé lors du déploiement de votre application en conteneur.

Environnement local et autre

  1. Installez le package à l'aide de npm :

    npm install --save @google-cloud/debug-agent
    
  2. Téléchargez les identifiants du compte de service.

    Pour que vous puissiez utiliser l'agent Cloud Debugger pour Node.js sur des machines qui ne sont pas hébergées par Google Cloud, celui-ci doit s'authentifier auprès du service Cloud Debugger à l'aide des informations d'identification du compte de service Google Cloud.

    Suivez les instructions de la page Comptes de service de Cloud Console pour créer un fichier d'identifiants pour un compte de service nouveau ou existant. Ce compte doit au moins disposer du rôle Cloud Debugger Agent.

  3. Configurez et activez l'agent avec les identifiants téléchargés.

    Pour procéder au débogage avec la version Canary activée, procédez comme suit :

    require('@google-cloud/debug-agent').start({
      projectId: 'your-project-id',
      keyFilename: '/path/to/key.json',
      serviceContext: {
        service: 'SERVICE',
        version: 'VERSION',
        enableCanary: true,
      }
    });
    

    Pour déboguer avec la version Canary non activée, définissez enableCanary sur false :

    enableCanary: false
    

    Où :

    • SERVICE est le nom de votre application, tel que MyApp, Backend ou Frontend.
    • VERSION est une version, telle que v1.0, build_147 ou v20170714.

    Nous vous recommandons de définir ces éléments à partir de variables d'environnement. Ainsi, vous n'aurez pas à modifier le code source à chaque déploiement.

Le débogueur est maintenant prêt à être utilisé avec l'application.

La page "Débogage" de Cloud Console peut afficher les fichiers source locaux, sans les importer, pour les développements en local. Pour en savoir plus, consultez la page Sélectionner manuellement le code source.