Como configurar o Error Reporting para .NET

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

É possível enviar relatórios de erros para o Error Reporting a partir de aplicativos .NET usando o conjunto de bibliotecas do Google.Cloud.Diagnostics .

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, consulte a seção Como executar no Google Cloud Platform 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.

    Acessar o seletor de projetos

  3. Verifique se o faturamento está ativado para seu projeto na nuvem. Saiba como verificar se o faturamento está ativado em um projeto.

  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.

    Acessar o seletor de projetos

  6. Verifique se o faturamento está ativado para seu projeto na nuvem. Saiba como verificar se o faturamento está ativado em um projeto.

  7. Ative a Error Reporting API .

    Ative a API

Instalar a biblioteca de cliente

O conjunto de bibliotecas do Google.Cloud.Diagnostics permite monitorar e visualizar erros relatados por aplicativos .NET executados em praticamente qualquer lugar.

  1. Para aplicativos direcionados ao ASP.NET Core 3 ou posterior, use a biblioteca Google.Cloud.Diagnostics.AspNetCore3. Você pode instalar essa biblioteca em NuGet.
  2. Para aplicativos voltados a versões anteriores do ASP.NET Core, use a biblioteca Google.Cloud.Diagnostics.AspNetCore. Você pode instalar essa biblioteca em NuGet.
  3. Para aplicativos direcionados a frameworks não ASP.NET Core, use a biblioteca Google.Cloud.Diagnostics.Common. Você pode instalar essa biblioteca em NuGet.

Para mais informações sobre a instalação, leia a documentação do conjunto de bibliotecas do Google.Cloud.Diagnostics. Além disso, use o rastreador de problemas (em inglês) para informá-los.

Como configurar a biblioteca de cliente

Para mais informações e exemplos, consulte os seguintes recursos:

  • Google.Cloud.Diagnostics.AspNetCore3 documentação
  • Google.Cloud.Diagnostics.AspNetCore documentação
  • Google.Cloud.Diagnostics.Common documentação
  • Como relatar erros

    Para mais informações e exemplos, consulte os seguintes recursos:

  • Google.Cloud.Diagnostics.AspNetCore3 documentação
  • Google.Cloud.Diagnostics.AspNetCore documentação
  • Google.Cloud.Diagnostics.Common documentação
  • Como executar no Google Cloud

    Para usar o conjunto de bibliotecas do Google.Cloud.Diagnostics, é necessário ter o papel de gravador do Error Reporting do Identity and Access Management. Por padrão, a maioria das plataformas de computação do Google Cloud concede esse papel.

    É possível configurar o Error Reporting para .NET nos seguintes ambientes do Google Cloud.

    Ambiente flexível do App Engine

    O App Engine concede o papel Gravador do Error Reporting (em inglês) por padrão.

    O conjunto de bibliotecas do Google.Cloud.Diagnostics pode ser usado 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. Mensagens escritas do App Engine para stderr são analisadas e, se houver um stack trace, serão exibidas pelo Error Reporting.

    Consulte Como visualizar erros para ver instruções sobre como visualizar dados de erros e de exceções do seu aplicativo no Console do Google Cloud.

    Google Kubernetes Engine

    No GKE, você precisa adicionar o escopo de acesso cloud-platform ao criar o cluster, como mostra este exemplo de comando:

    gcloud container clusters create example-cluster-name --scopes https://www.googleapis.com/auth/cloud-platform
    

    Compute Engine

    Ao usar instâncias de VM do Compute Engine, adicione o escopo de acesso cloud-platform a cada instância. Ao criar uma nova instância usando o Console do Google Cloud, é possível fazer isso na seção Identidade e acesso à API do painel Criar instância. Use a conta de serviço padrão do Compute Engine ou outra de sua escolha e selecione Permitir acesso completo a todas as APIs do Cloud na seção Identidade e acesso à API. Seja qual for a conta de serviço selecionada, verifique se ela recebeu o papel de gravador do Error Reporting na seção IAM e administrador do Console do Google Cloud.

    Execução local e em outro lugar

    Para usar o conjunto de bibliotecas do Google.Cloud.Diagnostics fora do Google Cloud, incluindo a execução da biblioteca em sua própria estação de trabalho, nos computadores do data center ou nas instâncias de VM de outro provedor de nuvem, você precisa fornecer o ID do projeto do Google Cloud e as credenciais da conta de serviço apropriadas diretamente ao conjunto de bibliotecas do Google.Cloud.Diagnostics.

    É possível criar e receber credenciais da conta de serviço manualmente. Ao especificar o campo Papel, use o papel de gravador do Error Reporting. Para mais informações sobre os papéis de gerenciamento de identidade e acesso, consulte o Guia de controle de acesso.

    Como visualizar relatórios de erros

    Após a implantação, você pode ver os relatórios de erros no painel do Error Reporting no Console do Google Cloud.

    Acessar o painel do Error Reporting

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