Strumentare le app Python per Error Reporting

Puoi inviare report sugli errori a Error Reporting dalle applicazioni Python utilizzando la libreria Error Reporting per Python. Utilizza la libreria Error Reporting per Python per creare gruppi di errori per i seguenti casi:

• Un bucket dei log che contiene le voci di log contiene chiavi di crittografia gestite dal cliente (CMEK).
• Il bucket dei log soddisfa una delle seguenti condizioni:
  • Il bucket dei 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à.
• Vuoi segnalare eventi di errore personalizzati.

Error Reporting è integrato con alcuni servizi Google Cloud, come Cloud Functions, App Engine, Compute Engine e Google Kubernetes Engine. Error Reporting mostra gli errori registrati in Cloud Logging dalle applicazioni in esecuzione su questi servizi. Per ulteriori informazioni, vai a 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. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Error Reporting API .

   Enable the API

5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

6. Make sure that billing is enabled for your Google Cloud project.

7. Enable the Error Reporting API .

   Enable the API

8. Prepara l'ambiente per lo sviluppo Python.

   Vai alla guida alla configurazione di Python

installa la libreria client

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

1. Istantia 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

   Per autenticarti in Error Reporting, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.

   #!/usr/bin/env python
   #
   # Copyright 2022 Google, Inc.
   #
   # Licensed under the Apache License, Version 2.0 (the "License");
   # you may not use this file except in compliance with the License.
   # You may obtain a copy of the License at
   #
   #    http://www.apache.org/licenses/LICENSE-2.0
   #
   # Unless required by applicable law or agreed to in writing, software
   # distributed under the License is distributed on an "AS IS" BASIS,
   # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   # See the License for the specific language governing permissions and
   # limitations under the License.
   
   
   def report_exception():
       from google.cloud import error_reporting
   
       client = error_reporting.Client()
       try:
           raise Exception("Something went wrong")
       except Exception:
           client.report_exception()
   
   
   
   
   def report_manual_error():
       from google.cloud import error_reporting
   
       client = error_reporting.Client()
       client.report("An error has occurred.")
   
   
   
   
   if __name__ == "__main__":
       report_exception()
       report_manual_error()
   

Per saperne di più sull'installazione, leggi la documentazione della libreria di generazione di Error Reporting per Python. Puoi anche segnalare i problemi utilizzando il tracker dei problemi.

Configura la libreria client

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

Esegui app su Google Cloud

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

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

Cloud Run e funzioni Cloud Run

L'account di servizio predefinito utilizzato da Cloud Run dispone delle autorizzazioni del ruolo Scrittore di segnalazioni di errori (roles/errorreporting.writer).

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

Cloud Run è configurato per utilizzare automaticamente Error Reporting. Le eccezioni JavaScript non gestite verranno visualizzate in Logging ed elaborate da Error Reporting senza dover utilizzare la libreria Error Reporting per Python.

Nota: le voci di log vengono elaborate automaticamente se contengono una analisi dello stack e non specificano alcuna gravità del log o una gravità del log di almeno ERROR, senza dover utilizzare la libreria di Error Reporting per Python.

Ambiente flessibile di App Engine

App Engine concede automaticamente il ruolo Writer per i report sugli errori (roles/errorreporting.writer) al tuo account di servizio predefinito.

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

Error Reporting è abilitato automaticamente per le applicazioni dell'ambiente flessibile di App Engine. Non è richiesta alcuna configurazione aggiuntiva.

Nota: le voci di log degli errori scritte in stderr vengono elaborate automaticamente da Error Reporting, senza dover utilizzare direttamente la libreria Error Reporting per Python.

Google Kubernetes Engine

Per utilizzare Error Reporting con Google Kubernetes Engine:

1. Assicurati che all'account di servizio da utilizzare per il contenitore sia stato assegnato il ruolo Writer per i report sugli errori (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 il cloud-platform ambito di accesso.

   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
   

Nota: dopo aver creato un cluster, non puoi modificare il relativo account di servizio.

Compute Engine

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

1. Assicurati che all'account di servizio da utilizzare per l'istanza VM sia stato assegnato il ruolo Scrittore di segnalazioni di errori (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, vai alla pagina Istanze VM:

   Vai a Istanze VM

   Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Compute Engine.

3. Seleziona l'istanza VM a cui vuoi assegnare il ambito di accessocloud-platform.

4. Fai clic su Interrompi e poi su Modifica.

5. Nella sezione Identità e accesso API, seleziona un account di servizio che abbia il ruolo Scrittore di segnalazioni di errori (roles/errorreporting.writer).

6. Nella sezione Ambiti di accesso, seleziona Consenti l'accesso completo a tutte le API Cloud e poi salva le modifiche.

7. Fai clic su Avvia/Riprendi.

Esempio

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

Python

Per autenticarti in Error Reporting, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configurare l'autenticazione.

#!/usr/bin/env python
#
# Copyright 2022 Google, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.


def report_exception():
    from google.cloud import error_reporting

    client = error_reporting.Client()
    try:
        raise Exception("Something went wrong")
    except Exception:
        client.report_exception()




def report_manual_error():
    from google.cloud import error_reporting

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




if __name__ == "__main__":
    report_exception()
    report_manual_error()

Eseguire app in un ambiente di sviluppo locale

Per utilizzare la libreria Error Reporting per Python in un ambiente di sviluppo locale, come l'esecuzione della libreria sulla tua workstation, devi fornire alla libreria Error Reporting per Python le credenziali predefinite dell'applicazione locale. Per ulteriori informazioni, consulta Eseguire l'autenticazione in Error Reporting.

Per utilizzare gli Python esempi in questa pagina in un ambiente di sviluppo locale, installa e inizializza l'interfaccia alla gcloud CLI, quindi configura le Credenziali predefinite dell'applicazione con le tue credenziali utente.

1. Install the Google Cloud CLI.

2. To initialize the gcloud CLI, run the following command:

   gcloud init

3. If you're using a local shell, then create local authentication credentials for your user account:

   gcloud auth application-default login

   You don't need to do this if you're using Cloud Shell.

   Note: If the gcloud CLI prints a warning that your account doesn't have the serviceusage.services.use permission, then some gcloud CLI commands and client libraries might not work. Ask an administrator to grant you the Service Usage Consumer IAM role (roles/serviceusage.serviceUsageConsumer), then run the following command:

   gcloud auth application-default set-quota-project PROJECT_ID

Per ulteriori informazioni, consulta Set up authentication for a local development environment.

Anche il metodo projects.events.report supporta le chiavi API. Se vuoi utilizzare le chiavi API per l'autenticazione, non è necessario configurare un file Credenziali predefinite dell'applicazione locale. Per ulteriori informazioni, consulta Crea una chiave API nella documentazione sull'autenticazione di Google Cloud.

Visualizzazione dei rapporti degli errori

Nella console Google Cloud, vai alla pagina Error Reporting:

Vai a Error Reporting

Puoi trovare questa pagina anche utilizzando la barra di ricerca.

Per ulteriori informazioni, consulta la sezione Visualizzare gli errori.