L'API Error Reporting fornisce:
- Un semplice endpoint per segnalare gli errori del servizio in esecuzione.
- Accesso in lettura ai gruppi di errori e agli errori associati.
Per iniziare
Abilita l'API Error Reporting.
Ruoli richiesti per abilitare le API
Per abilitare le API, devi disporre del ruolo IAM Amministratore di Service Usage (roles/serviceusage.serviceUsageAdmin), che
contiene l'autorizzazione serviceusage.services.enable. Scopri come concedere
i ruoli.
Autorizzare l'utilizzo dell'API
L'accesso all'API Error Reporting è controllato da ruoli e autorizzazioni di Identity and Access Management. Puoi scoprire di più sull'autenticazione e l'autorizzazione per le Google Cloud API nella guida all'autenticazione.
Modello dei dati
L'API Error Reporting definisce tre entità: eventi di errore, gruppi di errori e statistiche dei gruppi di errori. L'oggetto delle statistiche dei gruppi di errori è quello con cui la maggior parte degli utenti interagisce più spesso.
Eventi di errore
Un ErrorEvent rappresenta una singola occorrenza di un errore nella tua applicazione. L'oggetto contiene informazioni sull'errore, come l'ora in cui si è verificato, il contesto in cui si è verificato e il messaggio di errore restituito. È garantito che un evento di errore sia disponibile per almeno 30 giorni dopo la generazione.
Gruppi di errori
ErrorGroup oggetti sono raccolte di eventi di errore raggruppati logicamente. Il raggruppamento si basa sulle informazioni nell'analisi dello stack dell'evento di errore. Un gruppo di errori è un oggetto semplice che contiene solo il nome, l'ID del gruppo e gli eventuali problemi di monitoraggio associati al gruppo.
Per aggiornare gli URL dei problemi di monitoraggio, utilizza il metodo update di questa risorsa.
Statistiche dei gruppi di errori
ErrorGroupStats oggetti contengono informazioni dettagliate su un gruppo di errori e sono gli oggetti API con cui interagisci più spesso. Le informazioni nell'oggetto groupStats includono la prima e l'ultima volta in cui si è verificato un evento di errore in questo gruppo, il conteggio, il numero di utenti interessati e altro ancora. Questo oggetto è utile per creare widget e dashboard personalizzate.
Operazioni
L'API Error Reporting supporta le seguenti operazioni:
- Segnala un nuovo evento di errore
- Elenca le statistiche dei gruppi di errori
- Elenca eventi di errore
- Ottieni gruppi di errori
- Aggiorna i problemi di monitoraggio di un gruppo di errori
Segnala eventi di errore
Puoi segnalare gli eventi di errore dei servizi in esecuzione scrivendoli in ReportedErrorEvent. In questo modo vengono generati messaggi di errore formattati correttamente in Cloud Logging. Il nome del log risultante è formattato come projects/<PROJECT_ID>/clouderrorreporting.googleapis.com%2Freported_errors. Potresti sostenere costi minimi di importazione di Cloud Logging utilizzando questo metodo. Per controllare questi costi, consulta Esclusioni dei log.
Puoi anche segnalare nuovi eventi di errore a Error Reporting assemblando le entità degli eventi di errore dal servizio in esecuzione e inviandole al metodo events.report.
Elenca le statistiche dei gruppi di errori
Per ottenere un elenco delle statistiche dei gruppi di errori, invia una richiesta al metodo groupStats.list. Puoi passare uno o più parametri di query per filtrare le statistiche dei gruppi restituite.
Elenca eventi di errore
Per ottenere un elenco degli eventi di errore appartenenti a un gruppo di errori specifico, invia una richiesta al metodo events.list. Puoi passare una condizione di filtro a queste richieste per recuperare solo gli eventi di errore che si sono verificati tra un'ora di inizio e di fine specifica o quelli che corrispondono a contesti di servizio specifici.
Ottieni gruppi di errori
Per recuperare una risorsa di gruppo di errori specifica, invia una richiesta al groups.get metodo.
Aggiorna i gruppi di errori
Per aggiornare gli URL dei problemi di monitoraggio associati a un gruppo di errori, invia una risorsa ErrorGroup aggiornata al metodo groups.update.