Como configurar o Stackdriver Debugger para Node.js

Esta página descreve como configurar seu ambiente e seu aplicativo Node.js para usar o Stackdriver Debugger. Para alguns ambientes, é preciso especificar explicitamente o escopo de acesso para permitir que o agente do Stackdriver Debugger envie dados. Recomendamos definir o escopo de acesso da forma mais ampla possível e, em seguida, usar o Cloud Identity and Access Management para restringir o acesso. Para manter essa prática recomendada, defina o escopo de acesso para todas as APIs Cloud com a opção cloud-platform.

App Engine

  1. Use npm para instalar o pacote:

    npm install --save @google-cloud/debug-agent
    
  2. Ative o agente na parte superior do script principal ou do ponto de entrada do app (mas depois de @google/cloud-trace, se você o estiver usando também):

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

O depurador está pronto para ser usado com o app.

Para que a página "Depuração" no Console do GCP mostre automaticamente o código-fonte correspondente ao aplicativo implantado, consulte Como selecionar o código-fonte automaticamente.

Google Kubernetes Engine

  1. Crie seu cluster com um dos seguintes escopos de acesso:
    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud_debugger

    Para criar um cluster usando o gcloud, faça o seguinte:

    1. Atualize o gcloud para a versão mais recente (opcional):
      gcloud components update
    2. Defina o código do projeto padrão:
      gcloud config set project [PROJECT_ID]
    3. Se você estiver trabalhando com clusters zonais, defina a zona de computação padrão:
      gcloud config set compute/zone [COMPUTE_ZONE]
    4. Se você estiver trabalhando com clusters regionais, defina a região de computação padrão:
      gcloud config set compute/region [COMPUTE_REGION]
    5. Execute o comando de criação:
      gcloud container clusters create example-cluster-name --scopes https://www.googleapis.com/auth/cloud-platform

    Para informações mais detalhadas, consulte Como criar um cluster.

  2. Siga as instruções do Compute Engine.

Compute Engine

  1. Verifique se as instâncias do Compute Engine foram criadas com a opção de escopo de acesso Permitir acesso completo a todas as APIs do Cloud ou se elas têm um dos seguintes escopos de acesso:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud_debugger
  2. Use npm para instalar o pacote:

    npm install --save @google-cloud/debug-agent
    
  3. Ative o agente na parte superior do script principal ou do ponto de entrada do app (mas depois de @google/cloud-trace, se você o estiver usando também):

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

    Onde:

    • SERVICE é um nome do app, como MyApp, Backend ou Frontend;
    • VERSION é uma versão, como v1.0, build_147 ou v20170714.

    Recomendamos configurar isso a partir de variáveis de ambiente para que você não precise alterar o código-fonte em cada implantação.

O depurador está pronto para ser usado com o app.

Para que a página "Depuração" no Console do GCP mostre automaticamente o código-fonte correspondente ao app implantado, consulte Como selecionar o código-fonte automaticamente.

Ambiente local e outros

  1. Use npm para instalar o pacote:

    npm install --save @google-cloud/debug-agent
    
  2. Faça o download das credenciais da conta de serviço.

    Para usar o agente do Stackdriver Debugger para Node.js em máquinas não hospedadas pelo Google Cloud Platform, o agente deve usar as credenciais de uma conta de serviço do GCP para se autenticar com o serviço Stackdriver Debugger.

    Use a página Contas de serviço do Console do GCP para criar um arquivo de credenciais para uma conta de serviço nova ou existente. A conta de serviço precisa ter pelo menos o papel Stackdriver Debugger Agent.

  3. Configure e ative o agente com as credenciais salvas.

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

    Em que:

    • SERVICE é um nome do app, como MyApp, Backend ou Frontend;
    • VERSION é uma versão, como v1.0, build_147 ou v20170714.

    Recomendamos configurar isso a partir de variáveis de ambiente para que você não precise alterar o código-fonte em cada implantação.

O depurador está pronto para ser usado com o app.

A página "Depuração" no Console do GCP pode mostrar arquivos de origem locais, sem upload, para desenvolvimento local. Consulte Como selecionar o código-fonte manualmente.

Esta página foi útil? Conte sua opinião sobre:

Enviar comentários sobre…

Documentação do Stackdriver Debugger