Monitorare i risultati delle query SQL con una criterio di avviso

Questo documento spiega come creare una criterio di avviso per monitorare i risultati di una query eseguita in Observability Analytics. Queste query sono scritte in SQL e devono eseguire query su una vista di osservabilità denominata _AllSpans. La criterio di avviso ti invia una notifica quando il risultato della query soddisfa le condizioni specificate.

I criteri di avviso creati dalla pagina Observability Analytics vengono eseguiti su un motore BigQuery. Pertanto, i dati sottoposti a query devono essere accessibili tramite un set di dati BigQuery collegato.

Per informazioni generali su Observability Analytics, consulta Eseguire query e analizzare le tracce con Observability Analytics.

Come funzionano i criteri di avviso

Una criterio di avviso descrive le circostanze in cui vuoi ricevere un avviso e come vuoi ricevere una notifica relativa a un incidente. Esistono diversi approcci che puoi utilizzare per ricevere una notifica quando nei dati di traccia vengono visualizzati contenuti o pattern:

  • Per monitorare il numero di intervalli di Cloud Trace importati al mese, l'utilizzo della quota e la frequenza di importazione degli intervalli, crea criteri di avviso in Cloud Monitoring. Se non hai mai creato un criterio di avviso, consulta Crea criteri di avviso per informazioni dettagliate sull'utilizzo della console Cloud Monitoring.

  • Per visualizzare o esplorare singole tracce o intervalli oppure visualizzare gli attributi collegati agli intervalli, utilizza la pagina Esplora tracce. Per informazioni su questa pagina, consulta Trovare ed esplorare le tracce.

  • Per monitorare l'analisi aggregata dei dati di traccia, combina Observability Analytics con i criteri di avviso. In questo scenario, utilizzi le query SQL per eseguire query sulla vista _AllSpans nel bucket di osservabilità denominato _Trace. Infine, crei la criterio di avviso per monitorare i risultati della query SQL. Questo tipo di criterio di avviso è chiamato criterio di avviso basato su SQL.

    Per scoprire di più su come vengono archiviati i dati di traccia, consulta Panoramica dell'archiviazione.

    Il resto di questo documento descrive come utilizzare i criteri di avviso basati su SQL.

Componenti delle policy di avviso

Una criterio di avviso basata su SQL contiene una condizione e una pianificazione:

  • La condizione contiene la query, ovvero una query SQL che esegue query sui dati. La condizione definisce anche le circostanze in cui il risultato della query fa sì che Monitoring crei un incidente.

  • La pianificazione definisce la frequenza con cui la criterio di avviso esegue la query. La pianificazione definisce anche le dimensioni della finestra temporale, ovvero un filtro che seleziona solo i dati ricevuti dall'ultima volta che la query è stata valutata. Ad esempio, se imposti la pianificazione su 60 minuti, la query viene eseguita ogni 60 minuti utilizzando una finestra temporale che seleziona i 60 minuti di dati più recenti.

I criteri di avviso contengono anche un elenco di canali di notifica. Quando la condizione della criterio di avviso viene soddisfatta, Cloud Monitoring crea un incidente e invia notifiche sull'incidente tramite questi canali. Un incidente è un record dei dati che hanno causato il soddisfacimento della condizione, insieme ad altre informazioni pertinenti. Queste informazioni possono aiutarti a risolvere i problemi che hanno causato l'incidente. Puoi visualizzare l'incidente utilizzando la Google Cloud console.

Tipi di valutazione per i criteri di avviso basati su SQL

Le condizioni che monitorano il risultato di una query SQL supportano due tipi di valutazione:

  • Soglia del conteggio delle righe: la condizione viene soddisfatta quando il numero di righe nel risultato della query è maggiore, uguale o inferiore a un valore di soglia.

  • Booleano: la condizione viene soddisfatta quando una colonna booleana specifica nella tabella dei risultati della query contiene una riga con un valore true.

I criteri di avviso che monitorano il risultato di una query SQL devono avere una sola condizione.

Criteri di avviso e BigQuery

Affinché una criterio di avviso possa eseguire query sui dati di traccia, devi configurare un set di dati BigQuery collegato. I set di dati BigQuery collegati consentono a BigQuery di leggere i dati di traccia e di eseguire funzioni BigQuery sui dati restituiti dalla query SQL.

Quando un criterio di avviso esegue una query SQL, questa viene eseguita sul motore BigQuery nel Google Cloud progetto in cui è definito il criterio di avviso. Per impostazione predefinita, le query eseguite sul motore BigQuery utilizzano slot on demand. Gli slot on demand e gli slot riservati sono soggetti a prezzi di BigQuery.

Puoi anche scegliere di configurare le prenotazioni di slot BigQuery dedicati per il tuo progetto:

  1. Crea una prenotazione con slot dedicati o identifica una prenotazione esistente.
  2. Crea assegnazioni di prenotazioni per il tuo progetto.

Finestra temporale e tempo di propagazione degli incidenti

Quando è pianificata la valutazione della condizione di un criterio di avviso, Observability Analytics ritarda l'esecuzione della query SQL di cinque minuti per consentire a Cloud Logging di indicizzare i dati ricevuti durante la finestra temporale. Ad esempio, se la criterio di avviso utilizza una finestra temporale che termina alle 14:00, Observability Analytics non esegue la query SQL fino alle 14:05.

Se la condizione di avviso viene soddisfatta dopo l'esecuzione della query, la propagazione dell'incidente nel sistema può richiedere fino a due minuti aggiuntivi.

Errori delle query

Le query emesse dai criteri di avviso basati su SQL possono non riuscire per vari motivi, tra cui:

  • Il service account Monitoring non esiste più o non dispone più delle autorizzazioni necessarie per leggere i dati di traccia sottoposti a query.

  • Il tempo di esecuzione della query supera i cinque minuti.

  • Si verifica un errore interno.

Una query non riuscita genera una voce di log contenente l'ID del criterio di avviso e lo stato dell'errore. Puoi utilizzare un criterio di avviso basato su log per creare un avviso quando viene registrato un errore.

Prima di iniziare

Questa sezione presuppone che tu abbia un set di dati BigQuery collegato per i dati di traccia.

Prima di creare un criterio di avviso basato su SQL, completa i seguenti passaggi:

  1. Per ottenere le autorizzazioni necessarie per eseguire query sui dati di traccia e creare criteri di avviso basati su SQL, chiedi all'amministratore di concederti i seguenti ruoli IAM nel tuo progetto:

  2. Verifica che il service account Monitoring esista e che abbia i seguenti ruoli:

    1. Agente del servizio Monitoring (roles/monitoring.notificationServiceAgent) nel tuo progetto.
    2. Visualizzatore dati BigQuery (roles/bigquery.dataViewer) nel set di dati BigQuery collegato.

    Se il service account Monitoring non esiste, consulta Risoluzione dei problemi: nessun service account Monitoring.

  3. Configura i canali di notifica che vuoi utilizzare per ricevere le notifiche relative agli incidenti. Per motivi di ridondanza, ti consigliamo di creare più tipi di canali di notifica. Per saperne di più, consulta Crea e gestisci canali di notifica.

Creare una criterio di avviso basata su SQL

Per creare un criterio di avviso basato su SQL:

Console

  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. Nella pagina Observability Analytics, nell'editor di query, inserisci una query SQL che esegue query sui dati di traccia.

  3. Nella barra degli strumenti, fai clic su Esegui su BigQuery.

    Observability Analytics esegue la query sul motore BigQuery e visualizza i risultati nella tabella Risultati.

    Se non viene visualizzato Esegui su BigQuery, fai clic su Seleziona motore di query e poi su BigQuery. Il pulsante Esegui query diventa Esegui su BigQuery.

  4. Nella tabella Risultati della pagina Observability Analytics, fai clic su  Crea avviso.

    La pagina Observability Analytics mostra la finestra Crea criterio di avviso SQL, che mostra la query nella sezione Query SQL.

  5. Nella sezione Condizione di avviso , configura la condizione e la pianificazione della criterio di avviso.

  6. Configura i dettagli della criterio di avviso.

    1. Aggiungi canali di notifica e configura i contenuti delle notifiche, ad esempio una riga dell'oggetto personalizzata.

    2. (Facoltativo) Aggiungi etichette delle policy di avviso e documentazione.

    3. Fai clic su Avanti.

  7. Esamina la criterio di avviso e creala facendo clic su Salva.

Terraform

  1. Installa e configura Terraform per il tuo progetto. Per le configurazioni di App Hub, seleziona il progetto host di App Hub o il progetto di gestione.

  2. In Cloud Shell, vai alla directory contenente la configurazione di Terraform.

  3. Nella configurazione di Terraform, configura un'istanza della google_monitoring_alert_policy, inclusa condition_sql.

  4. In Cloud Shell, inserisci terraform apply.

Per modificare il criterio di avviso, apporta le modifiche e poi riapplica la configurazione di Terraform. Per saperne di più, consulta Gestire i criteri di avviso con Terraform.

Per informazioni generali sull'utilizzo di Google Cloud Terraform, consulta Terraform con Google Cloud.

REST

Utilizza il alertPolicies.create metodo per creare criteri di avviso a livello di programmazione. Il Condition tipo del criterio di avviso deve essere MonitoringQueryLanguageCondition, che è un'istanza di SqlCondition. Questo tipo di condizione consente di definire le condizioni del criterio di avviso con SQL.

Per definire la pianificazione, imposta un valore periodicity per uno dei campi minutes, hours o days. Ad esempio, se vuoi che la query venga eseguita ogni 12 ore, imposta la periodicità del campo hours su 12.

Per definire la condizione, utilizza i seguenti campi:

  • boolean_test: configura la criterio di avviso in modo che la condizione venga soddisfatta quando una riga di una colonna booleana nella tabella dei risultati della query contiene un valore true.
  • row_count_test: configura la criterio di avviso in modo che la sua condizione venga soddisfatta quando il numero di righe nella tabella dei risultati della query soddisfa una determinata soglia.

Per un elenco completo dei campi e delle definizioni, consulta SqlCondition nella documentazione dell'API Cloud Monitoring.

Per saperne di più sull'API Monitoring per i criteri di avviso, consulta Gestire i criteri di avviso tramite l'API.

Limitazioni

  • Puoi avere una sola condizione per criterio di avviso basata su SQL.
  • I criteri di avviso basati su SQL non possono eseguire query su una vista Analytics.

  • Le query emesse dai criteri di avviso basati su SQL non riescono quando il tempo di esecuzione supera i cinque minuti.

  • Si verifica un ritardo fino a sette minuti, più il tempo di esecuzione della query, tra la pianificazione di una query e la creazione di un incidente.

Per un elenco completo dei limiti associati ai criteri di avviso, consulta Limiti di Monitoring.

Passaggi successivi