Integra le app C# per Error Reporting

Puoi inviare report sugli errori a Error Reporting dalle applicazioni C# utilizzando l' insieme di librerie Google.Cloud.Diagnostica . Utilizza il set di librerie Google.Cloud.Diagnostica per creare gruppi di errori per i seguenti casi:

  • Il bucket di log ha chiavi di crittografia gestite dal cliente (CMEK).
  • I bucket di log non si trovano nella regione global.
  • Vuoi segnalare eventi di errore personalizzati.

Error Reporting è integrato con alcuni servizi Google Cloud, come App Engine, Compute Engine e Google Kubernetes Engine. Error Reporting visualizza gli errori registrati in Cloud Logging dalle applicazioni in esecuzione su questi servizi. Per ulteriori informazioni, vai ad In esecuzione su Google Cloud in questa pagina.

Puoi anche inviare i dati sugli errori a Error Reporting utilizzando Logging. Per informazioni sui requisiti di formattazione dei dati, consulta Formattazione dei messaggi di errore in Logging.

Prima di iniziare

  1. Accedi al tuo account Google Cloud. 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 gratuiti per l'esecuzione, il test e il deployment dei carichi di lavoro.
  2. Nella pagina del selettore di progetti della console Google Cloud, seleziona o crea un progetto Google Cloud.

    Vai al selettore progetti

  3. Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.

  4. Attiva Error Reporting API .

    Abilita l'API

  5. Nella pagina del selettore di progetti della console Google Cloud, seleziona o crea un progetto Google Cloud.

    Vai al selettore progetti

  6. Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.

  7. Attiva Error Reporting API .

    Abilita l'API

Installa la libreria client

L'insieme di librerie Google.Cloud.Diagnostica consente di monitorare e visualizzare gli errori segnalati dalle applicazioni C# in esecuzione praticamente ovunque.

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

Per ulteriori informazioni sull'installazione, consulta la documentazione relativa al set di librerie Google.Cloud.Diagnostica. Puoi anche segnalare i problemi utilizzando lo strumento Issue Tracker.

Configura la libreria client

Per ulteriori informazioni ed esempi, consulta le seguenti risorse:

  • Documentazione Google.Cloud.Diagnostics.AspNetCore3
  • Documentazione Google.Cloud.Diagnostics.AspNetCore
  • Documentazione Google.Cloud.Diagnostics.Common
  • Esegui app su Google Cloud

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

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

    Ambiente flessibile di App Engine

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

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

    Error Reporting viene abilitato automaticamente per le applicazioni dell'ambiente flessibile di App Engine. Non è richiesta alcuna ulteriore configurazione. I messaggi scritti da App Engine in stderr vengono analizzati e, se vengono rilevati contenuti di analisi dello stack, vengono visualizzati da Error Reporting.

    Per istruzioni sulla visualizzazione dei dati di errori ed eccezioni per la tua applicazione nella console Google Cloud, consulta Visualizzazione degli errori.

    Google Kubernetes Engine

    Per utilizzare Error Reporting con Google Kubernetes Engine:

    1. Assicurati che all'account di servizio che deve essere utilizzato dal container sia stato concesso il ruolo Writer Error Reporting (roles/errorreporting.writer).

      Puoi utilizzare l'account di servizio predefinito di Compute Engine o un account di servizio personalizzato.

      Per informazioni sulla concessione dei ruoli, consulta Gestire l'accesso a progetti, cartelle e organizzazioni.

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

      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
      

    Compute Engine

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

    1. Assicurati che all'account di servizio che deve essere utilizzato dall'istanza VM sia stato concesso il ruolo Writer Error Reporting (roles/errorreporting.writer).

      Puoi utilizzare l'account di servizio predefinito di Compute Engine o un account di servizio personalizzato.

      Per informazioni sulla concessione dei ruoli, consulta Gestire l'accesso a progetti, cartelle e organizzazioni.

    2. Nella console Google Cloud, seleziona Compute Engine e poi Istanze VM, oppure fai clic sul pulsante seguente:

      Vai a Istanze VM

    3. Seleziona l'istanza VM che vuoi ricevere l'ambito di accesso cloud-platform.

    4. Fai clic su Interrompi e poi su Modifica.

    5. Nella sezione Identità e accesso API, seleziona un account di servizio con il ruolo Writer 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:

  • Documentazione Google.Cloud.Diagnostics.AspNetCore3
  • Documentazione Google.Cloud.Diagnostics.AspNetCore
  • Documentazione Google.Cloud.Diagnostics.Common
  • Eseguire app in un ambiente di sviluppo locale

    Per utilizzare il set di librerie Google.Cloud.Diagnostica in un ambiente di sviluppo locale, ad esempio l'esecuzione della libreria sulla tua workstation, devi fornire al tuo set di librerie Google.Cloud.Diagnostica le credenziali predefinite dell'applicazione locale. Per ulteriori informazioni, vedi Eseguire l'autenticazione in Error Reporting.

    Per utilizzare gli esempi .NET in questa pagina da 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. Per initialize gcloud CLI, esegui questo comando:

      gcloud init
    3. Crea credenziali di autenticazione locali per il tuo Account Google:

      gcloud auth application-default login

    Per ulteriori informazioni, 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 è necessario configurare un file locale Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Crea una chiave API nella documentazione sull'autenticazione di Google Cloud.

    Visualizzazione dei rapporti degli errori

    Nella console Google Cloud, seleziona Error Reporting oppure fai clic sul pulsante seguente e seleziona un progetto:

    Vai a Error Reporting

    Per ulteriori informazioni, consulta la sezione Visualizzazione degli errori.