Mostrare gli eventi in una dashboard

Questo documento descrive come configurare una dashboard per mostrare le annotazioni degli eventi. Un evento è un'attività, ad esempio un deployment o un arresto anomalo, che influisce sul funzionamento di un sistema. Mostrare le annotazioni degli eventi può aiutarti a correlare da fonti diverse quando cerchi di risolvere un problema.

Informazioni sulle annotazioni degli eventi

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

A meno che non utilizzi l'API Cloud Monitoring o non intervieni per salvare i tuoi dei tipi di evento selezionati, le selezioni si applicano solo alla sessione corrente. Quando utilizzi la console Google Cloud, bloccando le selezioni vengono salvate.

Per un elenco dei tipi di eventi, riferimenti per la risoluzione dei problemi e altre informazioni, consulta la pagina Tipi di eventi.

Potresti vedere i seguenti tipi di eventi abilitati in una dashboard o in una scheda Osservabilità, anche se non ne hai selezionato nessuno:

Quando un tipo di evento viene aggiunto automaticamente, si tratta di un tipo di evento consigliato. Puoi lasciare questi tipi di eventi nello stato consigliato e salvarli nel JSON della dashboard, o ignorarli, per rimuovere il suggerimento. Per determinare i tipi di eventi salvati, espandi il menu Annotazioni e visualizza la sezione Fissati.

Come vengono identificati gli eventi

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

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

  • Gli eventi Personalized Service Health sono identificati dalle query inviate da Monitoring 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 passa attraverso i sink di Cloud Logging nel tuo progetto Google Cloud. Queste voci di log includono quelle generate dal progetto e quelli indirizzati al tuo 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 indicata nella pagina Tipi di evento.

Come vengono mostrati gli eventi

Per tutti gli eventi, man mano che si verificano, i grafici della dashboard vengono annotati. Gli eventi identificati dall'analisi delle voci di log vengono visualizzati con un'unica riferimento temporale. Al contrario, gli eventi di Service Health vengono mostrati con un'ora di inizio e lo sfondo del grafico viene modificato per la durata dell'evento. Questi eventi mostrano anche un'icona a forma di cuore.

Lo screenshot seguente mostra un grafico che indica diversi eventi identificati analizzando le voci di log e un evento relativo allo stato del servizio:

Grafico che mostra le annotazioni degli eventi di avviso e informativi.

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

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

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

Prima di iniziare

  • Per ottenere le autorizzazioni necessarie per visualizzare e mostrare gli eventi nelle dashboard e per creare criteri di avviso, chiedi all'amministratore di concederti i seguenti ruoli IAM nel 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 tuo progetto Google Cloud: Visualizzatore log privati (roles/logging.privateLogViewer).
    • Visualizza gli eventi relativi allo stato del servizio: Visualizzatore di Personalized Service Health (roles/servicehealth.viewer)

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

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

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

    Enable the API

Mostra eventi

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

Configurare 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 di tipi di eventi, riferimenti per la risoluzione dei problemi e query che può essere utilizzato con Esplora log o con criteri di avviso basati su log, consulta la pagina Tipi di evento.

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, fai clic su Annotazioni e seleziona i tipi di eventi che vuoi visualizzare nella dashboard.

  4. Esegui una di queste operazioni:

    • Per salvare le selezioni in modo che gli eventi vengano visualizzati quando ricarichi la dashboard, fai clic su Fissa elementi selezionati. Se hai disattivato il salvataggio automatico nella dashboard, vai alla barra degli strumenti della dashboard e fai clic su Salva.

      Quando blocchi le selezioni, modifichi la definizione JSON del Fitbit.com. Pertanto, quando la dashboard viene riaperta, le selezioni vengono caricati e la dashboard mostra le annotazioni per i tipi di eventi.

    • Per visualizzare i tipi di evento solo per la sessione corrente, fai clic su Applica.

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

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

API

Per configurare una dashboard personalizzata per mostrare gli 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 gli eventi. Se non specifichi questo campo, viene eseguita la ricerca del progetto selezionato.

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

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

Di seguito è riportato un esempio di oggetto annotations per un 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 dashboard tramite API e Esempio: attivare gli 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, fornisci una scheda Observabilità che mostri metriche e dati di log.

Console

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

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

    Ad esempio, potresti andare alla pagina Cluster Kubernetes e seleziona la scheda Osservabilità. Analogamente, puoi andare alla pagina Carichi di lavoro Kubernetes o alla pagina dei dettagli di un'istanza della macchina virtuale (VM) e selezionare la scheda Osservabilità.

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

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

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

    Quando il menu Annotazioni di non è visualizzata, 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 ulteriori informazioni.

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

La pagina della console Google Cloud aperta tramite il pulsante Visualizza dipende da: tipo di evento. Ad esempio, per un evento di controllo di uptime, questo pulsante apre la dashboard per il controllo di uptime. Per un altro tipo di evento, potrebbe aprire Esplora log.

Crea criteri di avviso

Quando gli eventi vengono identificati analizzando le voci di log che passano per gli sink di Cloud Logging nel progetto Google Cloud, puoi ricevere una notifica quando si verificano configurando un avviso basato su log. I criteri di avviso basati su log eseguono query sulle voci di log man mano che vengono ricevute. Quando la query restituisce un campo non vuoto viene creato un incidente e vengono inviate 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 utilizzi 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 avvisi, inserisci una query o aggiorna la query copiata dal riquadro Query quando hai selezionato Crea avviso.

    Per ogni tipo di evento, la pagina Tipi di eventi elenca una query adatta per l'utilizzo 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, Nella pagina Tipi di evento è elencata una adatta all'uso in un criterio di avviso basato su log.

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

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

Nascondi eventi

Console

Per nascondere tutti gli eventi, nella barra degli strumenti della dashboard, fai clic su Annotazioni, seleziona Cancella e poi Applica.

Per nascondere un tipo di evento, fai clic su Annotazioni, cancella la selezione per quel tipo di evento e seleziona Applica.

API

Per nascondere un tipo di evento in una dashboard personalizzata, trova EventAnnotation per il tipo di evento, e poi imposta il campo enabled su false.

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

Passaggi successivi