Crea e salva query utilizzando il linguaggio di query di Logging

Questo documento descrive come recuperare e analizzare i log quando utilizzi Esplora log scrivendo query nel campo dell'editor di query e selezionando elementi dai menu dei filtri utilizzando le opzioni incluse nelle voci di log. Le query che crei sono scritte nel linguaggio di query di Logging.

Puoi anche salvare le query nella pagina Esplora log o utilizzando il metodo savedQueries.create dell'API Logging.

Prima di iniziare

  • Per ottenere le autorizzazioni necessarie per leggere i dati dei log al fine di creare query, utilizzare query salvate private o elencare e recuperare query condivise, chiedi all'amministratore di concederti il ruolo IAM Visualizzatore log (roles/logging.viewer) nel progetto.

    Questo ruolo predefinito contiene le autorizzazioni necessarie per leggere i dati dei log per creare query, utilizzare query private salvate o elencare ed eseguire query condivise. Per visualizzare le autorizzazioni esatte richieste, espandi la sezione Autorizzazioni richieste:

    Autorizzazioni obbligatorie

    Per leggere i dati dei log per creare query, utilizzare query salvate private o elencare e recuperare query condivise, sono necessarie le seguenti autorizzazioni:

    • Utilizzare le query salvate private: logging.queries.usePrivate
    • Elenca ed esegui query condivise:
      • logging.queries.listShared
      • logging.queries.getShared

  • Per ottenere le autorizzazioni necessarie per creare, aggiornare ed eliminare le query condivise, chiedi all'amministratore di concederti il ruolo IAM Amministratore di logging (roles/logging.admin) nel progetto.

    Questo ruolo predefinito contiene le autorizzazioni necessarie per creare, aggiornare ed eliminare le query condivise. Per visualizzare le autorizzazioni esatte richieste, espandi la sezione Autorizzazioni richieste:

    Autorizzazioni obbligatorie

    Per creare, aggiornare ed eliminare le query condivise sono necessarie le seguenti autorizzazioni:

    • logging.queries.share
    • logging.queries.updateShared
    • logging.queries.deleteShared

Per ulteriori informazioni sulle autorizzazioni IAM necessarie, consulta Autorizzazioni per la console Google Cloud.

Creazione di query

Per creare query utilizzando la console Google Cloud, segui questi passaggi:

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

  2. Seleziona il progetto Google Cloud o un'altra risorsa Google Cloud per cui vuoi visualizzare i log.

  3. Utilizza il riquadro Query per creare la query.

    Il riquadro Query offre diversi modi per creare ed eseguire espressioni di query:

    • Cerca il testo in tutti i campi dei log.
    • Seleziona le opzioni dai menu dei filtri.
    • Scrivi o modifica le query utilizzando l'editor di query.
    • Visualizza ed esegui query salvate, recenti e suggerite dalla libreria delle query.

Cercare il testo nei campi dei log

Per cercare il testo in tutti i campi dei log e trovare tutte le voci di log corrispondenti, inserisci i termini di ricerca nel campo di ricerca del riquadro Query.

Puoi cercare parole e frasi e i termini di ricerca possono includere operatori booleani ed espressioni regolari:

  • Per eseguire una ricerca sensibile alle maiuscole, devi utilizzare un'espressione regolare.

  • Per eseguire una ricerca senza distinzione tra maiuscole e minuscole lungo i confini dei token, inserisci i termini di ricerca senza barre graffe o virgolette doppie.

    Ad esempio, per cercare le voci di log che contengono la parola hello e la parola world, inserisci hello world. Questo comando, che viene convertito in SEARCH("hello world"), corrisponde alle voci di log che contengono i token hello e world, in qualsiasi ordine. Poiché la ricerca non è sensibile alle maiuscole, corrisponde anche a una voce di log contenente i token Hello e World. La ricerca non corrisponde al token worlds.

  • Per eseguire una ricerca senza distinzione tra maiuscole e minuscole di una frase lungo i confini dei token, incornicia la frase tra barre graffe.

    Ad esempio, per cercare la frase hello world, inserisci `hello world`. Questo comando, che viene convertito in SEARCH("`hello world`"), corrisponde alle voci di log che contengono il token hello world. La ricerca non corrisponde al token hello worlds.

  • Per eseguire una ricerca di una sottostringa senza distinzione tra maiuscole e minuscole, racchiudi il testo tra virgolette doppie. Ad esempio, "hello world" corrisponde a Hello World e Hello world. La stessa query corrisponde anche a hello worlds, perché la ricerca non viene eseguita lungo i confini dei token.

Per visualizzare i termini di ricerca all'interno dell'espressione di query, attiva Mostra query.

Dopo aver inserito i termini di ricerca, fai clic su Esegui query o premi il tasto Invio. I risultati della query vengono visualizzati nel riquadro Risultati query.

Operatori booleani

Le voci del campo di ricerca vengono convertite in espressioni booleane che specificano un insieme parziale di tutte le voci di log nella risorsa Google Cloud selezionata.

Il campo di ricerca supporta l'utilizzo degli operatori booleani AND, OR e NOT. Quando utilizzi gli operatori booleani nelle espressioni di ricerca, tieni presente quanto segue:

  • Non puoi utilizzare le parentesi per nidificare le regole. Eventuali parentesi nell'espressione di ricerca vengono analizzate come termini di ricerca.
  • Devi usare gli operatori booleani in maiuscolo. and, or e not in minuscolo vengono analizzati come termini di ricerca, non come operatori.

Se non includi alcun operatore, tutti i termini e le frasi di ricerca vengono uniti da AND. Puoi omettere l'operatore AND tra i termini di ricerca.

Gli operatori AND e OR sono operatori a corto circuito. Puoi combinare le regole AND e OR nella stessa espressione. Ad esempio, quando i due operatori vengono combinati, l'espressione a AND b OR c AND d diventa la seguente espressione del linguaggio delle query di Logging:

"a"
"b" OR "c"
"d"

L'operatore NOT ha la precedenza più alta, seguito da OR e AND in quest'ordine.

L'operatore NOT esegue una negazione del termine successivo. Ad esempio, NOT error restituisce le voci di log che non contengono error. Puoi anche sostituire l'operatore NOT con l'operatore - (meno). Ad esempio, le seguenti due query sono uguali:

"response" AND "successful" AND NOT "error"

"response successful" -"error"

Questa logica funziona anche con una frase, se l'operatore - (meno) è al di fuori delle virgolette. Ad esempio, le seguenti due query sono uguali:

-"response successful"

NOT "response successful"

Creare query con i menu di filtro

Puoi utilizzare i menu del filtro nel riquadro Query per aggiungere parametri relativi a risorse, nome e gravità del log e correlazione nel campo dell'editor di query. Queste opzioni corrispondono ai campi LogEntry per tutti i log in Logging.

Le opzioni dei menu Risorsa e Nome log derivano dalle voci di log memorizzate da Cloud Logging.

  • Risorsa: consente di specificare resource.type e resource.labels associato. Puoi selezionare un singolo tipo di risorsa utilizzando questo menu di filtro e nessuna o più etichette di risorse da applicare alla tua query. I parametri della risorsa vengono uniti dall'operatore logico AND.
  • Nome log: consente di specificare logName. Puoi selezionare più nomi di log da applicare alla query. Quando selezioni più nomi log, viene utilizzato l'operatore logico OR.
  • Gravità: consente di specificare la gravità. Puoi selezionare più livelli di gravità contemporaneamente da aggiungere alla query. Quando selezioni più livelli di gravità, viene utilizzato l'operatore logico OR.
  • Correla con: consente di raggruppare e visualizzare le voci di log in un formato "principale-secondario". Per ulteriori informazioni, consulta Correla le voci di log.

Per utilizzare uno dei menu dei filtri:

  1. Espandi Menu in uno qualsiasi degli menu dei filtri nel riquadro Query.

  2. Perfeziona i parametri del filtro.

  3. Fai clic su Applica. I parametri vengono visualizzati nel campo dell'editor di query.

    Per visualizzare i termini di ricerca all'interno dell'espressione di query, attiva Mostra query.

  4. Dopo aver esaminato la query, fai clic su Esegui query. I risultati della query vengono visualizzati nel riquadro Risultati query.

Per alcuni tipi di risorse Compute Engine, come gce_instance e gce_network, viene visualizzato il nome della risorsa con l'ID risorsa come testo secondario. Ad esempio, per il tipo di risorsa gce_instance, viene visualizzato il nome della VM insieme all'ID VM. I nomi delle risorse ti aiutano a identificare l'ID risorsa corretto su cui puoi creare query.

Visualizzare i log per intervallo di tempo

Esistono due modi per visualizzare i log scritti in un intervallo di tempo specifico:

  1. Utilizza il selettore dell'intervallo di tempo.
  2. Includi un'espressione del timestamp nel campo dell'editor delle query.

Utilizzare il selettore dell'intervallo di tempo

L'intervallo di tempo predefinito è di un'ora, ma puoi scegliere tra le opzioni di tempo preimpostate, specificare un'ora di inizio e di fine personalizzata o centrare l'intervallo di tempo su un timestamp specifico utilizzando il selettore dell'intervallo di tempo. Ad esempio, se vuoi visualizzare i dati della settimana precedente, seleziona Ultima settimana dal selettore dell'intervallo di tempo.

Puoi anche impostare le preferenze relative al fuso orario utilizzando il selettore dell'intervallo di tempo.

Includi un'espressione timestamp nel campo dell'editor di query

Per aggiungere un'espressione timestamp direttamente al campo dell'editor di query, utilizza il linguaggio di query di Logging.

Se il campo dell'editor di query contiene un'espressione con un timestamp, il selettore dell'intervallo di tempo viene disattivato e la query utilizza l'espressione del timestamp come limitazione dell'intervallo di tempo. Se una query non utilizza un'espressione timestamp, la query utilizza il selettore dell'intervallo di tempo come restrizione dell'intervallo di tempo.

Scrivere query avanzate utilizzando il linguaggio di query di Logging

Puoi utilizzare il linguaggio di query di Logging per creare query più avanzate nel campo dell'editor di query di Esplora log:

  1. Se non vedi il campo dell'editor di query nel riquadro Query, attiva Mostra query.

  2. Inserisci le espressioni di query direttamente nel campo dell'editor delle query.

    Se hai aggiunto termini di ricerca nel campo di ricerca o hai selezionato parametri nei menu dei filtri, questi vengono visualizzati anche nel campo dell'editor di query e valutati nell'espressione della query.

  3. Dopo aver esaminato la query, fai clic su Esegui query.

    I log corrispondenti alla tua query sono elencati nel riquadro Risultati delle query. Anche i riquadri Istogramma e Campi log si regolano in base all'espressione di query.

Per esempi di query comuni che potresti utilizzare, consulta Query di esempio con Esplora log.

Utilizzare le query recenti

Quando esegui una query, questa viene aggiunta alla libreria delle query, che contiene le ultime 10.000 query uniche in un periodo di 30 giorni.

Per visualizzare le query recenti, seleziona il pulsante Raccolta query nella barra degli strumenti principale. Per le query recenti, hai le seguenti opzioni:

  • Stream: per eseguire la query e riprodurre in streaming i risultati, scegli questa opzione.
  • Esegui: per eseguire la query, scegli questa opzione.

  • Altre opzioni: consente di visualizzare l'espressione di query con le opzioni per eseguirla o salvarla nell'elenco delle query Salvate. Puoi anche selezionare direttamente la query per visualizzare queste opzioni.

    Per salvare la query:

    1. Fai clic su Salva. Viene visualizzata la finestra di dialogo Salva query.

    2. Completa i seguenti campi:

      • Nome (obbligatorio): fornisci un nome per la query. I nomi sono limitati a 64 caratteri.
      • (Facoltativo) Descrizione: fornisci una descrizione per identificare lo scopo della query.
      • (Facoltativo) Includi campi di riepilogo: attiva Includi campi di riepilogo e inserisci i campi di riepilogo che vuoi visualizzare.
      • Tronca i campi di riepilogo (facoltativo): attiva Tronca i campi di riepilogo e seleziona il numero di caratteri fino al quale troncare i campi e se la troncatura deve avvenire all'inizio o alla fine dei campi.

    3. Fai clic su Salva query. La query è ora disponibile nel elenco delle query salvate.

Puoi anche ordinare e filtrare le query recenti. Il filtro corrisponde al testo nella tua espressione di query.

Salvare e condividere le query

Le query salvate ti consentono di archiviare espressioni di query per aiutarti a esplorare i log in modo più coerente ed efficiente. Esplora log include una libreria di query in cui puoi accedere alle query salvate. Puoi anche salvare le query utilizzando il metodo dell'API Logging savedQueries.create.

Puoi salvare la query in modo che sia privata e visibile solo a te oppure condividerla con altri membri del progetto Google Cloud. Una volta condivisa, la query non è più di tua proprietà e qualsiasi membro del progetto con le autorizzazioni necessarie può accedervi.

Console

Per salvare un'espressione di query creata nel campo dell'editor delle query:

  1. Fai clic su Salva nel riquadro Query. Viene visualizzata la finestra di dialogo Salva query con l'espressione di query nel campo dell'editor di query.

  2. Completa i seguenti campi:

    • Nome (obbligatorio): fornisci un nome per la query. I nomi sono limitati a 64 caratteri.
    • (Facoltativo) Descrizione: fornisci una descrizione per identificare lo scopo della query.
    • (Facoltativo) Includi campi di riepilogo personalizzati: attiva Includi campi di riepilogo e inserisci i campi di riepilogo da visualizzare.
    • Tronca i campi di riepilogo (facoltativo): attiva Tronca i campi di riepilogo e seleziona il numero di caratteri fino al quale troncare i campi e se la troncatura deve avvenire all'inizio o alla fine dei campi.
    • Condividi con il progetto: se vuoi, attiva Condividi con il progetto per condividere la query con altri membri del progetto Google Cloud.

  3. Fai clic su Salva query. Le query salvate vengono visualizzate in un elenco nella scheda Salvate.

Per eseguire una query salvata, fai clic su Esegui. Per eseguire la query e riprodurre in streaming i risultati, fai clic su Stream.

Per modificare una query salvata, seleziona Altre opzioni, poi Modifica. Puoi anche selezionare la query, apportare modifiche e salvarla.

Per eliminare una query salvata, seleziona Altre opzioni, poi Elimina.

Puoi anche ordinare e filtrare le query salvate. Il filtro corrisponde al testo nell'espressione della query.

API

Per salvare una query utilizzando l'API Logging, utilizza il metodo savedQueries.create. Per ulteriori informazioni su questo metodo, sui suoi parametri e sui dati di risposta, consulta la pagina di riferimento per savedQueries.create.

Puoi eseguire il metodo savedQueries.create utilizzando il widget Explorer API nella pagina di riferimento del metodo. Per le query di Esplora log, devi specificare il campo loggingQuery. L'esempio seguente mostra un corpo della richiesta di esempio, che contiene un'istanza di SavedQuery:

{
  "parent": "projects/my-project/locations/global"
  "savedQueryId": "compute-query"
  {
    "displayName": "compute-admin-activity-query",
    "description": "Queries for Compute Engine Admin Activity logs.",

    "loggingQuery":
      {
        "filter": resource.type="gce_instance" AND log_id("cloudaudit.googleapis.com/activity"),
      },
    "visibility": "PRIVATE"
  }
}

Per condividere la query con altri membri del progetto Google Cloud, specifica un valore SHARED nel campo visibility.

Visualizza le query salvate

Puoi visualizzare sia le query private sia quelle condivise con altri membri nel progetto Google Cloud facendo clic sul pulsante Libreria di query:

Console

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

  2. Seleziona il progetto Google Cloud o un'altra risorsa Google Cloud per cui vuoi visualizzare i log.

  3. Fai clic sul pulsante Raccolta query e poi su Salvate.

Puoi ordinare la tabella in base a qualsiasi intestazione. La colonna Visibilità indica se le query sono condivise o private:

  • Condivisi: query condivise con altri membri del progetto Google Cloud.
  • Privato: le query che hai salvato e che sono visibili solo a te.

API

Puoi utilizzare l'API Logging per visualizzare le query private e condivise utilizzando il metodo savedQueries.list.

Ad esempio, il seguente corpo della richiesta elenca tutte le query di Esplora log condivisi con un ID posizione jolly:

{
  "parent": "name": projects/PROJECT_ID/locations/-
  "visibility": "SHARED"
  "filter": "explorer"
}

Utilizzare le query suggerite

La registrazione genera query suggerite in base al contesto del tuo progetto Google Cloud, ad esempio i prodotti Google Cloud che utilizzi. Le query suggerite possono aiutarti a identificare i problemi e fornirti informazioni sullo stato complessivo dei tuoi sistemi. Ad esempio, se rileva che utilizzi Google Kubernetes Engine, Logging potrebbe suggerire una query che trova tutti i log degli errori per i tuoi container.

Per visualizzare ed eseguire le query suggerite, fai clic sul pulsante Raccolta di query e poi su Suggerite. Nella scheda Consigliati, hai a disposizione le seguenti opzioni:

  • Stream: per eseguire la query e riprodurre in streaming i risultati, scegli questa opzione.
  • Esegui: per eseguire la query, scegli questa opzione.

  • Altre opzioni: consente di visualizzare i dettagli dell'espressione di query con le opzioni per eseguirla o salvarla. Puoi anche selezionare direttamente la query per visualizzare queste opzioni.

    Per esaminare i dettagli di una query suggerita:

    • Seleziona la riga della query.

    • Fai clic su Altro e seleziona Visualizza. Viene visualizzata la finestra di dialogo Dettagli query.

    Nella finestra di dialogo Dettagli query, vengono visualizzate la query e le opzioni Esegui, Riproduci in streaming o Salva come:

    • Per salvare la query:

      1. Fai clic su Salva query.
      2. Completa i campi nella finestra di dialogo Salva query.

      La query modificata viene visualizzata nell'elenco Salvati, dove puoi scegliere di eseguire la query in un secondo momento.

    • Per eseguire subito la query, fai clic su Esegui. La query viene eseguita e visualizzata nel campo query-editor.

    • Per eseguire subito la query e trasmettere i risultati in streaming, fai clic su Stream.

    • Per chiudere la finestra di dialogo e tornare all'elenco delle query suggerite, fai clic su Chiudi.

Tieni presente i seguenti comportamenti previsti:

  • I caricamenti di pagine successivi potrebbero non mostrare le stesse query nello stesso ordine.
  • Potresti non vedere nessuna query suggerita.
  • A volte l'esecuzione di una query suggerita non restituisce log.

Seleziona le query dalla raccolta

Il logging fornisce una libreria di query basate su casi d'uso comuni e prodotti Google Cloud. Queste query possono aiutarti a trovare in modo efficiente i log durante le sessioni di risoluzione dei problemi urgenti ed esplorare i log per comprendere meglio quali dati di logging sono disponibili.

Per visualizzare ed eseguire le query della libreria, segui questi passaggi:

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

  2. Seleziona il progetto Google Cloud o un'altra risorsa Google Cloud per cui vuoi visualizzare i log.

  3. Fai clic sul pulsante Richiedi query alla raccolta. Vengono visualizzate categorie di query disponibili e sottoinsiemi di query in base ai prodotti Google Cloud. Per restringere la selezione delle query visualizzate, fai clic su uno dei prodotti.

    Puoi anche utilizzare il campo di ricerca per cercare le query disponibili per categoria, descrizione o contenuti dell'espressione di query.

  4. Per esaminare un'espressione di query, esegui una delle seguenti operazioni:

    a. Fai clic sulla riga della query.

    b. Fai clic su Altro e seleziona Visualizza.

  5. Nella finestra di dialogo Dettagli query, vengono visualizzate la query e le opzioni per Esegui, Stream o Salva come:

    • Per salvare la query:

      1. Fai clic su Salva query.
      2. Completa i campi nella finestra di dialogo Salva query.

      La query modificata viene visualizzata nell'elenco Salvati, dove puoi scegliere di eseguire la query in un secondo momento.

    • Per eseguire subito la query, fai clic su Esegui. La query viene eseguita e visualizzata nel campo query-editor.

    • Per eseguire subito la query e trasmettere in streaming i risultati, fai clic su Stream.

    • Per chiudere la finestra di dialogo e tornare all'elenco delle query suggerite, fai clic su Chiudi.

Passaggi successivi