Salvare e condividere query SQL

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

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

Per scoprire come rappresentare graficamente i risultati della query e come salvare i grafici in una dashboard personalizzata, consulta Grafici dei risultati delle query SQL.

Differenza tra le query salvate e le viste di analisi

Una query salvata è una query che esegui utilizzando la pagina Observability Analytics e che salvi come query. L'azione di salvataggio ti consente di eseguire nuovamente questa query quando preferisci. Quando salvi la query, puoi scegliere di renderla privata o visibile ad altri utenti che dispongono delle autorizzazioni necessarie per utilizzare Observability Analytics. Non puoi scrivere una query SQL in cui la clausola FROM specifica una query salvata.

Una visualizzazione Analytics contiene una query che puoi eseguire di nuovo quando vuoi. Crei una vista Analytics scrivendo una query SQL su una vista log e salvando il risultato come vista. A differenza delle query salvate, non puoi rendere privata una visualizzazione di Analytics. Puoi eseguire query su una vista Analytics. Questa funzionalità ti consente di trasformare i dati di 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 le query che eseguono query su una visualizzazione log o una visualizzazione Analytics.

Prima di iniziare

Questa sezione descrive i passaggi che devi completare prima di poter utilizzare Observability Analytics.

Configura i bucket di log

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

  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 visualizzazione log che vuoi interrogare, assicurati che la colonna Analisi dell'osservabilità disponibile mostri Apri. Se viene visualizzato Esegui l'upgrade, fai clic su Esegui l'upgrade e completa la finestra di dialogo.

Configura ruoli e autorizzazioni IAM

Questa sezione descrive i ruoli o le autorizzazioni IAM necessari per utilizzare Observability Analytics:

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

    • Per eseguire query sui bucket di log _Required e _Default: Visualizzatore log (roles/logging.viewer)
    • Per eseguire query su tutte le visualizzazioni 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 Accessore visualizzazione log effettuata a livello di progetto oppure aggiungendo un'associazione IAM al file della policy della visualizzazione di log. Per saperne di più, consulta Controllare l'accesso a una visualizzazione log.

    Si tratta delle stesse autorizzazioni necessarie per visualizzare le voci di log nella pagina Esplora log. Per informazioni su 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 Cloud Logging.

  • Per ottenere le autorizzazioni necessarie per eseguire query sulle visualizzazioni di analisi, chiedi all'amministratore di concederti il ruolo IAM Observability Analytics User (roles/observability.analyticsUser) sul progetto.

Salva una query

Tutte le query che esegui vengono salvate automaticamente per 30 giorni e sono accessibili selezionando la scheda Recenti nella pagina Observability Analytics. 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 o consenti ai colleghi di visualizzarla ed eseguirla, quindi salvala. Puoi cercare e ordinare le query salvate in base a nome, descrizione ed 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 Google Cloud progetto.

Console

Per salvare una query:

  1. Nella console Google Cloud , vai alla pagina Analisi dell'osservabilità:

    Vai a Observability Analytics

    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, selezionandone una dalla scheda Recenti o selezionandone una dalla scheda Salvate.

    La query può includere qualsiasi vista valida, più viste e viste Analytics.

    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 Observability Analytics per la visualizzazione del progetto Google Cloud di eseguire la query salvata, attiva il pulsante di attivazione/disattivazione Condividi con il progetto.

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

  5. Fai clic su Salva query.

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

    Puoi ordinare e filtrare le query salvate in base a nome, descrizione ed etichetta di visibilità. Puoi anche filtrare in base ai contenuti della query.

Puoi modificare ed eliminare le query che hai creato utilizzando le opzioni 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.

REST

Puoi salvare una query utilizzando l'API Cloud Logging. Per salvare una query, utilizza il metodo savedQueries.create.

Per eseguire questo metodo:

  1. Seleziona savedQueries.create.
  2. Nella pagina di riferimento, utilizza Explorer API per inviare un comando. Devi specificare il campo opsAnalyticsQuery.

L'esempio seguente illustra 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
            `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à determinano se la query può essere eseguita e i dati restituiti.

Console

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

Per condividere una query e i risultati con un collega:

  1. Nella console Google Cloud , vai alla pagina Analisi dell'osservabilità:

    Vai a Observability Analytics

    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 poi fai clic su Esegui query.

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

  3. Fai clic su Condividi link.

  4. Invia il link al tuo collega.

    Quando il tuo collega apre il link, viene visualizzata la pagina Observability Analytics, ma la query non viene eseguita. Il tuo compagno di squadra deve eseguire manualmente la query.

    La pagina Analisi dell'osservabilità mostra una finestra di dialogo di avviso quando la query viene eseguita sul motore BigQuery e le risorse sottoposte a query non si trovano nello stesso limite di proprietà. I limiti di proprietà sono determinati da diversi fattori, uno dei quali è la gerarchia delle risorse utilizzate dalla query.

    Per aprire correttamente l'URL, il ruolo IAM del tuo collega nel progetto Google Cloud deve includere le autorizzazioni necessarie per visualizzare la pagina Analisi dell'osservabilità.

REST

Puoi utilizzare l'API Logging per creare una query condivisa utilizzando il metodo savedQueries.Create e specificando un valore di 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 Observability Analytics e trova 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 Observability Analytics e trova 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