Scrivere voci di log ed eseguire query utilizzando uno script Python

Questa guida rapida offre l'introduzione ad alcune delle funzionalità di Cloud Logging e mostra come svolgere le seguenti operazioni:

  • Scrivi voci di log utilizzando uno script Python.
  • Visualizza le voci di log utilizzando uno script Python.
  • Elimina le voci di log utilizzando uno script Python.
  • Esegui il routing dei log in un bucket Cloud Storage.

Logging può indirizzare le voci di log alle seguenti destinazioni:

  • Bucket Cloud Storage
  • Set di dati di BigQuery
  • Pub/Sub
  • Bucket di Logging
  • Google Cloud progetti

Prima di iniziare

Per completare questa guida rapida, devi disporre di un progetto Google Cloud con la fatturazione abilitata. Se non hai un progetto Google Cloud o se la fatturazione non è attivata per il tuo progetto Google Cloud , procedi nel seguente modo:
  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. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

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

    6. Questa guida rapida utilizza Cloud Logging e Cloud Storage. L'utilizzo di queste risorse può comportare un costo. Al termine di questa guida rapida, puoi evitare l'addebito di ulteriori costi eliminando le risorse che hai creato. Per ulteriori dettagli, consulta la sezione Pulizia in questa pagina.

Per iniziare

Per completare questa guida rapida, puoi utilizzare l'ambiente Cloud Shell o un ambiente Linux generico. Python è preinstallato in Cloud Shell.

Cloud Shell

  1. Apri Cloud Shell e verifica la configurazione del progetto Google Cloud :

    1. Nella console Google Cloud , fai clic su Attiva Cloud Shell.

      Cloud Shell si apre in una finestra e viene visualizzato un messaggio di benvenuto.

    2. Il messaggio di benvenuto riprende l'ID progetto Google Cloud configurato. Se non è il Google Cloud progetto che vuoi utilizzare, esegui questo comando dopo aver sostituito PROJECT_ID con l'ID del tuo progetto:

      gcloud config set project PROJECT_ID

Linux

  1. Assicurati che Python sia installato e configurato. Per informazioni sulla preparazione della macchina per lo sviluppo Python, consulta Configurazione di un ambiente di sviluppo Python.

  2. Installa la libreria client di Cloud Logging:

    pip install --upgrade google-cloud-logging

  3. Configura le autorizzazioni Identity and Access Management per il tuo progetto Google Cloud . Nei passaggi successivi, crea unaccount di serviziot per il tuo progettoGoogle Cloud , quindi genera e scarica un file nella tua workstation Linux.

    1. Nella console Google Cloud , vai alla pagina Service account:

      Vai ad Account di servizio

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

    2. Seleziona il progetto di avvio rapido Google Cloud , quindi fai clic su Crea service account:

      • Inserisci un nome per l'account.
      • Inserisci una descrizione dell'account.
      • Fai clic su Crea e continua.

    3. Fai clic sul campo Seleziona un ruolo e seleziona Logging Admin.

    4. Fai clic su Fine per completare la creazione del service account.

    5. Crea un file della chiave e scaricalo sulla tua workstation:

      • Per il account di servizio, fai clic su Altre opzioni e seleziona Gestisci chiavi.
      • Nel riquadro Chiavi, fai clic su Aggiungi chiave.
      • Fai clic su Crea nuova chiave.

      • In Tipo di chiave, seleziona JSON e poi fai clic su Crea. Dopo qualche istante, in una finestra viene visualizzato un messaggio simile al seguente:

        Chiave privata salvata sul computer.

  4. Sulla workstation Linux, fornisci le credenziali di autenticazione alla tua applicazione impostando la variabile di ambiente GOOGLE_APPLICATION_CREDENTIALS sul percorso del file della chiave. Ad esempio:

     export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/FILE_NAME.json"

    Questa variabile di ambiente si applica solo alla sessione di Shell corrente, quindi se apri una nuova sessione, imposta di nuovo la variabile.

Clona origine

Per configurare Cloud Shell per questa guida rapida:

  1. Clona il progetto GitHub python-logging:

      git clone https://github.com/googleapis/python-logging

    La directory samples/snippets contiene i due script utilizzati in questa guida rapida:

    • snippets.py consente di gestire le voci in un log.
    • export.py consente di gestire le esportazioni dei log.

  2. Passa alla directory snippets:

      cd python-logging/samples/snippets

Scrittura di voci di log

Lo script snippets.py utilizza le librerie client Python per scrivere voci di log in Logging. Quando l'opzione write viene specificata nella riga di comando, lo script scrive le seguenti voci di log:

  • Una voce con dati non strutturati e nessun livello di gravità specificato.
  • Una voce con dati non strutturati e un livello di gravità pari a ERROR.
  • Una voce con dati strutturati JSON e nessun livello di gravità specificato.

Per scrivere nuove voci di log nel log my-log, esegui lo script snippets.py con l'opzione write:

python snippets.py my-log write

Visualizza voci di log

Per visualizzare le voci di log in Cloud Shell, esegui lo script snippets.py con l'opzione list:

python snippets.py my-log list

Il comando viene completato con il risultato:

    Listing entries for logger my-log:
    * 2018-11-15T16:05:35.548471+00:00: Hello, world!
    * 2018-11-15T16:05:35.647190+00:00: Goodbye, world!
    * 2018-11-15T16:05:35.726315+00:00: {u'favorite_color': u'Blue', u'quest': u'Find the Holy Grail', u'name': u'King Arthur'}

Se il risultato non mostra alcuna voce, riprova a eseguire il comando. Logging richiede alcuni istanti per ricevere ed elaborare le voci di log.

Puoi anche visualizzare le voci di log utilizzando Esplora log. Per ulteriori dettagli, vedi Visualizzare i log utilizzando Esplora log.

Eliminare le voci di log

Per eliminare tutte le voci di log nel log my-log, esegui lo script snippets.py con l'opzione delete:

python snippets.py my-log delete

Il comando viene completato con il risultato:

Deleted all logging entries for my-log.

Log del percorso

In questa sezione, imparerai a:

  • Crea un bucket Cloud Storage come destinazione per i tuoi dati.
  • Crea un sink che copia le nuove voci di log nella destinazione.
  • Aggiorna le autorizzazioni del bucket Cloud Storage.
  • Scrivi voci di log in Logging.
  • (Facoltativo) Verifica il contenuto del bucket Cloud Storage.

Crea destinazione

La destinazione di esportazione per questa guida di avvio rapido è un bucket Cloud Storage. Per creare un bucket Cloud Storage:

  1. Nella console Google Cloud , vai alla pagina Bucket:

    Vai a Bucket

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

  2. Fai clic su Crea bucket.
  3. Inserisci un nome per il bucket.
  4. Per Tipo di località, seleziona Regione, che seleziona una località del bucket con la latenza più bassa.
  5. Per Classe di archiviazione predefinita, seleziona Standard.
  6. In Controllo dell'accesso, seleziona Granulare.
  7. Per Strumenti di protezione, seleziona Nessuno, quindi fai clic su Crea.

Questa guida rapida utilizza il nome del bucket Cloud Storage myloggingproject-1.

Crea un sink

Un sink è una regola che determina se Logging esegue il routing di una voce di log appena arrivata a una destinazione. Un lavello ha tre attributi:

  • Nome
  • Destinazione
  • Filtro

Per saperne di più sui sink, consulta la sezione Sink.

Se una voce di log appena arrivata soddisfa le condizioni della query, viene indirizzata alla destinazione.

Lo script export.py utilizza le librerie client Python per creare, elencare, modificare ed eliminare i sink. Per creare il sink mysink che esporta tutte le voci di log con una gravità di almeno INFO nel bucket Cloud Storage myloggingproject-1, esegui questo comando:

python export.py create mysink myloggingproject-1 "severity>=INFO"

Per visualizzare i sink, esegui lo script export.py con l'opzione list:

python export.py list

Lo script restituisce quanto segue:

    mysink: severity>=INFO -> storage.googleapis.com/myloggingproject-1

Aggiorna le autorizzazioni di destinazione

Le autorizzazioni della destinazione, in questo caso il bucket Cloud Storage, non vengono modificate quando crei un sink utilizzando lo script export.py. Devi modificare le impostazioni delle autorizzazioni del bucket Cloud Storage per concedere l'autorizzazione di scrittura al sink. Per informazioni su service account, ambiti di accesso e ruoli Identity and Access Management, consulta Service account.

Per aggiornare le autorizzazioni del bucket Cloud Storage:

  1. Identifica l'identità writer del tuo sink:

    1. Nella console Google Cloud , vai alla pagina Router dei log:

      Vai a Router dei log

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

      Viene visualizzata una tabella riepilogativa dei lavandini.

    2. Trova il sink nella tabella, seleziona Menu, e poi seleziona Visualizza dettagli sink.

    3. Copia l'identità dell'autore negli appunti.

  2. Nella console Google Cloud , vai alla pagina Bucket:

    Vai a Bucket

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

  3. Per aprire la visualizzazione dettagliata, fai clic sul nome del bucket.

  4. Seleziona Autorizzazioni e fai clic su Concedi accesso.

  5. Incolla l'identità dell'autore nella casella Nuove entità. Rimuovi il prefisso serviceAccount: dall'indirizzo dell'identità dell'autore.

  6. Imposta il Ruolo su Storage Object Creator, quindi fai clic su Salva.

Per ulteriori informazioni, vedi Impostare le autorizzazioni della destinazione.

Convalida sink

Per verificare che il sink e la destinazione siano configurati correttamente:

  1. Scrivi nuove voci di log nel log my-log:

    python snippets.py my-log write

  2. Visualizza i contenuti del bucket Cloud Storage:

    1. Nella console Google Cloud , vai alla pagina Bucket:

      Vai a Bucket

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

    2. Per aprire la visualizzazione dettagliata, fai clic sul nome del bucket. La visualizzazione dettagliata elenca le cartelle che contengono dati. Se non sono presenti dati nel bucket, viene visualizzato il seguente messaggio:

      There are no live objects in this bucket.

      Come descritto in Voci di log arrivate in ritardo, potrebbero essere necessarie 2 o 3 ore prima che le prime voci vengano visualizzate nella destinazione o prima che venga visualizzato un errore di configurazione.

      Dopo che il bucket ha ricevuto i dati, la visualizzazione dettagliata mostra un risultato simile a:

      Visualizzazione dettagliata dei contenuti del bucket.

    3. I dati in ogni cartella sono organizzati in una serie di cartelle etichettate con la cartella di primo livello costituita da un nome di log e poi successivamente l'anno, il mese e il giorno. Per visualizzare i dati esportati dal sink, fai clic sul nome della cartella my-log, quindi continua a fare clic sulle sottocartelle relative ad anno, mese e giorno finché non raggiungi un file che termina con json:

      Visualizzazione della sottocartella dei contenuti del bucket.

    4. Il file JSON contiene le voci di log esportate nel bucket Cloud Storage. Fai clic sul nome del file JSON per visualizzarne i contenuti. I contenuti sono simili a:

       {"insertId":"yf1cshfoivz48",
 "logName":"projects/loggingproject-222616/logs/my-log",
 "receiveTimestamp":"2018-11-15T23:06:14.738729911Z",
 "resource":{"labels":{"project_id":"loggingproject-222616"},"type":"global"},
 "severity":"ERROR",
 "textPayload":"Goodbye, world!",
 "timestamp":"2018-11-15T23:06:14.738729911Z"}

      Poiché il livello di gravità di ERROR è maggiore di quello di INFO, la voce di log contenente la stringa "Goodbye, world!" viene esportata nella destinazione sink. Le altre voci di log scritte non sono state esportate nella destinazione perché il loro livello di gravità è stato impostato sul valore predefinito e il livello di gravità predefinito è inferiore a INFO.

Risoluzione dei problemi

Esistono diversi motivi per cui un bucket Cloud Storage potrebbe essere vuoto:

  • Il bucket non ha ricevuto dati. Potrebbero essere necessarie 2 o 3 ore prima che le prime voci vengano visualizzate nella destinazione o prima che venga visualizzato un errore di configurazione. Per ulteriori informazioni, consulta la sezione Voci di log arrivate in ritardo.

  • Si è verificato un errore di configurazione. In questo caso, riceverai un messaggio email simile alla seguente riga dell'oggetto:

     [ACTION REQUIRED] Logging export config error in myloggingproject.

    Il contenuto del corpo dell'email descrive il problema di configurazione. Ad esempio, se non aggiorni le autorizzazioni di destinazione, l'email elenca il seguente codice di errore:

     bucket_permission_denied

    Per correggere questa condizione specifica, consulta Aggiornare le autorizzazioni della destinazione in questa pagina.

  • Non sono state scritte voci di log dopo la creazione del sink. Il sink viene applicato solo alle voci di log appena arrivate. Per correggere questa situazione, scrivi nuove voci di log:

     python snippets.py my-log write

Esegui la pulizia

Per evitare che al tuo account Google Cloud vengano addebitati costi relativi alle risorse utilizzate in questa pagina, segui questi passaggi.

  1. (Facoltativo) Elimina le voci di log che hai creato. Se non elimini le voci del log, queste scadranno e verranno rimosse. Consulta la sezione Quote e limiti.

    Per eliminare tutte le voci di log nel log my-log, esegui questo comando:

     python snippets.py my-log delete

  2. Elimina il progetto Google Cloud o le risorse di avvio rapido.

    • Per eliminare il tuo progetto Google Cloud , nel riquadro Informazioni sul progetto della Google Cloud console, fai clic su Vai alle impostazioni del progetto, quindi fai clic su Chiudi.

    • Per eliminare le risorse della Guida rapida:

      1. Elimina il sink eseguendo questo comando:

        python export.py delete mysink

      2. Elimina il bucket Cloud Storage. Vai alla console Google Cloud e fai clic su Storage > Bucket. Seleziona la casella accanto al nome del bucket e fai clic su Elimina.

Passaggi successivi