Raccogliere i dati sugli errori utilizzando Error Reporting

Puoi inviare eccezioni dell'applicazione ed eventi di errore a Error Reporting in modo che possa analizzare i dati sugli errori nel tuo progettoGoogle Cloud . A seconda dell'ambiente di calcolo, del linguaggio di programmazione e dei requisiti di autenticazione, puoi raccogliere i dati sugli errori nei seguenti modi:

  • Raccolta automatica dei log: gli ambienti di calcolo supportati inviano automaticamente i dati sugli errori a Cloud Logging per l'analisi di Error Reporting. Ad esempio, Cloud Run invia automaticamente le eccezioni scritte in stderr a Logging.
  • Librerie client: puoi instrumentare il codice dell'applicazione con librerie client specifiche per la lingua per inviare report sugli errori direttamente dalla tua app.
  • API REST: puoi chiamare l'API Error Reporting o l'API Cloud Logging per scrivere eventi di errore e stack trace formattati, anche quando è richiesta l'autenticazione con chiave API.

Quando Error Reporting analizza le voci di log

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

  • Assured Workloads è disabilitato. Per saperne di più, consulta 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ò memorizzare le voci di log nei bucket di log in cui è abilitata CMEK. Per informazioni su come determinare la configurazione CMEK per un bucket di log, consulta Verificare l'attivazione della chiave.
  • Il bucket di log soddisfa una delle seguenti condizioni:
    • Il bucket di log è 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 dei Controlli di servizio VPC

Controlli di servizio VPC supporta Error Reporting.

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 perimetro di servizio, consulta la documentazione dei 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 inviare report sugli errori, consulta le guide alla configurazione specifiche per la lingua:

Scrivere dati sugli errori utilizzando un'API

Puoi segnalare gli eventi di errore al tuo progetto Google Cloud eseguendo il metodo API Error Reporting report o il metodo API 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 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 sostenere costi di importazione di Logging. Per controllare quali voci di log vengono importate, consulta Filtri di esclusione.

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