Instrumentar apps C# para o Error Reporting

É possível enviar relatórios de erros para o Error Reporting a partir de aplicativos C# usando o conjunto de bibliotecas do Google.Cloud.Diagnostics . Use o conjunto de bibliotecas Google.Cloud.Diagnostics para criar grupos de erros nos seguintes casos:

• Um bucket de registros que contém suas entradas de registro tem chaves de criptografia gerenciadas pelo cliente (CMEK).
• O bucket de registros atende a uma das seguintes condições:
  • O bucket de registros é armazenado no mesmo projeto em que as entradas de registro foram criadas.
  • As entradas de registro foram encaminhadas para um projeto, que as armazenou em um bucket de registros de propriedade dele.
• Você quer informar eventos de erro personalizados.

O Error Reporting é integrado a alguns Google Cloud serviços, como o Cloud Functions, o App Engine, o Compute Engine e o 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 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

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.

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

Go to project selector

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

Enable the Error Reporting API .

Enable the API

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

Go to project selector

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

Enable the Error Reporting API .

Enable the API

Instale a biblioteca de cliente

O conjunto de bibliotecas do Google.Cloud.Diagnostics permite monitorar e visualizar erros relatados por aplicativos C# 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.

Configurar a biblioteca de cliente

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

1. Documentação do Google.Cloud.Diagnostics.AspNetCore3 (link em inglês)
2. Documentação do Google.Cloud.Diagnostics.AspNetCore (link em inglês)
3. Documentação do Google.Cloud.Diagnostics.Common (link em inglês)

Executar apps no Google Cloud

Para criar grupos de erros usando projects.events.report, sua conta de serviço precisa ter o papel de 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 apropriada. No entanto, é preciso conceder esse papel à conta de serviço adequada para alguns serviços.

Cloud Run e Cloud Run functions

A conta de serviço padrão usada pelo Cloud Run tem as permissões do papel Gravador do Error Reporting (roles/errorreporting.writer).

O conjunto de bibliotecas do Google.Cloud.Diagnostics pode ser usado sem a necessidade de fornecer credenciais explicitamente.

O Cloud Run está configurado para usar o Error Reporting automaticamente. As exceções de JavaScript não processadas vão aparecer no Logging e serão processadas pelo Error Reporting sem a necessidade de usar o conjunto de bibliotecas Google.Cloud.Diagnostics.

Ambiente flexível do App Engine

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

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 instruções sobre como visualizar dados de erros e exceções para seu aplicativo noGoogle Cloud console.

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 que será usada pelo contêiner tem o papel de 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 saber mais sobre a concessão de 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 de criação 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
   

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 que 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 saber mais sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

2. No Google Cloud console, acesse a página Instâncias de VM:

   Acessar Instâncias de VM

   Se você usar a barra de pesquisa para encontrar a página, selecione o resultado com o subtítulo Compute Engine.

3. Selecione a instância de VM que vai receber o cloud-platform escopo de acesso.

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 de gravador do Error Reporting (roles/errorreporting.writer).

6. Na seção Escopos de acesso, selecione Permitir acesso total a todas as APIs do Cloud e salve as mudanças.

7. Clique em Iniciar / retomar.

Exemplo

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

4. Documentação do Google.Cloud.Diagnostics.AspNetCore3 (link em inglês)
5. Documentação do Google.Cloud.Diagnostics.AspNetCore (link em inglês)
6. Documentação do Google.Cloud.Diagnostics.Common (link em inglês)

Executar apps em um ambiente de desenvolvimento local

Para usar o conjunto de bibliotecas Google.Cloud.Diagnostics em um ambiente de desenvolvimento local, como executar a biblioteca na sua estação de trabalho, forneça ao conjunto de bibliotecas Google.Cloud.Diagnostics as credenciais padrão do aplicativo local. Para mais informações, consulte Autenticar no Error Reporting.

Para usar os exemplos .NET desta página em um ambiente de desenvolvimento local, instale e inicialize o gcloud CLI e e configure o Application Default Credentials com suas credenciais de usuário.

1. Install the Google Cloud CLI.

2. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

3. To initialize the gcloud CLI, run the following command:

   gcloud init

4. If you're using a local shell, then create local authentication credentials for your user account:

   gcloud auth application-default login

   You don't need to do this if you're using Cloud Shell.

   If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.

Confira mais informações em Set up authentication for a local development environment.

O projects.events.report método 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. Confira mais informações em Crie uma chave de API na Google Cloud documentação de autenticação.

Como visualizar relatórios de erros

No console 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.

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