Configurazione di Cloud Logging per Python

Puoi scrivere log in Cloud Logging dalle applicazioni Python utilizzando il gestore di log Python standard o direttamente la libreria client dell'API Cloud Logging per Python. Quando utilizzi il gestore di log Python standard, devi collegare un gestore Cloud Logging al gestore principale di Python. Questo documento illustra questo approccio.

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.

    Go to project selector

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

  4. Enable the Cloud Logging API.

    Enable the API

    5.

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

    Go to project selector

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

  7. Enable the Cloud Logging API.

    Enable the API

    8.
  8. Prepara l'ambiente per lo sviluppo Python.

    Vai alla guida alla configurazione di Python

Installa la libreria

Per installare la libreria Cloud Logging per Python, consulta Installare la libreria client per Python. Questa libreria ti consente di collegare un gestore di Cloud Logging al gestore principale di Python standard. Puoi anche utilizzare questa libreria per inviare richieste API a Cloud Logging.

Per ulteriori informazioni sull'installazione, consulta la documentazione della libreria Cloud Logging per Python. Puoi anche segnalare i problemi utilizzando il tracker dei problemi.

Scrivere log con il gestore di log Python standard

Per inviare tutte le voci di log scritte con il gestore principale di Python standard a Cloud Logging:

  1. Collega il gestore di Cloud Logging al logger principale di Python chiamando il metodo setup_logging:

    # Imports the Cloud Logging client library
import google.cloud.logging

# Instantiates a client
client = google.cloud.logging.Client()

# Retrieves a Cloud Logging handler based on the environment
# you're running in and integrates the handler with the
# Python logging module. By default this captures all logs
# at INFO level and higher
client.setup_logging()

    Per informazioni su come configurare il gestore di log, consulta Integrazione con la libreria standard di logging.

    Per informazioni sui parametri della funzione setup_logging, vai a Cloud Logging Client e cerca setup_logging. Ad esempio, questa pagina descrive come configurare i livelli di logging.

  2. Scrivi i dati di log utilizzando il logger principale di Python:

    # Imports Python standard library logging
import logging

# The data to log
text = "Hello, world!"

# Emits the data using the standard logging module
logging.warning(text)

    Per impostazione predefinita, qualsiasi log il cui livello di gravità è almeno INFO e che viene scritto dalla tua applicazione viene inviato a Cloud Logging.

    Se i messaggi vengono registrati in Logging da App Engine o Google Kubernetes Engine, il gestore li invia ai rispettivi tipi di risorsa di questi ambienti. In caso contrario, i log vengono elencati nel log python nel tipo di risorsa Global.

Scrivere log con la libreria client di Cloud Logging

Per informazioni sull'utilizzo diretto della libreria client Cloud Logging per Python, consulta la sezione Librerie client Cloud Logging.

Esegui su Google Cloud

Affinché un'applicazione possa scrivere log utilizzando la libreria Cloud Logging per Python, l'account di servizio per la risorsa sottostante deve disporre del ruolo IAM Scrittore di log (roles/logging.logWriter). La maggior parte degli ambienti Google Cloud configura automaticamente l'account di servizio predefinito in modo che abbia questo ruolo.

App Engine

Cloud Logging è abilitato automaticamente per App Engine e l'account di servizio predefinito della tua app dispone per impostazione predefinita delle autorizzazioni IAM per scrivere le voci di log.

Per ulteriori informazioni, consulta la sezione Scrittura e visualizzazione dei log.

Google Kubernetes Engine (GKE)

GKE concede automaticamente allo account di servizio predefinito il ruolo IAM Scrittore di log (roles/logging.logWriter). Se utilizzi la federazione delle identità per i carichi di lavoro per GKE con questo account di servizio predefinito per consentire ai carichi di lavoro di accedere ad API Google Cloud specifiche, non è richiesta alcuna configurazione aggiuntiva. Tuttavia, se utilizzi la federazione delle identità per i carichi di lavoro per GKE con un account di servizio IAM personalizzato, assicurati che l'account di servizio personalizzato abbia il ruolo di autore di log (roles/logging.logWriter).

Se necessario, puoi anche utilizzare il seguente comando per aggiungere l'ambito di accesso logging.write durante la creazione del cluster:

gcloud container clusters create example-cluster-name \
    --scopes https://www.googleapis.com/auth/logging.write

Compute Engine

Quando utilizzi le istanze VM di Compute Engine, aggiungi l'ambito di accesso cloud-platform a ogni istanza. Quando crei una nuova istanza tramite la console Google Cloud, puoi farlo nella sezione Accesso a identità e 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 l'accesso completo a tutte le API Cloud nella sezione Identità e accesso API. Qualunque account di servizio tu selezioni, assicurati che sia stato concesso il ruolo Scrittore di log nella sezione IAM e amministrazione della console Google Cloud.

Eseguire in locale e altrove

Per utilizzare la libreria Cloud Logging per Python al di fuori di Google Cloud, incluso l'esecuzione della libreria sulla tua workstation, sui computer del tuo data center o sulle istanze VM di un altro provider cloud, devi fornire l'ID progetto Google Cloud e le credenziali del service account appropriato direttamente alla libreria Cloud Logging per Python.

Per gli account di servizio esistenti:

  1. Concedi all'account di servizio il ruolo IAM Logs Writer (roles/logging.logWriter). Per ulteriori informazioni sui ruoli IAM, consulta Controllo dell'accesso.

  2. Configura le credenziali predefinite dell'applicazione.

Se non hai un account di servizio, creane uno. Per informazioni su questa procedura, vedi Creare account di servizio.

Per informazioni generali sui metodi che puoi utilizzare per l'autenticazione, consulta Terminologia: account di servizio.

Visualizza i log

Nella console Google Cloud, vai alla pagina Esplora log:

Vai a Esplora log

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

In Esplora log devi specificare una o più risorse, ma la selezione delle risorse potrebbe non essere ovvia. Ecco alcuni suggerimenti per iniziare:

  • Se esegui il deployment dell'applicazione in App Engine o utilizzi le librerie specifiche di App Engine, imposta la risorsa su App GAE.

  • Se stai eseguendo il deployment dell'applicazione su Compute Engine, imposta la risorsa su Istanzia VM GCE.

  • Se esegui il deployment dell'applicazione su Google Kubernetes Engine, la configurazione di logging del cluster determina il tipo di risorsa delle voci di log. Per una discussione dettagliata sulle soluzioni di monitoraggio Kubernetes di Google Cloud Observability precedenti e di Google Cloud Observability e su come queste opzioni influiscono sul tipo di risorsa, consulta Eseguire la migrazione al monitoraggio Kubernetes di Google Cloud Observability.

  • Se la tua applicazione utilizza direttamente l'API Cloud Logging, la risorsa dipende dall'API e dalla tua configurazione. Ad esempio, nella tua applicazione puoi specificare una risorsa o utilizzare una risorsa predefinita.

  • Se non vedi nessun log in Esplora log, per visualizzare tutte le voci del log, passa alla modalità di query avanzata e utilizza una query vuota.

    1. Per passare alla modalità di query avanzata, fai clic su menu (▾) nella parte superiore di Esplora log e poi seleziona Converti in filtro avanzato.
    2. Cancella i contenuti visualizzati nella casella del filtro.
    3. Fai clic su Invia filtro.

    Puoi esaminare le singole voci per identificare le risorse.

Per ulteriori informazioni, consulta Utilizzare Esplora log.