Salvare e condividere le query

Observability Analytics ti consente di salvare e condividere query SQL in modo da poter rieseguire le indagini frequenti di Cloud Trace e collaborare con i membri del team nel tuo progetto. Le query salvate possono essere mantenute private per uso personale o condivise con altri membri del progetto. Se non hai scritto query in Observability Analytics, consulta prima Eseguire query e analizzare le tracce.

Prima di iniziare

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

Configura il progetto e i ruoli

  1. Accedi al tuo account Google Cloud . 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, if it is not already enabled.

    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, if it is not already enabled.

    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. Per ottenere le autorizzazioni necessarie per caricare la pagina Analisi dell'osservabilità, scrivere, eseguire e salvare query private sui dati di traccia, chiedi all'amministratore di concederti i seguenti ruoli IAM:

    • Observability View Accessor (roles/observability.viewAccessor) sulle viste di osservabilità che vuoi interrogare. Questo ruolo supporta le condizioni IAM, che consentono di limitare la concessione a una visualizzazione specifica. Se non colleghi una condizione alla concessione del ruolo, l'entità può accedere a tutte le visualizzazioni di osservabilità.
    • Utente Observability Analytics (roles/observability.analyticsUser) sul tuo progetto. Questo ruolo contiene le autorizzazioni necessarie per salvare ed eseguire query private ed eseguire query condivise.

    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.

Seleziona l'interfaccia che intendi utilizzare

Console

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

gcloud

Nella console Google Cloud , attiva Cloud Shell.

Attiva Cloud Shell

Nella parte inferiore della console Google Cloud 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à 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 documentazione sull'autenticazione di Google Cloud .

Salva una query

Tutte le query eseguite 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 colleghi, 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 progetto Google Cloud .

Console

Per salvare una query:

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

    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 dalla scheda Salvate.

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

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

  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 di visualizzare ed eseguire la query salvata per la visualizzazione del progetto Google Cloud , 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; 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 posizione della query salvata.
    • VISIBILITY: impostato su private o shared.
    • SQL_QUERY: una query SQL. Se le virgolette singole (`) racchiudono il percorso o i campi all'interno del percorso, devi eseguire l'escape di queste virgolette:
          "SELECT * FROM \`PROJECT_ID.LOCATION.my-log-bucket._AllLogs\`"
          

      o

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

      I backquote (`) sono necessari 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 durante la creazione di una query salvata, il sistema genera un ID numerico.
    • DESCRIPTION: Una descrizione testuale della query. Facoltativo.
    • PROJECT_ID: l'identificatore del progetto.

    Esegui il comando gcloud logging saved-queries create:

    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 questo comando:

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

    Nell'espressione precedente, il valore della posizione è un trattino (-), che funge da carattere jolly. Puoi anche fornire una posizione 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 metodo savedQueries.create.

Per eseguire questo metodo:

  1. Seleziona savedQueries.create.
  2. Nella pagina di riferimento, utilizza Explorer API per emettere 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 progettoGoogle Cloud . Tuttavia, i ruoli IAM dell'entità determinano se la query può essere eseguita e i dati che restituisce.

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 Observability Analytics:

    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 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 Observability Analytics, ma la query non viene eseguita. Il tuo compagno di squadra 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 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 Observability Analytics.

gcloud

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

--visibility=shared

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

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