Instrumentar os aplicativos Ruby para o Error Reporting

É possível enviar relatórios de erros para o Error Reporting a partir de aplicativos Ruby usando a biblioteca do Error Reporting para Ruby (em inglês). Use a biblioteca do Error Reporting para Ruby para criar grupos de erros para os seguintes casos:

• O bucket de registros tem chaves de criptografia gerenciadas pelo cliente (CMEK).
• Os buckets de registros não estão na região global.
• Você quer relatar eventos de erro personalizados.

O Error Reporting é integrado a alguns serviços do Google Cloud, como App Engine, Compute Engine e Google Kubernetes Engine. Essa ferramenta exibe os erros registrados no Cloud Logging por aplicativos em execução nesses serviços. Para mais informações, acesse Como executar no Google Cloud nesta página.

Também é possível enviar dados de erros para o Error Reporting usando o Logging. Para mais informações sobre os requisitos de formatação de dados, leia Como formatar mensagens de erro no Logging (em inglês).

Antes de começar

1. Faça login na sua conta do Google Cloud. Se você começou a usar o Google Cloud agora, crie uma conta para avaliar o desempenho de nossos produtos em situações reais. Clientes novos também recebem US$ 300 em créditos para executar, testar e implantar cargas de trabalho.

2. No console do Google Cloud, na página do seletor de projetos, selecione ou crie um projeto do Google Cloud.

   Observação: se você não pretende manter os recursos criados neste procedimento, crie um projeto novo em vez de selecionar um que já existe. Depois de concluir essas etapas, é possível excluir o projeto. Para fazer isso, basta remover todos os recursos associados a ele.

   Acessar o seletor de projetos

3. Verifique se a cobrança está ativada para o seu projeto do Google Cloud.

4. Ative a Error Reporting API .

   Ative a API

5. No console do Google Cloud, na página do seletor de projetos, selecione ou crie um projeto do Google Cloud.

   Observação: se você não pretende manter os recursos criados neste procedimento, crie um projeto novo em vez de selecionar um que já existe. Depois de concluir essas etapas, é possível excluir o projeto. Para fazer isso, basta remover todos os recursos associados a ele.

   Acessar o seletor de projetos

6. Verifique se a cobrança está ativada para o seu projeto do Google Cloud.

7. Ative a Error Reporting API .

   Ative a API

8. Instale o Ruby 2.2+ ou posterior.

Instale a biblioteca de cliente

Com a biblioteca do Error Reporting para Ruby, você pode monitorar e visualizar os erros relatados por aplicativos Ruby que estão em execução em praticamente qualquer lugar.

1. Adicione a gem google-cloud-error_reporting ao Gemfile:

   gem "google-cloud-error_reporting"

2. Use o Bundler para instalar a gem:

   bundle install

Como ativar a biblioteca

Se você estiver usando o Ruby on Rails, o Bundler carregará a biblioteca automaticamente no seu aplicativo quando ela for iniciada.

Outros aplicativos baseados em Rack podem usar o middleware do Rack fornecido pela biblioteca:

require "google/cloud/error_reporting"

use Google::Cloud::ErrorReporting::Middleware

Para mais informações sobre a instalação, leia a documentação da biblioteca do Error Reporting para Ruby (em inglês). Além disso, use o rastreador de problemas (em inglês) para informá-los.

Configurar a biblioteca de cliente

É possível personalizar o comportamento da biblioteca do Error Reporting para Ruby. Consulte a configuração da biblioteca para ver uma lista das opções possíveis.

Executar apps no Google Cloud

Para criar grupos de erros usando projects.events.report, sua conta de serviço exige o papel Gravador do Error Reporting (roles/errorreporting.writer).

Alguns serviços do Google Cloud concedem automaticamente o papel de Gravador do Error Reporting (roles/errorreporting.writer) à conta de serviço adequada. No entanto, você precisa conceder esse papel à conta de serviço apropriada para alguns serviços.

Ambiente flexível do App Engine

O App Engine concede automaticamente o papel Gravador do Error Reporting (roles/errorreporting.writer) à sua conta de serviço padrão.

A biblioteca do Error Reporting para Ruby pode ser usada sem a necessidade de fornecer credenciais explicitamente.

O Error Reporting é ativado automaticamente para aplicativos do ambiente flexível do App Engine. Nenhuma outra configuração é necessária.

Observação :os registros de erros gravados em stderr são processados automaticamente pelo Error Reporting, sem que seja necessário usar a biblioteca do Error Reporting para Ruby diretamente.

Google Kubernetes Engine

Para usar o Error Reporting com o Google Kubernetes Engine, faça o seguinte:

1. Verifique se a conta de serviço a ser usada pelo contêiner recebeu o papel Gravador do Error Reporting (roles/errorreporting.writer).

   É possível usar a conta de serviço padrão do Compute Engine ou uma conta de serviço personalizada.

   Para informações sobre como conceder papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

2. Crie o cluster e conceda a ele o escopo de acesso cloud-platform.

   Por exemplo, o comando create a seguir especifica o escopo de acesso cloud-platform e uma conta de serviço:

   gcloud container clusters create CLUSTER_NAME --service-account  SERVICE_ACCT_NAME --scopes=cloud-platform
   

Observação :depois de criar um cluster, não é possível alterar a conta de serviço dele.

Compute Engine

Para usar o Error Reporting com instâncias de VM do Compute Engine, faça o seguinte:

1. Verifique se a conta de serviço a ser usada pela instância de VM recebeu o papel Gravador do Error Reporting (roles/errorreporting.writer).

   É possível usar a conta de serviço padrão do Compute Engine ou uma conta de serviço personalizada.

   Para informações sobre como conceder papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

2. No painel de navegação do console do Google Cloud, selecione Compute Engine e, depois, Instâncias de VM:

   Acessar Instâncias de VM

3. Selecione a instância de VM em que você quer receber o escopo de acesso cloud-platform.

4. Clique em Parar e em Editar.

5. Na seção Identidade e acesso à API, selecione uma conta de serviço que tenha o papel Gravador do Error Reporting (roles/errorreporting.writer).

6. Na seção Escopos de acesso, selecione Permitir acesso completo a todas as APIs do Cloud e salve as alterações.

7. Clique em Iniciar / retomar.

Como usar a interface de configuração do Ruby on Rails

Para usar a biblioteca do Error Reporting para Ruby com o framework Ruby on Rails, forneça os parâmetros por meio da interface de configuração do Ruby on Rails:

# Add this to config/environments/*.rb
Rails.application.configure do |config|
  # Stackdriver Error Reporting specific parameters
  config.google_cloud.error_reporting.project_id = "YOUR-PROJECT-ID"
  config.google_cloud.error_reporting.keyfile    = "/path/to/service-account.json"
end

Também é possível definir uma configuração compartilhada para todas as gems do Stackdriver usando o seguinte código:

# Add this to config/environments/*.rb
Rails.application.configure do |config|
  # Stackdriver Shared parameters
  config.google_cloud.project_id = "YOUR-PROJECT-ID"
  config.google_cloud.keyfile    = "/path/to/service-account.json"
end

O Error Reporting é ativado por padrão quando o Rails está em execução no modo de produção. Para habilitar o Error Reporting no modo de desenvolvimento, adicione o seguinte:

# Add this to config/environments/development.rb
Rails.application.configure do |config|
  config.google_cloud.use_error_reporting = true
end

Como usar a interface de configuração de instrumentação

Para usar a biblioteca do Error Reporting para Ruby em outros aplicativos baseados em Rack, forneça os parâmetros por meio da interface de configuração:

require "google/cloud/error_reporting"

Google::Cloud.configure do |config|
  # Stackdriver Error Reporting specific parameters
  config.error_reporting.project_id = "YOUR-PROJECT-ID"
  config.error_reporting.keyfile    = "/path/to/service-account.json"
end

Também é possível definir uma configuração compartilhada para todas as gemas de observabilidade do Google Cloud usando o seguinte:

require "stackdriver"

Google::Cloud.configure do |config|
  # Stackdriver Shared parameters
  config.project_id = "YOUR-PROJECT-ID"
  config.keyfile    = "/path/to/service-account.json"
end

Exemplo

Como relatar erros em bibliotecas com base em rack

A biblioteca do Error Reporting para Ruby facilita a integração do Error Reporting aos frameworks da Web de Ruby baseados em Rack mais conhecidos, como Ruby on Rails e Sinatra. Quando a biblioteca está ativa, ela informa automaticamente as exceções capturadas na pilha de racks do aplicativo.

Como relatar erros manualmente

É possível relatar um erro, manualmente, chamando o método report, conforme visto no exemplo a seguir:

require "google/cloud/error_reporting"

begin
  raise "Something went wrong"
rescue StandardError => e
  Google::Cloud::ErrorReporting.report e
end

Executar apps em um ambiente de desenvolvimento local

Para usar a biblioteca do Error Reporting para Ruby em um ambiente de desenvolvimento local, como executar a biblioteca na sua própria estação de trabalho, é preciso fornecer a biblioteca do Error Reporting para Ruby com as credenciais padrão do aplicativo local. Para mais informações, consulte Autenticar no Error Reporting.

Para usar as amostras de Ruby nesta página de um ambiente de desenvolvimento local, instale e inicialize a CLI gcloud e, em seguida, configure o Application Default Credentials com as credenciais de usuário.

1. Instale a CLI do Google Cloud.

2. Para inicializar a CLI gcloud, execute o seguinte comando:

   gcloud init

3. Crie as credenciais de autenticação para sua Conta do Google:

   gcloud auth application-default login

   Observação: se a CLI gcloud exibir um aviso de que sua conta não tem a permissão serviceusage.services.use, alguns comandos da CLI gcloud podem não funcionar. Solicite ao administrador um papel de IAM de consumidor do Service Usage (roles/serviceusage.serviceUsageConsumer) e execute o comando a seguir:

   gcloud auth application-default set-quota-project PROJECT_ID

Veja mais informações em: Configurar a autenticação para um ambiente de desenvolvimento local.

O método projects.events.report também aceita chaves de API. Se você quiser usar chaves de API na autenticação, não será necessário configurar um arquivo local do Application Default Credentials. Veja mais informações em Crie uma chave de API na documentação de autenticação do Google Cloud.

Como usar a interface de configuração do Ruby on Rails

Para usar a biblioteca do Error Reporting para Ruby com o framework Ruby on Rails, forneça os parâmetros por meio da interface de configuração do Ruby on Rails:

# Add this to config/environments/*.rb
Rails.application.configure do |config|
  # Stackdriver Error Reporting specific parameters
  config.google_cloud.error_reporting.project_id = "YOUR-PROJECT-ID"
  config.google_cloud.error_reporting.keyfile    = "/path/to/service-account.json"
end

Também é possível definir uma configuração compartilhada para todas as gems do Stackdriver usando o seguinte código:

# Add this to config/environments/*.rb
Rails.application.configure do |config|
  # Stackdriver Shared parameters
  config.google_cloud.project_id = "YOUR-PROJECT-ID"
  config.google_cloud.keyfile    = "/path/to/service-account.json"
end

O Error Reporting é ativado por padrão quando o Rails está em execução no modo de produção. Para habilitar o Error Reporting no modo de desenvolvimento, adicione o seguinte:

# Add this to config/environments/development.rb
Rails.application.configure do |config|
  config.google_cloud.use_error_reporting = true
end

Como usar a interface de configuração de instrumentação

Para usar a biblioteca do Error Reporting para Ruby em outros aplicativos baseados em Rack, forneça os parâmetros por meio da interface de configuração:

require "google/cloud/error_reporting"

Google::Cloud.configure do |config|
  # Stackdriver Error Reporting specific parameters
  config.error_reporting.project_id = "YOUR-PROJECT-ID"
  config.error_reporting.keyfile    = "/path/to/service-account.json"
end

Também é possível definir uma configuração compartilhada para todas as gemas de observabilidade do Google Cloud usando o seguinte:

require "stackdriver"

Google::Cloud.configure do |config|
  # Stackdriver Shared parameters
  config.project_id = "YOUR-PROJECT-ID"
  config.keyfile    = "/path/to/service-account.json"
end

Como visualizar relatórios de erros

No painel de navegação do console do Google Cloud, selecione Error Reporting e escolha seu projeto do Google Cloud:

Acessar o Error Reporting

Para mais informações, consulte Como visualizar erros.