Salvare o condividere query SQL

Puoi salvare e condividere le query SQL in Observability Analytics, che ti consente di eseguire di nuovo le indagini frequenti e collaborare con i membri del team nel tuo progetto. Le query salvate possono essere mantenute private per il tuo utilizzo o condivise con altri membri del progetto. Se non hai scritto query in Observability Analytics, consulta prima Eseguire query e analizzare la telemetria con Observability Analytics.

Prima di iniziare

Configura il progetto, i ruoli IAM e seleziona l'interfaccia che intendi utilizzare.

Configurare il progetto e i ruoli

  1. Accedi al tuo Google Cloud account. Se non conosci Google Cloud, crea un account per valutare le prestazioni dei nostri prodotti in scenari reali. I nuovi clienti ricevono anche 300 $di crediti senza costi per l'esecuzione, il test e il deployment dei carichi di lavoro.

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

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. Enable the Observability API.

    Roles required to enable APIs

    To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

    Enable the API

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

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  6. Verify that billing is enabled for your Google Cloud project.

  7. Enable the Observability API.

    Roles required to enable APIs

    To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

    Enable the API

    8.

  8. Per ottenere le autorizzazioni necessarie per caricare la pagina Observability Analytics , scrivere, eseguire e salvare query private, chiedi all'amministratore di concederti i seguenti ruoli IAM:

    • Observability View Accessor (roles/observability.viewAccessor) sulle viste di osservabilità su cui vuoi eseguire query. Questo ruolo supporta le condizioni IAM, che ti consentono di limitare la concessione a una vista specifica. Se non associ una condizione alla concessione del ruolo, l'entità può accedere a tutte le viste di osservabilità.
    • Observability Analytics User (roles/observability.analyticsUser) sul tuo progetto. Questo ruolo contiene le autorizzazioni necessarie per salvare ed eseguire query private e per eseguire query condivise.
    • Visualizzatore log (roles/logging.viewer) sul tuo progetto.
    • Logs View Accessor (roles/logging.viewAccessor) sul progetto che archivia le viste di log su cui vuoi eseguire query.

    Per saperne di più sulla concessione dei ruoli, consulta Gestisci l'accesso a progetti, cartelle e organizzazioni.

    Potresti anche riuscire a ottenere le autorizzazioni richieste tramite i ruoli personalizzati o altri ruoli predefiniti.

Selezionare l'interfaccia che intendi utilizzare

Console

Quando utilizzi la Google Cloud console per accedere a Google Cloud servizi e API, non devi configurare l'autenticazione.

gcloud

Nella Google Cloud console, attiva Cloud Shell.

Attiva Cloud Shell

Nella parte inferiore della Google Cloud console viene avviata una sessione di Cloud Shell e viene visualizzato un prompt della riga di comando. Cloud Shell è un ambiente shell con Google Cloud CLI già inclusa e installata e con valori già impostati per il progetto corrente. L'inizializzazione della sessione può richiedere alcuni secondi.

REST

Per utilizzare gli esempi di API REST in questa pagina in un ambiente di sviluppo locale, utilizzi le credenziali che fornisci a gcloud CLI.

    Installa Google Cloud CLI.

    Se utilizzi un provider di identità (IdP) esterno, devi prima accedere a gcloud CLI con la tua identità federata.

Per saperne di più, consulta Autenticati per usare REST nella Google Cloud documentazione sull'autenticazione di.

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.

Per riutilizzare una query, aggiungere descrizioni personalizzate o condividerla con i membri del team, salva la query. 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 che salvi vengono conservate finché non le elimini.

Puoi salvare 10.000 query per Google Cloud progetto.

Console

Per salvare una query:

  1. Nella Google Cloud console, vai alla Observability Analytics pagina:

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

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

    Quando la query nel riquadro Query è valida, il pulsante Salva è attivo.

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

  4. (Facoltativo) Per consentire a tutti gli utenti con accesso alla pagina Observability Analytics per il Google Cloud progetto di visualizzare ed eseguire la query salvata, attiva il pulsante 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 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 nella scheda Salvate:

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

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

gcloud

Per creare e salvare una query:

  1. Prima di utilizzare i dati dei comandi riportati di seguito, effettua le seguenti sostituzioni:

    • DISPLAY_NAME: il nome visualizzato della query salvata.
    • LOCATION: la località della query salvata.
    • VISIBILITY: imposta su private o shared.
    • SQL_QUERY: una query SQL. Se i backtick singoli (`) racchiudono il percorso o i campi all'interno del percorso, devi eseguire l'escape di questi backtick: 
          "SELECT * FROM \`PROJECT_ID.LOCATION.my-log-bucket._AllLogs\`"

      o

          "SELECT * FROM \`PROJECT_ID.LOCATION._Trace.Spans._AllSpans\`"

      I backtick (`) sono obbligatori quando un elemento del percorso contiene un carattere punto (.).

    • ID: l'ID della query salvata. Questo ID è un input obbligatorio per i comandi che descrivono, aggiornano o eliminano una query salvata. Se non fornisci l'ID quando crei una query salvata, il sistema genera un ID numerico.
    • DESCRIPTION: una descrizione testuale della query. (Facoltativo)
    • PROJECT_ID: l'identificatore del progetto.

    Esegui il gcloud logging saved-queries create comando:

    Linux, macOS o Cloud Shell

    gcloud logging saved-queries create --display-name=DISPLAY_NAME \
 --location=LOCATION --visibility=VISIBILITY --sql-query-text=SQL_QUERY \
 --id=ID --description=DESCRIPTION --project=PROJECT_ID

    Windows (PowerShell)

    gcloud logging saved-queries create --display-name=DISPLAY_NAME `
 --location=LOCATION --visibility=VISIBILITY --sql-query-text=SQL_QUERY `
 --id=ID --description=DESCRIPTION --project=PROJECT_ID

    Windows (cmd.exe)

    gcloud logging saved-queries create --display-name=DISPLAY_NAME ^
 --location=LOCATION --visibility=VISIBILITY --sql-query-text=SQL_QUERY ^
 --id=ID --description=DESCRIPTION --project=PROJECT_ID

    Di seguito è riportato un esempio di risposta quando l'ID fornito nel comando era my-saved-query:

    Created saved query [projects/PROJECT_ID/locations/LOCATION/savedQueries/my-saved-query].

    La risposta al comando create elenca il nome completo della query, che include l'ID della query. L'ID query, che in questo esempio è my-saved-query, è un input obbligatorio per i comandi Google Cloud CLI che descrivono, eliminano o aggiornano una query salvata.

  2. Per esaminare la query salvata, esegui il comando seguente:

     gcloud logging saved-queries list --location=- --project=PROJECT_ID

    Nell'espressione precedente, il valore della località è un trattino (-), che funge da carattere jolly. Puoi anche fornire una località specifica.

Esistono comandi Google Cloud CLI per eliminare, elencare, descrivere e aggiornare le query salvate. Per saperne di più, consulta la panoramica di gcloud logging saved-queries.

REST

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

Per eseguire questo metodo:

  1. Seleziona savedQueries.create.
  2. Nella pagina di riferimento, utilizza Explorer API per eseguire 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"
   }
}

Condividi una query

Puoi condividere una query salvata con tutti gli utenti che hanno accesso al tuo Google Cloud progetto. Tuttavia, i ruoli IAM dell'entità 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 membro del team. Quando visualizzi i risultati della query nella pagina Observability Analytics, puoi copiare un URL che, una volta aperto, visualizza la query eseguita e i relativi risultati.

Per condividere una query e i risultati con un membro del team:

  1. Nella Google Cloud console, vai alla Observability Analytics pagina:

    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 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 membro del team.

    Quando il membro del team apre il link, la pagina Observability Analytics si apre e visualizza la query, ma non la esegue. Il membro del team deve eseguire manualmente la query.

    La pagina Observability Analytics mostra una finestra di dialogo di avviso quando la query viene eseguita sul motore BigQuery e le risorse su cui è stata eseguita la 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 membro del team sul Google Cloud progetto deve includere le autorizzazioni necessarie per visualizzare la pagina Observability Analytics.

gcloud

Quando vuoi creare una query salvata che possa essere eseguita da altri utenti, imposta il valore del campo visibility su shared:

--visibility=shared

Per modificare la visibilità di una query salvata esistente, utilizza il comando update. Per saperne di più sui comandi disponibili, consulta la gcloud logging saved-queries panoramica.

REST

Puoi utilizzare l'API Logging per creare una query condivisa utilizzando il metodo savedQueries.create e specificando un valore SHARED nel campo visibility. Per saperne di più, 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 Altre opzioni menu.

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 Altre opzioni menu.

Passaggi successivi