Verificar erros em um app com falha usando o Error Reporting

Verificar erros em um app com falha usando o Error Reporting

O Error Reporting oferece um local único para monitorar as condições de erro de todos os aplicativos e serviços em um projeto do Google Cloud e de aplicativos da Amazon Elastic Compute Cloud (EC2).

Neste guia, você aprenderá o seguinte:

1. Simular um erro de um serviço em um projeto do Google Cloud.

2. Usar o Error Reporting para visualizar o erro e alterar o status dele para que outras pessoas da sua equipe saibam que o problema está sendo resolvido.

3. Configurar as notificações para saber quando novos tipos de erro forem encontrados.

---

Para seguir as instruções passo a passo desta tarefa diretamente no console do Google Cloud, clique em Orientação:

Orientações

---

Antes de começar

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

5. Make sure that billing is enabled for your Google Cloud project.

6. Abra um Cloud Shell para o projeto do Google Cloud. Enquanto ele inicializa, a mensagem Conectando é exibida.

   Abra o Cloud Shell.

Simular um erro

1. Para gerar 11 erros de amostra, execute o seguinte script no Cloud Shell:

     COUNTER=0
     while [  $COUNTER -lt 11 ]; do
         gcloud beta error-reporting events report --service tutorial --service-version v$((COUNTER/10+1)) \
             --message "java.lang.RuntimeException: Error rendering template $COUNTER
               at com.example.TestClass.test(TestClass.java:51)
               at com.example.AnotherClass(AnotherClass.java:25)
               at javax.servlet.http.HttpServlet.service (HttpServlet.java:617)
               at javax.servlet.http.HttpServlet.service (HttpServlet.java:717)"
         if [ $COUNTER -eq 10 ]; then
           echo "All sample errors reported."
         fi
         let COUNTER=COUNTER+1
     done
   

   Quando o script terminar de gerar todos os erros, ele mostrará a seguinte mensagem:

   All sample errors reported.

Veja os erros no Error Reporting

1. No console do Google Cloud, acesse a página Error Reporting:

   Acessar o Error Reporting

   Também é possível encontrar essa página usando a barra de pesquisa.

   O painel do Error Reporting exibe um resumo em lista de cada erro encontrado e o número de ocorrências de cada erro. Quando a opção Atualizar automaticamente está ativada, o Error Reporting atualiza automaticamente a lista de erros a cada 10 segundos.

   A captura de tela abaixo mostra um exemplo de erro página de relatórios:

   

2. Clique no nome do erro para acessar a página de detalhes, que contém todas as informações disponíveis sobre um erro. Se o Gemini for ativado no projeto, use o Gemini para receber sugestões de solução de problemas.

Configurar notificações

É possível configurar o Error Reporting para notificá-lo quando um novo tipo de erro chegar. As notificações não são enviadas quando há novas ocorrências de erros atuais:

1. No console do Google Cloud, acesse a página Error Reporting:

   Acessar o Error Reporting

   Também é possível encontrar essa página usando a barra de pesquisa.

2. Para ativar as notificações por e-mail, clique em Mais e selecione Ativar notificações de novos erros para o projeto na lista suspensa.

3. Para gerar novos tipos de erros, clique em Ativar o Cloud Shell e execute o seguinte script:

     COUNTER=0
     while [ $COUNTER -lt 3 ]; do
           gcloud beta error-reporting events report --service tutorial --service-version v1 \
               --message "java.lang.ArrayIndexOutOfBoundsException: $COUNTER
                 at com.example.AppController.createUser(AppController.java:42)
                 at com.example.User(User.java:31)
                 at javax.servlet.http.HttpServlet.service (HttpServlet.java:617)
                 at javax.servlet.http.HttpServlet.service (HttpServlet.java:717)"
         if [ $COUNTER -eq 10 ]; then
           echo "All sample errors reported."
         fi
         let COUNTER=COUNTER+1
     done
   

   Quando o script terminar de gerar todos os erros, ele mostrará a seguinte mensagem:

   All sample errors reported.

4. Verifique se há uma mensagem do "Notificações do Stackdriver" no seu e-mail.

Gere mensagens de erro de um aplicativo do App Engine

Embora as mensagens de amostra geradas com base nos scripts simulem completamente erros no Error Reporting, caso queira gerar erros com base em um serviço real em execução no projeto do Google Cloud, siga as etapas nesta seção.

Implantar um aplicativo

Para fazer o download e implantar um aplicativo no App Engine, faça o seguinte:

1. Faça o download e configure o aplicativo do projeto python-docs-samples do GitHub:

   1. Clone o projeto no Cloud Shell:

      git clone https://github.com/GoogleCloudPlatform/python-docs-samples
      

      O Git retorna uma mensagem semelhante a esta:

      git clone https://github.com/GoogleCloudPlatform/python-docs-samples
      Cloning into 'python-docs-samples'...
      

   2. Crie um ambiente Python isolado e ative-o:

      cd python-docs-samples/appengine/standard_python3/hello_world
      virtualenv env -p python3
      source env/bin/activate
      

   3. Instale as dependências:

      pip install -r requirements.txt
      

2. Verifique se a instalação e a configuração do aplicativo foram bem-sucedidas:

   1. Execute o aplicativo:

      python main.py
      

   2. Para visualizar o aplicativo em uma página da Web local, clique no link exibido no Cloud Shell. A página da Web exibe Hello World!.

   3. Para interromper o aplicativo em execução, digite Ctrl-C no Cloud Shell.

3. Faça upload do aplicativo no App Engine.

   gcloud app deploy
   

   Se for solicitada uma região de implantação, selecione uma perto de você. Digite Y quando perguntado se você quer continuar. Depois de alguns momentos, o upload estará concluído.

4. Visualize o aplicativo em um navegador executando o seguinte comando no Cloud Shell:

   gcloud app browse
   

   Se a CLI do Google Cloud não encontrar o navegador, o comando anterior vai mostrar uma mensagem de erro e um link. Clique no link exibido. A mensagem Hello, World! é exibida no navegador.

Criar um erro

Para criar um erro que o Error Reporting detecta e exibe, faça o seguinte:

1. Edite main.py e altere

   return 'Hello World!
   

   a

   return 'Hello World!' + 1000
   

   Quando executada, essa alteração causa uma exceção TypeError do Python porque é ilegal concatenar uma string e um número inteiro.

2. Faça upload do aplicativo modificado no App Engine:

   gcloud app deploy
   

3. Volte para a guia do navegador que contém o aplicativo em execução e atualize a página. Devido à alteração, em vez da página exibir Hello, World!, ela exibe uma mensagem de erro:

   Internal Server Error
   The server encountered an internal error and was unable to complete your
   request. Either the server is overloaded or there is an error in the
   application.
   

   Se você não vir essa mensagem, espere um minuto e recarregue-a. Pode levar alguns instantes para a nova versão ser ativada.

Visualizar o erro no Error Reporting

Para ver o erro, siga as instruções da seção anterior Visualize os erros no Error Reporting.

Limpar

Para evitar cobranças na conta do Google Cloud pelos recursos usados nesta página, siga estas etapas.

Cuidado: excluir um projeto tem os seguintes efeitos:
• Tudo no projeto é excluído. Se você tiver usado um projeto existente para as tarefas neste documento, a exclusão dele incluirá a exclusão de quaisquer outros trabalhos feitos no projeto.
• Os IDs do projeto personalizados são perdidos. Ao criar o projeto, você pode ter criado um código do projeto personalizado para ser usado no futuro. Para preservar os URLs que usam o ID do projeto, como um URL appspot.com, exclua recursos específicos do projeto, em vez de excluir o projeto inteiro.
1. In the Google Cloud console, go to the Manage resources page.

   Go to Manage resources

2. In the project list, select the project that you want to delete, and then click Delete.
3. In the dialog, type the project ID, and then click Shut down to delete the project.

A seguir

• Saiba mais sobre erros de visualização

• Saiba mais sobre como gerenciar erros