Raccogliere i dati sugli errori utilizzando Error Reporting

Questo documento elenca gli ambienti supportati da Error Reporting e fornisce link a guide specifiche per lingua per gli sviluppatori di applicazioni. Ti consigliamo di utilizzare le librerie client specifiche per la lingua o di fare affidamento sulle voci di log raccolte automaticamente. Tuttavia, puoi scrivere dati di errore con l'API Cloud Logging o l'API Error Reporting. Ad esempio, se utilizzi Cloud Run, le eccezioni scritte in stderr vengono inviate automaticamente a Cloud Logging.

Error Reporting è un servizio globale basato su Cloud Logging e può analizzare le voci di log quando sono vere tutte le seguenti condizioni:

  • I workload Assured Workloads sono disabilitati. Per saperne di più, consulta la panoramica di Assured Workloads.
  • Le chiavi di crittografia gestite dal cliente (CMEK) sono disattivate in tutti i bucket di log che archiviano la voce di log. Error Reporting non può archiviare le voci di log nei bucket di log in cui è abilitata CMEK. Per informazioni su come determinare la configurazione CMEK per un bucket log, vedi Verificare l'attivazione della chiave.
  • Il bucket di log soddisfa una delle seguenti condizioni:
    • Il bucket di log viene archiviato nello stesso progetto in cui hanno avuto origine 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à.

Supporto di Virtual Private Cloud

Error Reporting è un servizio supportato da Virtual Private Cloud (VPC).

Per ridurre il rischio di esfiltrazione di dati, utilizza i Controlli di servizio VPC per creare un perimetro di servizio attorno ai servizi gestiti da Google. Per informazioni sui Controlli di servizio VPC e su come creare un parametro di servizio, consulta la documentazione sui Controlli di servizio VPC.

Configurare gli ambienti per segnalare automaticamente i dati sugli errori

Per informazioni sui requisiti di configurazione specifici per l'ambiente, consulta le seguenti guide:

Strumentare le app utilizzando le librerie client

Per informazioni su come configurare l'applicazione per l'invio di report sugli errori, consulta le guide alla configurazione specifiche per la lingua:

Scrivere dati di errore utilizzando un'API

Puoi segnalare gli eventi di errore al tuo progetto Google Cloud eseguendo il metodo dell'API Error Reporting report o il metodo dell'API Cloud Logging write.

  • Se richiedi l'autenticazione basata su chiave API, devi utilizzare l'API Error Reporting. Per segnalare un evento di errore utilizzando l'API Error Reporting, esegui il metodo report e formatta il corpo della richiesta del metodo come oggetto ReportedErrorEvent.

    Quando utilizzi l'API Error Reporting, le voci di log con messaggi di errore formattati correttamente vengono generate e scritte automaticamente in Cloud Logging. Queste voci di log vengono scritte in un log il cui logName è formattato come segue:

    projects/PROJECT_ID/clouderrorreporting.googleapis.com%2Freported_errors
    

    Poiché le voci di log vengono generate dalle chiamate a report, potresti incorrere in costi di importazione di Cloud Logging. Per controllare quali voci di log vengono importate, consulta Filtri di esclusione.

    Se segnali gli eventi di errore utilizzando l'API Error Reporting, il resto di questo documento non si applica.

  • Se vuoi utilizzare l'API Cloud Logging, devi formattare l'oggetto LogEntry in modo che includa una analisi dello stack o un oggetto ReportedErrorEvent. Per maggiori informazioni sui requisiti di formattazione, consulta Errori di formato nei log.