Configura Cloud Debugger para Node.js

En esta página, se describe cómo configurar tu entorno y tu aplicación de Node.js para usar Cloud Debugger. En algunos entornos, debes especificar explícitamente el nivel de acceso para permitir que el agente de Cloud Debugger envíe datos. Recomendamos configurar el nivel de acceso más amplio posible y, luego, usar Cloud Identity and Access Management para restringir el acceso. De acuerdo con esta práctica recomendada, debes configurar el nivel de acceso para que estén todas las API de Cloud con la opción cloud-platform.

Antes de comenzar

Para comenzar a usar Cloud Debugger, asegúrate de que la API de Cloud Debugger esté habilitada.
Habilitar la API de Cloud Debugger

App Engine

  1. Usa npm para instalar el paquete:

    npm install --save @google-cloud/debug-agent
        
  2. Habilita el agente en la parte superior de la secuencia de comandos o punto de entrada principal de tu app (pero después de @google/cloud-trace, si también lo estás usando):

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

Ahora puedes usar Debugger con tu app.

Para que en la página de Depuración en Cloud Console se muestre de forma automática el código fuente que coincide con la app implementada, consulta la sección Selecciona el código fuente de forma automática.

Google Kubernetes Engine

GCLOUD

Para habilitar Debugger con gcloud, completa los siguientes pasos:

  1. Crea tu clúster con uno de los niveles de acceso siguientes:

    • https://www.googleapis.com/auth/cloud-platform otorga a tu clúster acceso a todas las API de Google Cloud.

    • https://www.googleapis.com/auth/cloud_debugger otorga a tu clúster acceso solo a la API de Debugger. Usa este nivel de acceso para fortalecer la seguridad de tu clúster.

        gcloud container clusters create example-cluster-name \
               --scopes=https://www.googleapis.com/auth/cloud_debugger
        
  2. Agrega la línea siguiente a tu Dockerfile con el fin de agregar el agente de Debugger:

    RUN  npm install --save @google-cloud/debug-agent
        
  3. Habilita el agente en la parte superior de la secuencia de comandos principal o el punto de entrada de su app (pero después de @google/cloud-trace, si también lo usas):

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

    Aquí:

    • SERVICE es el nombre de tu app, como MyApp, Backend o Frontend.
    • VERSION es una versión, como v1.0, build_147 o v20170714.

    Recomendamos configurar estos valores desde las variables de entorno para que no tengas que cambiar el código fuente con cada implementación.

Ahora puedes usar el depurador cuando implementes tu app en contenedores.

Para que en la página de Depuración en Cloud Console se muestre de forma automática el código fuente que coincide con la app implementada, consulta la sección Selecciona el código fuente de forma automática.

CONSOLE

Para habilitar Debugger con la consola, completa los pasos siguientes:

  1. Después de seleccionar tu tipo de clúster, haz clic en Más opciones en el panel de Grupos de nodos:

    Opciones de grupos de nodos

  2. Selecciona una de las opciones siguientes del panel de Seguridad:

    • Permitir el acceso total a todas las API de Cloud

    • Permitir el acceso a cada API y, luego, seleccionar Habilitada para el Depurador de Cloud

Compute Engine

  1. Asegúrate de que tus instancias de Compute Engine se creen con la opción de nivel de acceso Permitir el acceso total a todas las API de Cloud, o que tengan uno de los siguientes niveles de acceso:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud_debugger
  2. Usa npm para instalar el paquete:

    npm install --save @google-cloud/debug-agent
        
  3. Habilita el agente en la parte superior de la secuencia de comandos principal o el punto de entrada de tu app (pero después de @google/cloud-trace, si también lo usas):

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

    Aquí:

    • SERVICE es el nombre de tu app, como MyApp, Backend o Frontend.
    • VERSION es una versión, como v1.0, build_147 o v20170714.

    Recomendamos configurar estos valores desde las variables de entorno para que no tengas que cambiar el código fuente con cada implementación.

Ahora puedes usar Debugger con tu app.

Para que en la página de Depuración en Cloud Console se muestre de forma automática el código fuente que coincide con la app implementada, consulta la sección Selecciona el código fuente de forma automática.

Cloud Run y Cloud Run para Anthos en Google Cloud

  1. Usa npm para instalar el paquete:

    npm install --save @google-cloud/debug-agent
        
  2. Habilita el agente en la parte superior de la secuencia de comandos principal o el punto de entrada de su app (pero después de @google/cloud-trace, si también lo usas):

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

    Puedes usar el depurador cuando implementes tu app.

En el entorno local y en otros lugares

  1. Usa npm para instalar el paquete:

    npm install --save @google-cloud/debug-agent
        
  2. Descarga las credenciales de la cuenta de servicio.

    Para usar el agente de Cloud Debugger para Node.js en máquinas no alojadas por Google Cloud, el agente debe usar credenciales de cuenta de servicio de Google Cloud para autenticarse con el servicio de depuración de Cloud.

    Usa la página Cuentas de servicio de Cloud Console a fin de crear un archivo de credenciales para una cuenta de servicio nueva o existente. La cuenta de servicio debe tener al menos la función de Cloud Debugger Agent.

  3. Configura y habilita al agente con las credenciales descargadas:

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

    Aquí:

    • SERVICE es el nombre de tu app, como MyApp, Backend o Frontend.
    • VERSION es una versión, como v1.0, build_147 o v20170714.

    Recomendamos configurar estos valores desde las variables de entorno para que no tengas que cambiar el código fuente con cada implementación.

Ahora puedes usar Debugger con tu app.

En la página de Depuración en Cloud Console, se pueden mostrar los archivos de origen local, sin subir, para el desarrollo local. Consulta Selecciona el código fuente de forma manual.