Mostrare gli eventi in una dashboard

Questo documento descrive come mostrare gli eventi nei grafici in una dashboard. Un evento è un'attività, ad esempio un deployment o un arresto anomalo, che influisce sul funzionamento di un sistema. La visualizzazione degli eventi può aiutarti a correlare i dati provenienti da origini diverse durante la risoluzione di un problema.

Puoi mostrare gli eventi nella maggior parte delle dashboard elencate nella pagina Dashboard della console Google Cloud. Allo stesso modo, puoi configurare alcune schede Observability specifiche del servizio, ad esempio quelle per Compute Engine e Google Kubernetes Engine, per mostrare gli eventi. Per configurare i tipi di eventi mostrati in una dashboard o in una scheda Osservabilità, puoi utilizzare la console Google Cloud. Per le dashboard personalizzate, puoi anche usare l'API Cloud Monitoring.

Come vengono identificati gli eventi

Le dashboard eseguono query su diverse origini dati per identificare gli eventi da mostrare nella dashboard:

  • Gli eventi di avviso sono identificati da Monitoring. Gli eventi di avviso forniscono informazioni su quando sono stati aperti gli incidenti.

  • Gli eventi di Service Health personalizzati sono identificati dalle query che Monitoring invia all'API Service Health. Questi eventi indicano quando si verifica un'interruzione di un servizio Google Cloud.

  • Tutti gli altri tipi di eventi vengono identificati analizzando le voci di log che passano attraverso i sink di Cloud Logging nel progetto Google Cloud. Queste voci di log includono quelle generate dal progetto e quelle instradate al progetto. Per ricevere una notifica quando si verifica uno di questi eventi, puoi creare un criterio di avviso basato su log. Nel criterio di avviso, utilizza le query fornite nella pagina Tipi di eventi.

Come vengono mostrati gli eventi

Per tutti gli eventi, man mano che si verificano, i grafici nella dashboard sono annotati. Gli eventi identificati mediante l'analisi delle voci di log vengono mostrati con un unico riferimento temporale. Al contrario, gli eventi di Service Health vengono mostrati con un'ora di inizio e lo sfondo del grafico viene modificato per l'intera durata dell'evento. Questi eventi mostrano anche l'icona di un cuore.

Il seguente screenshot illustra un grafico che mostra diversi eventi identificati dall'analisi delle voci di log e un evento Service Health:

Grafico che mostra annotazioni relative ad avvisi e eventi informativi.

Come mostrato nello screenshot precedente, la descrizione comando per un evento include informazioni come le seguenti:

  • Nome evento.
  • Data e ora di inizio dell'evento.
  • Per gli eventi di Service Health, chip che mostrano il numero di prodotti e località interessati. Per elencare le località o i prodotti interessati, posiziona il puntatore sul chip corrispondente.
  • Un pulsante Visualizza, che, se selezionato, apre una pagina che mostra ulteriori informazioni sull'evento. Ad esempio, potrebbe aprire Esplora log per visualizzare le voci di log o aprire la pagina dei dettagli per un evento di Service Health.

I filtri della dashboard, che limitano i dati mostrati da una dashboard, in genere filtrano sia i dati delle serie temporali sia gli eventi.

Prima di iniziare

  • Per ottenere le autorizzazioni necessarie per visualizzare e mostrare gli eventi sulle dashboard e per creare criteri di avviso, chiedi all'amministratore di concederti i seguenti ruoli IAM nel tuo progetto:

    • Visualizza e crea dashboard e criteri di avviso: Editor Monitoring (roles/monitoring.editor).
    • Visualizza e mostra gli eventi identificati da voci di log di accesso non ai dati create nel tuo progetto Google Cloud: Visualizzatore log (roles/logging.viewer).
    • Visualizza e mostra gli eventi identificati da qualsiasi voce di log creata nel progetto Google Cloud: Visualizzatore log privati (roles/logging.privateLogViewer).
    • Visualizza gli eventi di Service Health: Personalized Service Health Viewer (roles/servicehealth.viewer)

    Per saperne di più sulla concessione dei ruoli, consulta Gestire l'accesso.

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

  • Se vuoi mostrare gli eventi di Service Health nella tua dashboard, abilita l'API Service Health:

    Abilita l'API

Mostra eventi

Questa sezione descrive come configurare una dashboard o una scheda Osservabilità per mostrare gli eventi.

Configura le dashboard per mostrare gli eventi

Questa sezione descrive come configurare le dashboard elencate nella pagina Dashboard della console Google Cloud per mostrare gli eventi.

Per un elenco dei tipi di eventi, dei riferimenti per la risoluzione dei problemi e delle query che possono essere utilizzati con Esplora log o con criteri di avviso basati su log, consulta la pagina Tipi di eventi.

Console

Per visualizzare gli eventi in una dashboard, procedi nel seguente modo:

  1. Nella console Google Cloud, vai alla pagina Dashboard :

    Vai a Dashboard

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

  2. Seleziona la dashboard che vuoi visualizzare.

  3. Nella barra degli strumenti della dashboard, assicurati che l'opzione Eventi sia attiva.

    Se il pulsante di attivazione/disattivazione Eventi di non viene visualizzato, significa che la dashboard non può mostrare gli eventi.

  4. Fai clic su Seleziona tipi di eventi, seleziona i tipi di eventi che vuoi che vengano visualizzati nella dashboard, quindi esegui una delle seguenti operazioni:

    • Se stai visualizzando una dashboard personalizzata e vuoi salvare le selezioni relative ai tipi di evento, fai clic su Fissa elementi selezionati. Se l'opzione di salvataggio automatico è disattivata nella dashboard, vai alla barra degli strumenti della dashboard e fai clic su Salva.

      Quando blocchi le selezioni, modifichi la definizione JSON della dashboard. Di conseguenza, alla riapertura della dashboard, le selezioni vengono caricate e la dashboard mostra le annotazioni per i tipi di eventi corrispondenti.

    • In caso contrario, fai clic su Ok.

    Dopo aver aggiornato l'elenco dei tipi di eventi da visualizzare, Cloud Monitoring genera delle query, il che richiede alcuni istanti, poi aggiunge le annotazioni ai grafici della dashboard.

  5. Per visualizzare il riepilogo di un evento o per accedere ai link a informazioni aggiuntive, utilizza il puntatore per attivare la descrizione comando.

API

Per configurare una dashboard personalizzata per la visualizzazione degli eventi, includere un campo annotations nell'oggetto Dashboard. Il campo annotations contiene un'istanza di un oggetto DashboardAnnotations, che contiene due campi:

  • Il campo defaultResourceName elenca i valori predefiniti a livello di dashboard per i progetti Google Cloud in cui cercare eventi. Se non specifichi questo campo, la ricerca viene eseguita nel progetto selezionato.

  • Un array di oggetti EventAnnotation. Ogni oggetto contiene quanto segue:

    • Un campo displayName, che consente di definire l'etichetta sul pulsante di attivazione/disattivazione specifico dell'evento. Quando questo campo non viene specificato o se il valore di questo campo è una stringa vuota, viene mostrato il nome predefinito dell'evento.
    • Un campo enabled, che controlla il valore del pulsante di attivazione/disattivazione dell'evento. Quando true, il pulsante di attivazione/disattivazione è nella posizione on e gli eventi vengono visualizzati nella dashboard. Quando false, il pulsante di attivazione/disattivazione è nella posizione off.
    • Un campo eventType, che contiene un valore dell'enumerazione EventType.
    • Un campo filter, che consente di specificare una query da aggiungere alla query specifica dell'evento. Quando il valore di questo campo è una stringa vuota, viene usata la query specifica dell'evento.
    • Un campo resourceNames, che consente di definire un elenco di progetti Google Cloud in cui cercare eventi. Quando questo campo è un array vuoto, la ricerca viene eseguita nel progetto selezionato.

Di seguito è riportato un esempio di oggetto annotations per un evento di aggiornamento del cluster. Il campo filter in questo esempio limita gli eventi a un cluster specifico:

"annotations": {
  "defaultResourceNames": [],
  "eventAnnotations": [
    {
      "displayName": "",
      "enabled": true,
      "eventType": "GKE_CLUSTER_UPDATE",
      "filter": "resource.labels.cluster_name=my-cluster",
      "resourceNames": []
    }
  ]
}

Per informazioni dettagliate su come utilizzare l'API Cloud Monitoring per creare dashboard, consulta Creare e gestire le dashboard in base all'API ed Esempio: attivazione degli eventi nelle dashboard.

Configurare la scheda Osservabilità per mostrare gli eventi

Questa sezione descrive come configurare la scheda Osservabilità per mostrare gli eventi. Alcuni servizi, come Compute Engine e Google Kubernetes Engine, forniscono una scheda Observabilità che mostra i dati di metriche e log.

Console

Per configurare la scheda Osservabilità in modo che mostri gli eventi:

  1. Vai alla scheda Osservabilità di un servizio o un prodotto.

    Ad esempio, potresti andare alla pagina Cluster Kubernetes e selezionare la scheda Osservabilità. Allo stesso modo, potresti andare alla pagina Carichi di lavoro Kubernetes o alla pagina dei dettagli di un'istanza di una macchina virtuale (VM), quindi selezionare la scheda Osservabilità.

  2. Assicurati che il menu Dashboard sia impostato su Predefinita. Gli eventi non possono essere mostrati nelle dashboard personalizzate.

  3. Nella barra degli strumenti, fai clic su Seleziona eventi e completa la finestra di dialogo.

    Dopo aver aggiornato l'elenco degli eventi da visualizzare, vengono eseguite query per recuperare i dati sugli eventi e quindi la dashboard viene aggiornata.

    Quando il pulsante Seleziona eventi non viene visualizzato, significa che la scheda non può essere configurata per mostrare gli eventi.

API

Non disponibile.

Visualizza i dettagli dell'evento

Quando visualizzi un grafico che mostra le annotazioni degli eventi, puoi utilizzare i link forniti nella descrizione comando per accedere a informazioni aggiuntive.

Per accedere ai dettagli di un evento specifico, fai clic su Visualizza.

La pagina della console Google Cloud aperta dal pulsante Visualizza è determinata dal tipo di evento. Ad esempio, per un evento di controllo di uptime, questo pulsante apre la dashboard per il controllo di uptime. Per un tipo di evento diverso, potrebbe aprirsi Esplora log.

Crea criteri di avviso

Quando gli eventi vengono identificati analizzando le voci di log che passano attraverso i sink di Cloud Logging nel tuo progetto Google Cloud, puoi ricevere notifiche quando si verificano questi eventi configurando un avviso basato su log. I criteri di avviso basati su log eseguono query sulle voci di log non appena vengono ricevute. Quando la query restituisce un risultato non vuoto, viene creato un incidente e vengono inviate le notifiche.

Console

Per creare un avviso basato su log, segui questi passaggi:

  1. Se non hai configurato un canale di notifica, procedi nel seguente modo:

    1. Nella console Google Cloud, vai alla pagina  Avvisi:

      Vai ad Avvisi

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

    2. Fai clic su Modifica canale di notifica.
    3. Vai al tipo di canale di notifica che vuoi configurare, fai clic su Aggiungi nuovo e completa la finestra di dialogo.

  2. Nella console Google Cloud, vai alla pagina Esplora log:

    Vai a Esplora log

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

  3. Nella barra degli strumenti, seleziona Crea avviso.

  4. Inserisci un nome per il criterio di avviso e fai clic su Avanti.

  5. Nella sezione Definisci le voci di log per cui inviare gli avvisi, inserisci una query o aggiorna la query che è stata copiata dal riquadro Query dopo aver selezionato Crea avviso.

    Per ogni tipo di evento, nella pagina Tipi di evento è elencata una query adatta a essere utilizzata in un criterio di avviso basato su log.

  6. Completa la finestra di dialogo e fai clic su Salva.

API

Per creare un criterio di avviso basato su log utilizzando l'API Cloud Monitoring, segui questi passaggi:

  1. Identifica la query da includere nella condizione del criterio di avviso. Per ogni tipo di evento, la pagina Tipi di evento elenca una query adatta a essere utilizzata in un criterio di avviso basato su log.

  2. Crea il file JSON che contiene la rappresentazione del criterio di avviso. Per ulteriori informazioni su questo passaggio e per un esempio, consulta Progettazione del criterio di avviso.

  3. Richiama il metodo API alertPolicies.create. Ad esempio, potresti inviare il comando gcloud alpha monitoring policies create.

Nascondi eventi

Console

Per nascondere tutti gli eventi, assicurati che l'opzione Eventi di sia disattivata nella barra degli strumenti della dashboard.

Per nascondere un tipo di evento, imposta l'opzione di attivazione/disattivazione per quel tipo di evento su Off.

API

Per nascondere un tipo di evento in una dashboard personalizzata, trova l'oggetto EventAnnotation per il tipo di evento, quindi imposta il campo enabled su false.

Per informazioni dettagliate su come utilizzare l'API Cloud Monitoring, consulta Creare e gestire dashboard in base all'API.

Passaggi successivi