Instrumentar apps C# para o Error Reporting

É possível enviar eventos de erro para o Error Reporting a partir de aplicativos C# usando o conjunto de bibliotecas do Google.Cloud.Diagnostics . Use o conjunto de bibliotecas do 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 um dos seguintes requisitos:
  • O bucket de registros é armazenado no mesmo projeto em que as entradas de registro foram originadas.
  • As entradas de registro foram encaminhadas para um projeto, e esse projeto armazenou essas entradas de registro 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 Run Functions e o App Engine, o Compute Engine e o Google Kubernetes Engine. Error Reporting exibe os eventos de erro 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 eventos de erro para o Error Reporting usando o Logging. Para informações sobre os requisitos de formatação de dados, leia Formatar uma entrada de registro para informar eventos de erro.

Antes de começar

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

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

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

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

Verify that billing is enabled for your Google Cloud project.

Enable the Error Reporting API .

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

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

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

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

Verify that billing is enabled for your Google Cloud project.

Enable the Error Reporting API .

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

Instale a biblioteca de cliente

O conjunto de bibliotecas do Google.Cloud.Diagnostics permite monitorar e visualizar eventos de erro relatados por aplicativos C# executados em praticamente qualquer lugar.

1. Para aplicativos direcionados ao ASP.NET Core 3 ou posterior, use a Google.Cloud.Diagnostics.AspNetCore3 biblioteca. Você pode instalar essa biblioteca em NuGet.
2. Para aplicativos voltados a versões anteriores do ASP.NET Core, use a Google.Cloud.Diagnostics.AspNetCore biblioteca. 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:

Google.Cloud.Diagnostics.AspNetCore3 documentação

Google.Cloud.Diagnostics.AspNetCore documentação

Google.Cloud.Diagnostics.Common documentação

Executar apps no Google Cloud

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

Alguns Google Cloud serviços concedem automaticamente o papel Gravador do Error Reporting (roles/errorreporting.writer) à conta de serviço apropriada. No entanto, é necessário conceder esse papel à conta de serviço apropriada 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 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 serão exibidas no Logging e processadas pelo Error Reporting sem a necessidade de usar o conjunto de bibliotecas do Google.Cloud.Diagnostics .

Observação: o Error Reporting cria automaticamente um evento de erro quando uma entrada de registro contém um stack trace e o nível de gravidade da entrada de registro não está definido ou está definido como ERROR ou superior.

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 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 no console.Google Cloud

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 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 cloud-platform escopo de acesso.

   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
   

**Observação**: depois de criar um cluster, não é possível mudar 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 saber mais sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

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

   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 você quer receber o cloud-platform escopo de acesso.

4. Clique em Parar e depois 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 total a todas as APIs do Cloud e salve as alterações.

7. Clique em Iniciar/retomar.

Exemplo

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

Executar apps em um ambiente de desenvolvimento local

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

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

1. Instale a Google Cloud CLI.

2. Ao usar um provedor de identidade (IdP) externo, primeiro faça login na CLI gcloud com sua identidade federada.

3. Se você estiver usando um shell local, crie credenciais de autenticação local para sua conta de usuário:

   gcloud auth application-default login

   Não é necessário fazer isso se você estiver usando o Cloud Shell.

   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 e bibliotecas de cliente poderão não funcionar. Solicite a um administrador que conceda a você o 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

   Se um erro de autenticação for retornado e você estiver usando um provedor de identidade (IdP) externo, confirme se você fez login na CLI gcloud com sua identidade federada.

Para mais informações, consulte 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. Para mais informações, consulte Criar uma chave de API na documentação de autenticação do Google Cloud .

Ver grupos de erros

Noconsole, acesse a página Error Reporting : Google Cloud

Acessar o Error Reporting

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

Para mais informações, consulte Visualizar e filtrar grupos de erros.