Configurer Stackdriver Debugger pour Node.js

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

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

    require('@google-cloud/debug-agent').start();
    

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

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

Google Kubernetes Engine

  1. Créez votre cluster avec l'un des champs d'application d'accès suivants :
    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud_debugger

    Pour créer un cluster à l'aide de gcloud, procédez comme suit :

    1. (Facultatif) Installez la dernière mise à jour de gcloud :
      gcloud components update
    2. Définissez votre ID de projet par défaut :
      gcloud config set project [PROJECT_ID]
    3. Si vous utilisez des clusters zonaux, définissez la zone de calcul par défaut :
      gcloud config set compute/zone [COMPUTE_ZONE]
    4. Si vous utilisez des clusters régionaux, définissez la région de calcul par défaut :
      gcloud config set compute/region [COMPUTE_REGION]
    5. Émettez la commande "create" :
      gcloud container clusters create example-cluster-name --scopes https://www.googleapis.com/auth/cloud-platform

    Pour en savoir plus sur la création des clusters, consultez la section Créer un cluster.

  2. Suivez les instructions pour Compute Engine.

Compute Engine

  1. Assurez-vous que l'option de champ d'application d'accès Autoriser l'accès complet à toutes les API Cloud est activée pour vos instances Compute Engine, ou que ces dernières disposent de l'un des champs d'application d'accès suivants :

    • 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) :

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

    Où :

    • SERVICE est un nom pour 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 savoir comment afficher automatiquement le code source correspondant à l'application déployée sur la page "Débogage" de la console GCP, consultez la page Sélectionner automatiquement le code source.

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 utiliser l'agent Stackdriver Debugger pour Node.js sur des machines non hébergées par Google Cloud Platform, l'agent doit utiliser les identifiants du compte de service GCP pour s'authentifier auprès du service Stackdriver Debugger.

    Utilisez la page des comptes de service de la console GCP pour créer un fichier d'identifiants pour un compte de service nouveau ou existant. Ce compte doit au moins disposer du rôle Stackdriver Debugger Agent.

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

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

    Où :

    • SERVICE est un nom pour 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 la console GCP peut afficher les fichiers source locaux, sans les importer, pour les développements en local. Consultez la page Sélectionner manuellement le code source.

Cette page vous a-t-elle été utile ? Évaluez-la :

Envoyer des commentaires concernant…

Documentation Stackdriver Debugger