Como configurar o Stackdriver Debugger para Java

Nesta página, você verá como configurar seu ambiente e o aplicativo em Java para usar o Stackdriver Debugger. Para alguns ambientes, é necessário especificar explicitamente o escopo de acesso para que o agente do Stackdriver Debugger envie dados. Recomendamos definir o escopo de acesso da forma mais ampla possível e depois usar o Cloud Identity and Access Management para restringir o acesso. Para manter essa prática recomendada, configure o escopo de acesso para todas as APIs do Cloud com a opção cloud-platform.

Antes de começar

Para começar a usar o Debugger, verifique se a API Stackdriver Debugger está ativada.
Ativar a API Stackdriver Debugger

Ambiente padrão do App Engine

O depurador é ativado por padrão. Nenhuma configuração é necessária. A página "Depuração" no Console do Cloud tentará exibir automaticamente os arquivos de origem Java usados para criar o app.

Para saber mais, consulte Como selecionar o código-fonte automaticamente.

Ambiente flexível do App Engine

O depurador é ativado por padrão para o ambiente de execução Java. Nenhuma configuração é necessária. A página "Depuração" no Console do Cloud tentará exibir automaticamente os arquivos de origem Java usados para criar o app.

O depurador é incluído por padrão nos ambientes de execução personalizados que usam as imagens de base para Java fornecidas pelo Google. Nenhuma configuração será necessária se o ponto de entrada padrão for usado. A página "Depuração" no Console do Cloud tentará exibir automaticamente os arquivos de origem Java usados para criar o app.

Para usar o Stackdriver Debugger com ambientes de execução personalizados criados com outras imagens de base, siga as instruções de configuração do Compute Engine.

Para saber mais, consulte Como selecionar o código-fonte automaticamente.

Google Kubernetes Engine

GCLOUD

Para ativar o Debugger usando a gcloud, conclua as etapas abaixo:

  1. Crie seu cluster com um destes escopos de acesso:

    • https://www.googleapis.com/auth/cloud-platform concede ao cluster acesso a todas as APIs do Google Cloud.

    • https://www.googleapis.com/auth/cloud_debugger concede ao cluster acesso apenas à API Stackdriver Debugger. Use esse escopo de acesso para reforçar a segurança do seu cluster.

    gcloud container clusters create example-cluster-name \
           --scopes=https://www.googleapis.com/auth/cloud_debugger
    
  2. Adicione as linhas a seguir ao Dockerfile para inserir o agente do Debugger no aplicativo em contêiner e inicializá-lo quando o app estiver implantado:

    # Create a directory for the Debugger. Add and unzip the agent in the directory.
    RUN  mkdir /opt/cdbg && \
         wget -qO- https://storage.googleapis.com/cloud-debugger/compute-java/debian-wheezy/cdbg_java_agent_gce.tar.gz | \
         tar xvz -C /opt/cdbg
    
    # Start the agent when the app is deployed.
    RUN java -agentpath:/opt/cdbg/cdbg_java_agent.so \
        -Dcom.google.cdbg.module=MODULE \
        -Dcom.google.cdbg.version=VERSION \
        -jar PATH_TO_JAR_FILE
    

Em que:

  • PATH_TO_JAR_FILE é o caminho relativo para o arquivo JAR do app. Por exemplo: ~/myapp.jar;

  • MODULE é o nome do app. Com a versão, ele identifica o app no Console do Cloud. Por exemplo, MyApp, Backend ou Frontend;

  • VERSION é a versão do app, por exemplo, o ID da compilação. O Console do Cloud exibe o aplicativo em execução como MODULE - VERSION. Por exemplo, v1.0, build_147 ou v20160520.

O depurador agora estará pronto para uso quando você implantar o app em contêiner.

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

CONSOLE

Para ativar o Debugger usando o Console, conclua as etapas a seguir:

  1. Depois de selecionar o tipo de cluster, clique em Mais opções no painel Pool de nós:

    Campo

  2. Selecione uma das opções abaixo no painel Segurança:

    • Permitir acesso completo a todas as APIs do Cloud.

    • Permitir o acesso de cada API e, em seguida, selecionar Ativado para o Cloud Debugger.

Compute Engine

Use o Stackdriver Debugger com qualquer app em Java executado em uma instância do Compute Engine. Recomendamos que você ative o Debugger em todas as instâncias em execução do seu app.

  1. Verifique se as instâncias de VM do Compute Engine estão executando:

    • uma imagem Debian Linux de 64-bit;
    • a versão 7, 8 ou 9 do JDK do Java.
  2. Verifique se as instâncias de VM 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 destes escopos de acesso:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud_debugger
  3. Faça o download do pacote de agente pré-criado:

    sudo mkdir /opt/cdbg
    wget -qO- https://storage.googleapis.com/cloud-debugger/compute-java/debian-wheezy/cdbg_java_agent_gce.tar.gz | \
        sudo tar xvz -C /opt/cdbg
    
  4. Adicione o agente à invocação Java:
    Se você estiver usando Tomcat ou Jetty, consulte a seção Servidores da Web .

    java -agentpath:/opt/cdbg/cdbg_java_agent.so \
      -Dcom.google.cdbg.module=MODULE \
      -Dcom.google.cdbg.version=VERSION \
      -jar PATH_TO_JAR_FILE
    

    Em que:

    • PATH_TO_JAR_FILE é o caminho relativo para o arquivo JAR do app. Por exemplo: ~/myapp.jar;

    • MODULE é o nome do app. Com a versão, ele identifica o app no Console do Cloud. Por exemplo, MyApp, Backend ou Frontend;

    • VERSION é a versão do app, por exemplo, o ID da compilação. O Console do Cloud exibe o aplicativo em execução como MODULE - VERSION. Por exemplo, v1.0, build_147 ou v20160520.

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

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

Servidores da Web

Geralmente, os servidores da Web do Java são iniciados por meio de um processo de bootstrap, e cada servidor da Web tem sua própria maneira de personalizar as opções do Java.

Tomcat

Adicione esta linha a /etc/default/tomcat7 ou /etc/default/tomcat8:

JAVA_OPTS="${JAVA_OPTS} -agentpath:/opt/cdbg/cdbg_java_agent.so \
  -Dcom.google.cdbg.module=MODULE \
  -Dcom.google.cdbg.version=VERSION"

Se você executar o Tomcat em um contêiner do Docker, adicione esta linha a Dockerfile em vez disso:

ENV JAVA_OPTS -agentpath:/opt/cdbg/cdbg_java_agent.so \
              -Dcom.google.cdbg.module=MODULE \
              -Dcom.google.cdbg.version=VERSION

Jetty

Adicione estas linhas a /var/lib/jetty/start.d:

--exec
-agentpath:/opt/cdbg/cdbg_java_agent.so
-Dcom.google.cdbg.module=MODULE
-Dcom.google.cdbg.version=VERSION

Cloud Run e Cloud Run para Anthos no Google Cloud

  1. Adicione os comandos a seguir ao Dockerfile para criar um diretório em que instalar o agente do Debugger, fazer o download do arquivo desse agente e extraí-lo para o diretório de instalação:

    RUN mkdir /opt/cdbg && \
        wget -qO- https://storage.googleapis.com/cloud-debugger/compute-java/debian-wheezy/cdbg_java_agent_gce.tar.gz | \
        tar xvz -C /opt/cdbg
    

    Localize a invocação Java e adicione a sinalização a seguir para inicializar o agente do Debugger. Por exemplo:

    RUN  java -agentpath:/opt/cdbg/cdbg_java_agent.so \
        -jar PATH_TO_JAR_FILE
    

    Em que:

    • PATH_TO_JAR_FILE é o caminho relativo para o arquivo JAR do aplicativo. Por exemplo: ~/myapp.jar.

Na página Depuração, selecione o local do código-fonte. Para que a página Depuração no Console do Cloud exiba automaticamente o código-fonte que corresponde ao app implantado, consulte Como selecionar o código-fonte automaticamente.

O depurador está pronto para ser usado.

Ambiente local e outros

  1. Faça o download do pacote de agente pré-criado do Debugger:

    mkdir /opt/cdbg
    wget -qO- https://storage.googleapis.com/cloud-debugger/compute-java/debian-wheezy/cdbg_java_agent_service_account.tar.gz | \
        tar xvz -C /opt/cdbg
    
  2. Faça o download das credenciais da conta de serviço.
    Para usar o agente do Stackdriver Debugger para Java em máquinas não hospedadas pelo Google Cloud, o agente precisa de credenciais de conta de serviço do Google Cloud para fazer a autenticação com o serviço do Stackdriver Debugger.

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

    Coloque o arquivo JSON da conta de serviço ao lado do agente do Stackdriver Debugger para Java.

  3. Adicione o agente à invocação do Java:

    java -agentpath:/opt/cdbg/cdbg_java_agent.so \
      -Dcom.google.cdbg.module=MODULE \
      -Dcom.google.cdbg.version=VERSION \
      -Dcom.google.cdbg.auth.serviceaccount.enable=true
      -Dcom.google.cdbg.auth.serviceaccount.jsonfile=/opt/cdbg/gcp-svc.json
      -jar PATH_TO_JAR_FILE
    

    Em que:

    • PATH_TO_JAR_FILE é o caminho relativo para o arquivo JAR do app. Por exemplo: ~/myapp.jar;

    • MODULE é o nome do app. Com a versão, ele identifica o aplicativo no Console do Cloud. Por exemplo, MyApp, Backend ou Frontend;

    • VERSION é a versão do app, por exemplo, o ID da compilação. O Console do Cloud exibe o aplicativo em execução como MODULE - VERSION. Por exemplo, v1.0, build_147 ou v20160520;

    • É possível usar a variável de ambiente GOOGLE_APPLICATION_CREDENTIALS em vez de adicionar a propriedade de sistema auth.serviceaccount.jsonfile.

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

A página "Depuração" no Console do Cloud pode exibir 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…

Stackdriver Debugger