Eseguire il monitoraggio delle app C# per Error Reporting

Puoi inviare eventi di errore a Error Reporting dalle applicazioni C# utilizzando il set di librerie Google.Cloud.Diagnostics . Utilizza il set di librerie Google.Cloud.Diagnostics per creare gruppi di errori nei seguenti casi:

• Un bucket di log che contiene le voci di log ha chiavi di crittografia gestite dal cliente (CMEK).
• Il bucket di log soddisfa una delle seguenti condizioni:
  • Il bucket di log è archiviato nello stesso progetto in cui sono state create le voci di log.
  • Le voci di log sono state instradate a un progetto, che le ha archiviate in un bucket di log di sua proprietà.
• Vuoi segnalare eventi di errore personalizzati.

Error Reporting è integrato con alcuni Google Cloud servizi, come Cloud Run Functions e App Engine, Compute Engine e Google Kubernetes Engine. Error Reporting mostra gli eventi di errore registrati in Cloud Logging dalle applicazioni in esecuzione su questi servizi. Per saperne di più, vai a Esecuzione su Google Cloud in questa pagina.

Puoi anche inviare eventi di errore a Error Reporting utilizzando Logging. Per informazioni sui requisiti di formattazione dei dati, consulta Formattare una voce di log per segnalare eventi di errore.

Prima di iniziare

Accedi al tuo Google Cloud account. Se non conosci Google Cloud, crea un account per valutare le prestazioni dei nostri prodotti in scenari reali. I nuovi clienti ricevono anche 300 $di crediti senza costi per l'esecuzione, il test e il deployment dei workload.

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

Installa la libreria client

Il set di librerie Google.Cloud.Diagnostics consente di monitorare e visualizzare gli eventi di errore segnalati dalle applicazioni C# in esecuzione praticamente ovunque.

1. Per le applicazioni che hanno come target ASP.NET Core 3 o versioni successive, utilizza la Google.Cloud.Diagnostics.AspNetCore3 libreria. Puoi installare questa libreria da NuGet.
2. Per le applicazioni che hanno come target versioni precedenti di ASP.NET Core, utilizza la Google.Cloud.Diagnostics.AspNetCore libreria. Puoi installare questa libreria da NuGet.
3. Per le applicazioni che hanno come target framework non ASP.NET Core, utilizza la Google.Cloud.Diagnostics.Common libreria. Puoi installare questa libreria da NuGet.

Per saperne di più sull'installazione, consulta la documentazione del set di librerie Google.Cloud.Diagnostics . Puoi anche segnalare i problemi utilizzando il tracker dei problemi.

Configura la libreria client

Per ulteriori informazioni ed esempi, consulta le seguenti risorse:

Google.Cloud.Diagnostics.AspNetCore3 documentazione

Google.Cloud.Diagnostics.AspNetCore documentazione

Google.Cloud.Diagnostics.Common documentazione

Esegui app su Google Cloud

Per creare gruppi di errori utilizzando projects.events.report, il tuo account di servizio deve avere il ruolo Writer di Error Reporting (roles/errorreporting.writer).

Alcuni Google Cloud servizi concedono automaticamente il ruolo Writer di Error Reporting (roles/errorreporting.writer) al account di servizio appropriato. Tuttavia, per alcuni servizi devi concedere questo ruolo al service account appropriato.

Cloud Run e Cloud Run Functions

Il account di servizio predefinito utilizzato da Cloud Run dispone delle autorizzazioni del ruolo Writer di Error Reporting (roles/errorreporting.writer).

Il set di librerie Google.Cloud.Diagnostics può essere utilizzato senza dover fornire esplicitamente le credenziali.

Cloud Run è configurato per utilizzare Error Reporting automaticamente. Le eccezioni JavaScript non gestite verranno visualizzate in Logging ed elaborate da Error Reporting senza dover utilizzare il set di librerie Google.Cloud.Diagnostics.

Nota: Error Reporting crea automaticamente un evento di errore quando una voce di log contiene un'analisi dello stack e il livello di gravità della voce di log non è impostato o è impostato su almeno ERROR.

Ambiente flessibile di App Engine

App Engine concede automaticamente il ruolo Writer di Error Reporting (roles/errorreporting.writer) al tuo account di servizio predefinito.

Il set di librerie Google.Cloud.Diagnostics può essere utilizzato senza dover fornire esplicitamente le credenziali.

Error Reporting è abilitato automaticamente per le applicazioni dell'ambiente flessibile di App Engine. Non è richiesta nessuna ulteriore configurazione. I messaggi scritti da App Engine a stderr vengono analizzati e, se contengono un'analisi dello stack, vengono visualizzati da Error Reporting.

Consulta Visualizzare gli errori per istruzioni su come visualizzare i dati di errori ed eccezioni per la tua applicazione nella Google Cloud console.

Google Kubernetes Engine

Per utilizzare Error Reporting con Google Kubernetes Engine:

1. Assicurati che al account di servizio da utilizzare per il container sia stato concesso il ruolo Writer di Error Reporting (roles/errorreporting.writer).

   Puoi utilizzare il service account predefinito di Compute Engine o un account di servizio personalizzato.

   Per saperne di più sulla concessione dei ruoli, consulta Gestisci l'accesso a progetti, cartelle e organizzazioni.

2. Crea il cluster e concedi al cluster l' cloud-platform ambito di accesso.

   Ad esempio, il seguente comando create specifica l'ambito di accesso cloud-platform e un account di servizio:

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

Nota: dopo aver creato un cluster, non puoi modificarne il service account.

Compute Engine

Per utilizzare Error Reporting con le istanze VM di Compute Engine:

1. Assicurati che al account di servizio da utilizzare per l'istanza VM sia stato concesso il ruolo Writer di Error Reporting (roles/errorreporting.writer).

   Puoi utilizzare il service account predefinito di Compute Engine o un account di servizio personalizzato.

   Per saperne di più sulla concessione dei ruoli, consulta Gestisci l'accesso a progetti, cartelle e organizzazioni.

2. Nella Google Cloud console, vai alla pagina Istanze VM.

   Vai a Istanze VM

   Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Compute Engine.

3. Seleziona l'istanza VM a cui vuoi concedere l' cloud-platform ambito di accesso.

4. Fai clic su Arresta, quindi su Modifica.

5. Nella sezione Identità e accesso API, seleziona un account di servizio con il ruolo Writer di Error Reporting (roles/errorreporting.writer).

6. Nella sezione Ambiti di accesso, seleziona Consenti l'accesso completo a tutte le API Cloud, quindi salva le modifiche.

7. Fai clic su Avvia/Riprendi.

Esempio

Per ulteriori informazioni ed esempi, consulta le seguenti risorse:

Google.Cloud.Diagnostics.AspNetCore3 documentazione

Google.Cloud.Diagnostics.AspNetCore documentazione

Google.Cloud.Diagnostics.Common documentazione

Esegui app in un ambiente di sviluppo locale

Per utilizzare il set di librerie Google.Cloud.Diagnostics in un ambiente di sviluppo locale, ad esempio eseguendo la libreria sulla tua workstation, devi fornire al set di librerie Google.Cloud.Diagnostics le credenziali predefinite dell'applicazione locale. Per saperne di più, consulta Autenticarsi a Error Reporting.

Per utilizzare gli esempi .NET in questa pagina in un ambiente di sviluppo locale, installa e inizializza gcloud CLI, quindi configura Credenziali predefinite dell'applicazione con le tue credenziali utente.

1. Installa Google Cloud CLI.

2. Se utilizzi un provider di identità (IdP) esterno, devi prima accedere a gcloud CLI con la tua identità federata.

3. Se utilizzi una shell locale, crea le credenziali di autenticazione locali per il tuo account utente:

   gcloud auth application-default login

   Non devi eseguire questa operazione se utilizzi Cloud Shell.

   Nota: se gcloud CLI stampa un avviso che indica che il tuo account non dispone dell'autorizzazione serviceusage.services.use, alcuni comandi gcloud CLI e librerie client potrebbero non funzionare. Chiedi a un amministratore di concederti il ruolo IAM Consumer di Service Usage (roles/serviceusage.serviceUsageConsumer), quindi esegui questo comando:

   gcloud auth application-default set-quota-project PROJECT_ID

   Se viene restituito un errore di autenticazione e utilizzi un provider di identità (IdP) esterno, verifica di aver acceduto a gcloud CLI con la tua identità federata.

Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.

Il metodo projects.events.report supporta anche le chiavi API. Se vuoi utilizzare le chiavi API per l'autenticazione, non devi configurare un file di Credenziali predefinite dell'applicazione locale. Per saperne di più, consulta Crea una chiave API nella Google Cloud documentazione sull'autenticazione di.

Visualizza i gruppi di errori

Nella Google Cloud console, vai alla pagina Error Reporting.

Vai a Error Reporting

Puoi trovare questa pagina anche utilizzando la barra di ricerca.

Per saperne di più, consulta Visualizzare e filtrare i gruppi di errori.