Configurazione di Error Reporting per Python

Mantieni tutto organizzato con le raccolte Salva e classifica i contenuti in base alle tue preferenze.

Puoi inviare report sugli errori alle applicazioni di Error Reporting utilizzando applicazioni Python utilizzando la libreria di Error Reporting per Python.

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 tali servizi. Per ulteriori informazioni, consulta la pagina In esecuzione su Google Cloud Platform in questa pagina.

Puoi anche inviare i dati di errore 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 dei progetti in Google Cloud Console, seleziona o crea un progetto Google Cloud.

    Vai al selettore progetti

  3. Assicurati che la fatturazione sia attivata per il tuo progetto Cloud. Scopri come verificare se la fatturazione è abilitata su un progetto.

  4. Attiva Error Reporting API .

    Abilita l'API

  5. Nella pagina del selettore dei progetti in Google Cloud Console, seleziona o crea un progetto Google Cloud.

    Vai al selettore progetti

  6. Assicurati che la fatturazione sia attivata per il tuo progetto Cloud. Scopri come verificare se la fatturazione è abilitata su un progetto.

  7. Attiva Error Reporting API .

    Abilita l'API

  8. Prepara l'ambiente per lo sviluppo Python.

    Vai alla guida alla configurazione di Python

Installare la libreria client

La libreria di Error Reporting per Python consente di monitorare e visualizzare gli errori segnalati dalle applicazioni Python in esecuzione quasi ovunque.

  1. Crea un'istanza di un ambiente virtuale e utilizza pip per installare il pacchetto:

    pip install google-cloud-error-reporting --upgrade
    
  2. Importa la libreria e crea un'istanza di un client per iniziare a segnalare gli errori:

    Python

    def simulate_error():
        from google.cloud import error_reporting
    
        client = error_reporting.Client()
        try:
            # simulate calling a method that's not defined
            raise NameError
        except Exception:
            client.report_exception()

Per ulteriori informazioni sull'installazione, consulta la documentazione per la libreria di Error Reporting per Python. Puoi anche segnalare i problemi utilizzando lo strumento di monitoraggio dei problemi.

Configurazione della libreria client

Puoi personalizzare il comportamento della libreria di Error Reporting per Python. Consulta la documentazione relativa alla libreria client per consultare esempi di configurazione.

Segnalare errori

Puoi segnalare manualmente un errore chiamando il metodo report, come mostrato nell'esempio seguente:

Python

def report_manual_error():
    from google.cloud import error_reporting

    client = error_reporting.Client()
    client.report("An error has occurred.")

if __name__ == '__main__':
    simulate_error()
    report_manual_error()

Esecuzione in Google Cloud

Per utilizzare la libreria Error Reporting per Python, è necessario il ruolo Writer Error Reporting Identity and Access Management. La maggior parte delle piattaforme di computing Google Cloud fornisce questo ruolo per impostazione predefinita.

Puoi configurare Error Reporting per Python nei seguenti ambienti Google Cloud.

Ambiente flessibile di App Engine

App Engine concede per impostazione predefinita il ruolo Writer Error Reporting.

La libreria di Error Reporting per Python può essere utilizzata senza dover fornire esplicitamente le credenziali.

Error Reporting viene abilitato automaticamente per le applicazioni dell'ambiente flessibile di App Engine. Non sono richieste configurazioni aggiuntive.

Google Kubernetes Engine

Su GKE, devi aggiungere l'ambito di accesso cloud-platform quando crei il cluster, come mostra il seguente comando di esempio:

gcloud container clusters create example-cluster-name --scopes https://www.googleapis.com/auth/cloud-platform

Compute Engine

Quando utilizzi le istanze VM di Compute Engine, aggiungi l'ambito di accesso cloud-platform a ciascuna istanza. Quando crei una nuova istanza tramite la console Google Cloud, puoi farlo nella sezione Identità e accesso API del riquadro Crea istanza. Utilizza l'account di servizio predefinito di Compute Engine o un altro account di servizio a tua scelta e seleziona Consenti accesso completo a tutte le API Cloud nella sezione Identità e accesso API. Qualunque sia l'account di servizio selezionato, assicurati che sia stato concesso il ruolo Writer Error Reporting nella sezione IAM e amministrazione della console Google Cloud.

Esecuzione locale e altrove

Per utilizzare la libreria di Error Reporting per Python al di fuori di Google Cloud, ad esempio per eseguire la libreria sulla tua workstation, sui computer dei data center o sulle istanze VM di un altro cloud provider, devi fornire il tuo ID progetto Google Cloud e le credenziali dell'account di servizio appropriato direttamente alla libreria di Error Reporting per Python.

Puoi creare e ottenere manualmente le credenziali dell'account di servizio. Quando specifichi il campo Ruolo, utilizza il ruolo Writer Error Reporting. Per saperne di più sui ruoli di Identity and Access Management, vai alla guida al controllo dell'accesso.

Visualizzazione dei rapporti degli errori

Dopo il deployment, puoi visualizzare i report sugli errori nella dashboard di Error Reporting di Google Cloud Console.

Vai alla dashboard di Error Reporting

Per ulteriori informazioni, consulta la sezione Visualizzare gli errori.