Mostrare gli eventi su 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. La visualizzazione delle annotazioni degli eventi può aiutarti a correlare i dati di origini diverse durante la risoluzione di un problema.

Questa funzionalità è supportata solo per i Google Cloud progetti. Per le configurazioni di App Hub, seleziona il progetto host di App Hub o il progetto di gestione.

Informazioni sulle annotazioni degli eventi

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

A meno che tu non utilizzi l'API Cloud Monitoring o intraprenda un'azione per salvare le selezioni dei tipi di eventi, queste si applicano solo alla sessione corrente. Quando utilizzi la Google Cloud console, le selezioni vengono salvate se le fissi.

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

Tipi di eventi consigliati

Potresti visualizzare i seguenti tipi di eventi abilitati in una dashboard o in una scheda Osservabilità, anche se non hai selezionato alcun tipo di evento:

• Avviso aperto.
• Incidente di Personalized Service Health, quando l'API Service Health è abilitata.
• Un tipo di evento per ogni tipo di risorsa con dati visualizzati nella dashboard.

Quando un tipo di evento viene aggiunto automaticamente, è un tipo di evento consigliato. Puoi lasciare questi tipi di eventi nello stato consigliato, salvarli nel JSON della dashboard o ignorarli, il che rimuove il consiglio. Per determinare quali tipi di eventi vengono 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 da mostrare nella dashboard:

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

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

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

Come vengono mostrati gli eventi

Nota: per motivi di prestazioni, le dashboard limitano il numero di eventi visualizzati. Quando vengono raggiunti questi limiti, le dashboard mostrano solo gli eventi più recenti. Per visualizzare gli eventi precedenti, utilizza un intervallo di tempo più breve o aggiungi filtri.

Per tutti gli eventi, man mano che si verificano, i grafici della dashboard vengono annotati. Gli eventi identificati analizzando le voci di log vengono visualizzati con un singolo riferimento temporale. Al contrario, gli eventi di Service Health vengono visualizzati 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 visualizza diversi eventi identificati analizzando le voci di log e un evento di Service Health:

Come mostrato nello screenshot precedente, la descrizione comando di 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 di prodotti e località interessati. Per elencare i prodotti o le località 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, in modo da poter visualizzare le voci di log, oppure potrebbe aprire la pagina dei dettagli per un evento di Service Health.

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

Prima di iniziare

Completa i seguenti passaggi per il Google Cloud progetto in cui vuoi visualizzare gli eventi nelle dashboard:

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

  • Visualizza e crea dashboard e policy di avviso: Monitoring Editor (roles/monitoring.editor).
  • Visualizza e mostra gli eventi identificati dalle voci di log non di accesso ai dati create nel tuo Google Cloud progetto: Logs Viewer (roles/logging.viewer).
  • Visualizza e mostra gli eventi identificati da qualsiasi voce di log creata nel tuo Google Cloud progetto: Private Logs Viewer (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 Gestisci l'accesso a progetti, cartelle e organizzazioni.

  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 dashboard, abilita l'API Service Health:

  Ruoli richiesti per abilitare le API

  Per abilitare le API, devi disporre del ruolo IAM Amministratore utilizzo servizi (roles/serviceusage.serviceUsageAdmin), che contiene l'autorizzazione serviceusage.services.enable. Scopri come concedere i ruoli.

  Abilitare 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 in nella pagina Dashboard della Google Cloud console per mostrare gli eventi.

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

Console

Per mostrare gli eventi in una dashboard:

1. Nella Google Cloud console, 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. Nella barra degli strumenti della Google Cloud console, seleziona il tuo Google Cloud progetto. Per le configurazioni di App Hub, seleziona il progetto host di App Hub o il progetto di gestione.
3. Seleziona la dashboard che vuoi visualizzare.
4. Nella barra degli strumenti della dashboard, fai clic su Annotazioni e seleziona i tipi di eventi che vuoi visualizzare nella dashboard.

5. Esegui una delle seguenti operazioni:

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

     Quando fissi le selezioni, modifichi la definizione JSON della dashboard. Di conseguenza, quando la dashboard viene riaperta, le selezioni vengono caricate e la dashboard mostra le annotazioni per i tipi di eventi corrispondenti.

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

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

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

API

Per configurare una dashboard personalizzata in modo che mostri gli eventi, includi 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 Google Cloud progetti in cui cercare gli eventi. Se non specifichi questo campo, viene eseguita la ricerca nel progetto selezionato.

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

  • Un campo displayName, che consente di definire l'etichetta dell'opzione di attivazione/disattivazione specifica dell'evento. Se questo campo non è specificato o se il suo valore è una stringa vuota, viene visualizzato il nome predefinito dell'evento.
  • Un campo enabled, che controlla il valore dell'opzione di attivazione/disattivazione dell'evento. Se true, l'opzione di attivazione/disattivazione è in posizione on e gli eventi vengono visualizzati nella dashboard. Se false, l'opzione di attivazione/disattivazione è in 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. Se il valore di questo campo è una stringa vuota, viene utilizzata la query specifica dell'evento.
  • Un campo resourceNames, che consente di definire un elenco di Google Cloud progetti in cui cercare gli eventi. Se questo campo è un array vuoto, viene eseguita la ricerca 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 Crea e gestisci le dashboard tramite l'API ed Esempio: abilita gli eventi nelle dashboard.

Configura 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 Osservabilità che mostra i dati di metriche e log.

Nota: non tutte le schede Osservabilità possono essere configurate per mostrare gli eventi.

Console

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

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

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

2. Assicurati che il menu Dashboard sia impostato su Predefinito. 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 degli eventi da mostrare, vengono eseguite le query per recuperare i dati degli eventi e la dashboard viene aggiornata.

   Quando il menu Annotazioni non viene visualizzato, la scheda non può essere configurata per mostrare gli eventi.

API

Non disponibile.

Visualizza i dettagli degli eventi

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 aperta dal pulsante Visualizza è determinata dal tipo di evento. Google Cloud 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 Google Cloud progetto, puoi ricevere una notifica quando si verificano questi eventi configurando un avviso basato su log. Le policy di avviso basate su log eseguono query sulle voci di log man mano che vengono ricevute. Quando la query restituisce un risultato non vuoto, viene creato un incidente e vengono inviate le notifiche.

Console

Nota: per creare una criterio di avviso per un evento che stai visualizzando, attiva la descrizione comando dell'evento, fai clic su Visualizza log e poi procedi al passaggio di creazione dell'avviso nella procedura seguente.

Per creare un avviso basato su log:

1. Se non hai configurato un canale di notifica:

   1. Nella Google Cloud console, 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. Nella barra degli strumenti della Google Cloud console, seleziona il tuo Google Cloud progetto. Per le configurazioni di App Hub, seleziona il progetto host di App Hub o il progetto di gestione.
   3. Fai clic su Modifica canale di notifica.
   4. Vai al tipo di canale di notifica che vuoi configurare, fai clic su Aggiungi nuovo e completa la finestra di dialogo.

2. Nella Google Cloud console, vai alla pagina segmento 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 della Google Cloud console, seleziona il tuo Google Cloud progetto.

4. Nella barra degli strumenti, seleziona Crea avviso.

5. Inserisci un nome per la criterio di avviso e fai clic su Avanti.

6. Nella sezione Definisci le voci di log per cui generare 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 all'uso in una criterio di avviso basata su log.

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

API

Per creare una criterio di avviso basata su log utilizzando l'API Cloud Monitoring:

1. Identifica la query da includere nella condizione della criterio di avviso. Per ogni tipo di evento, la pagina Tipi di eventi elenca una query adatta all'uso in una criterio di avviso basata su log.

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

3. Richiama il metodo API alertPolicies.create. Ad esempio, puoi eseguire il gcloud monitoring policies create comando.

Nascondi eventi

Console

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

Per nascondere un tipo di evento, fai clic su Annotazioni, deseleziona il tipo di evento e poi seleziona Applica.

API

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

Per informazioni dettagliate su come utilizzare l'API Cloud Monitoring, consulta Crea e gestisci le dashboard tramite l'API.

Passaggi successivi

• Condividi una dashboard personalizzata
• Esplorazione dei dati dei grafici
• Accedi alle dashboard specifiche delle risorse
• Aggiungi filtri temporanei alle dashboard personalizzate
• Aggiungi filtri permanenti alle dashboard personalizzate