Salvare e condividere query SQL

Questo documento descrive come salvare e condividere le query create in Log Analytics.

Questo documento presuppone che tu abbia dimestichezza con Analisi dei log e con l'utilizzo della pagina Analisi dei log per eseguire query sui dati dei log. Se non hai familiarità con questi argomenti, consulta Eseguire query e analizzare i log.

Per scoprire come creare grafici dei risultati delle query e come salvarli in una dashboard personalizzata, consulta Creare grafici dei risultati delle query SQL.

Differenze tra le query salvate e le viste di analisi

Una query salvata è una query che viene eseguita utilizzando la pagina Analisi dei log e poi salvata come query. L'azione di salvataggio ti consente di eseguire nuovamente questa query quando preferisci. Quando salvi la query, hai la possibilità di renderla privata o visibile ad altri utenti che dispongono delle autorizzazioni necessarie per utilizzare Log Analytics. Non puoi scrivere una query SQL in cui la clausola FROM specifica una query salvata.

Una visualizzazione di analisi contiene una query che puoi eseguire di nuovo quando vuoi. Puoi creare una vista di analisi scrivendo una query SQL su una vista di log e salvando il risultato come vista. A differenza delle query salvate, non puoi rendere privata una visualizzazione di Dati. Puoi eseguire una query su una vista di analisi. Questa funzionalità ti consente di trasformare i dati dei log dal formato LogEntry in un altro formato più adatto alle tue esigenze. Poi, anziché scrivere le query su una visualizzazione dei log, esegui query sulla visualizzazione di analisi.

Puoi salvare query che eseguono query su una visualizzazione dei log o su una visualizzazione di analisi.

Prima di iniziare

Questa sezione descrive i passaggi da completare prima di poter utilizzare Log Analytics.

Configura i bucket di log

Assicurati che sia stato eseguito l'upgrade dei bucket di log per utilizzare Analisi dei log:

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

    Vai ad Archiviazione dei log

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

  2. Per ogni bucket di log con una vista log per cui vuoi eseguire una query, assicurati che la colonna Log Analytics disponibile mostri Aperto. Se viene visualizzato Esegui l'upgrade, fai clic su Esegui l'upgrade e completa la finestra di dialogo.

Configura i ruoli e le autorizzazioni IAM

Questa sezione descrive i ruoli o le autorizzazioni IAM obbligatori per utilizzare Log Analytics:

  • Per ottenere le autorizzazioni necessarie per utilizzare Log Analytics ed eseguire query sulle visualizzazioni log, chiedi all'amministratore di concederti i seguenti ruoli IAM nel progetto:

    • Per eseguire query sui bucket di log _Required e _Default: Visualizzatore log (roles/logging.viewer)
    • Per eseguire query su tutte le visualizzazioni dei log in un progetto: Logs View Accessor (roles/logging.viewAccessor)

    Puoi limitare un'entità a una visualizzazione di log specifica aggiungendo una condizione IAM alla concessione del ruolo Accesso alla visualizzazione dei log effettuata a livello di progetto oppure aggiungendo un'associazione IAM al file di criteri della visualizzazione di log. Per ulteriori informazioni, consulta Controllare l'accesso a una visualizzazione dei log.

    Si tratta delle stesse autorizzazioni necessarie per visualizzare le voci di log nella pagina Esplora log. Per informazioni sui ruoli aggiuntivi necessari per eseguire query sulle visualizzazioni dei bucket definiti dall'utente o per eseguire query sulla visualizzazione _AllLogs del bucket di log _Default, consulta Ruoli di Cloud Logging.

  • Per ottenere le autorizzazioni necessarie per eseguire query sulle visualizzazioni di analisi, chiedi all'amministratore di concederti il ruolo IAM Utente di analisi dell'osservabilità (roles/observability.analyticsUser) nel progetto.

Salva una query

Tutte le query eseguite vengono salvate automaticamente per 30 giorni e sono accessibili selezionando la scheda Recenti nella pagina Analisi dei log. Puoi cercare, visualizzare, eseguire e condividere le query elencate nella scheda Recenti.

Se vuoi mantenere una query disponibile per un utilizzo futuro, annotala con informazioni utili per te o consenti ai colleghi di visualizzarla ed eseguirla, quindi salvala. Puoi cercare e ordinare le query salvate in base al nome, alla descrizione e all'etichetta di visibilità. Puoi anche modificare ed eliminare queste query. Le query salvate vengono conservate finché non le elimini.

Puoi salvare 10.000 query per progetto Google Cloud.

Console

Per salvare una query:

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

    Vai ad Analisi dei log

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

  2. Compila il riquadro Query con una query.

    Puoi compilare il riquadro Query inserendo una nuova query, selezionando una query dalla scheda Recenti o selezionando una query dalla scheda Salvate.

    La query può specificare sia le visualizzazioni di log sia le visualizzazioni di analisi.

    Quando la query nel riquadro Query è valida, l'opzione Salva è attivata.

  3. Fai clic su Salva, seleziona Salva query e compila i campi Nome e Descrizione. I valori impostati per questi campi vengono visualizzati nella scheda Salvati.

  4. (Facoltativo) Per consentire a tutti gli utenti con accesso alla pagina Log Analytics per la visualizzazione del progetto Google Cloud di eseguire la query salvata, attiva l'opzione di attivazione/disattivazione Condividi con il progetto.

    Per impostazione predefinita, questo pulsante di attivazione/disattivazione è disattivato e la visibilità è limitata a te.

  5. Fai clic su Salva query.

  6. (Facoltativo) Per visualizzare, ordinare ed eseguire le query salvate visibili per te, seleziona la scheda Salvate.

    Puoi ordinare e filtrare le query salvate in base al nome, alla descrizione e all'etichetta di visibilità. Puoi anche filtrare in base ai contenuti della query.

Puoi modificare ed eliminare le query che hai creato utilizzando le opzioni disponibili nella scheda Salvate:

  • Per modificare una query, fai clic su Altre opzioni e seleziona Modifica. Puoi modificare i valori dei campi Nome e Descrizione, ma la query stessa non può essere modificata.

  • Per eliminare una query salvata, fai clic su Altre opzioni e seleziona Elimina.

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 Log Analytics, devi specificare il campo opsAnalyticsQuery. L'esempio seguente mostra un corpo della richiesta di esempio, che contiene un'istanza di SavedQuery:

{
  "parent": "projects/my-project/locations/global"
  "saved_query":
  {
     "ops_analytics_query":
     {
        "sql_query_text" :
           "SELECT
           timestamp, log_name, severity, json_payload, resource, labels
           FROM
           `TABLE_NAME_OF_LOG_VIEW`
           WHERE
           timestamp > TIMESTAMP_SUB(CURRENT_TIMESTAMP(), INTERVAL 1 HOUR)
           ORDER BY timestamp ASC
           LIMIT 100"
     }
     "visibility": "PRIVATE"
  }
}

Condividere una query

Puoi condividere una query salvata con tutti gli utenti che hanno accesso al tuo progetto Google Cloud. Tuttavia, i ruoli IAM dell'entità IAM determinano se la query può essere eseguita e i dati restituiti dalla query.

Console

Quando risolvi un problema o quando vedi risultati anomali, potresti voler condividere una query e i relativi risultati con un collega. Quando visualizzi i risultati della query nella pagina Log Analytics, puoi copiare un URL che, se aperto, mostra la query eseguita e i relativi risultati.

Per condividere una query e i risultati con un collega:

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

    Vai ad Analisi dei log

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

  2. Compila il riquadro Query con una query e fai clic su Esegui query.

    Puoi compilare il riquadro Query inserendo una nuova query, selezionando una query dalla scheda Recenti o selezionando una query dalla scheda Salvate.

  3. Fai clic su Condividi link.

  4. Invia il link al tuo compagno di squadra.

    Quando il tuo collega apre il link, viene visualizzata la pagina Log Analytics. Questa pagina mostra la query eseguita e i relativi risultati.

    Per aprire l'URL correttamente, il ruolo IAM del tuo compagno di squadra nel progetto Google Cloud deve includere le autorizzazioni necessarie per visualizzare le pagine di logging.

API

Puoi utilizzare l'API Logging per creare una query condivisa utilizzando il metodo savedQueries.Create e specificando un valore SHARED nel campo visibility. Per ulteriori informazioni, consulta la pagina di riferimento per savedQueries.create.

Visualizzare ed eseguire query recenti o salvate

Per visualizzare o eseguire di nuovo una query, seleziona la scheda Recenti nella pagina Analisi dei log e individua la query:

  • Per eseguire la query, fai clic su Esegui.
  • Per visualizzare la query, utilizza le opzioni nel menu Altre opzioni.

Per visualizzare, modificare o eseguire una query salvata, seleziona la scheda Salvate nella pagina Analisi dei log e individua la query:

  • Per eseguire la query, fai clic su Esegui.
  • Per modificare, visualizzare o eliminare la query, utilizza le opzioni nel menu Altre opzioni.

Passaggi successivi