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 il 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 di tipi di eventi, riferimenti per la risoluzione dei problemi e altre informazioni, consulta la pagina Tipi di evento.

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

Quando un tipo di evento viene aggiunto automaticamente, è uno dei tipi di eventi consigliati. Puoi lasciare questi tipi di eventi nello stato consigliato e salvarli nel JSON della dashboard, o ignorarli, per rimuovere il suggerimento. Per determinare quali tipi di eventi vengono salvati, espandi il menu Seleziona tipi di evento e poi visualizza la sezione Fissate.

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 eventi Service Health personalizzati sono identificati da delle 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 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 questi eventi, i grafici nella dashboard vengono visualizzati annotato. Gli eventi identificati mediante l'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 l'icona di un cuore.

Il seguente screenshot illustra un grafico che mostra diversi di eventi identificati analizzando le voci di log e 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 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 le località o i prodotti interessati, posiziona il puntatore sul chip corrispondente.
  • Un pulsante Visualizza, che, una volta selezionato, apre una pagina che mostra ulteriori informazioni le informazioni sull'evento. Ad esempio, potrebbe aprire Esplora log, per visualizzare le voci di log o aprire la pagina dei dettagli per un evento Service Health.

Filtri per la dashboard, che limitano i dati mostrati in una dashboard. in genere filtra 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 sul 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 tuo 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 la ruoli o altri ruoli predefiniti ruoli.

  • Se vuoi mostrare gli eventi di Service Health sui tuoi quindi 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 in la pagina Dashboard della console Google Cloud per visualizzare 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 Monitoraggio.

  2. Seleziona la dashboard che vuoi visualizzare.

  3. Nella barra degli strumenti della dashboard, assicurati che L'opzione Eventi è attiva.

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

  4. Fai clic su Seleziona tipi di eventi e scegli i tipi di eventi per i quali vuoi che venga per visualizzare la dashboard, quindi procedi in uno dei seguenti modi:

    • Se stai visualizzando una dashboard personalizzata e vuoi salvare il tipo di evento selezioni, quindi fai clic su Fissa selezionate. Se il salvataggio automatico è disattivato sulla dashboard, vai alla barra degli strumenti e fai clic su Salva.

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

    • In caso contrario, fai clic su OK.

    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: 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 Progetti Google Cloud per cercare eventi. Se non specifichi questo campo, viene eseguita la ricerca del progetto selezionato.

  • Un array di oggetti EventAnnotation. Ciascuna 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 mostrato il nome predefinito dell'evento.
    • Un campo enabled, che controlla il valore del pulsante di attivazione/disattivazione dell'evento. Quando true, l'opzione è nella posizione on e vengono mostrati gli eventi sulla dashboard. Quando false, il pulsante di attivazione/disattivazione è nella posizione off.
    • Un campo eventType, che contiene un valore della classe EventType l'enumerazione.
    • 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 consente di definire un elenco di Progetti Google Cloud per cercare 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 per 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 le dashboard, vedi Creare e gestire dashboard per API e Esempio: abilita gli eventi nelle dashboard.

Configurare la scheda Osservabilità per mostrare gli eventi

Questa sezione descrive come configurare l'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à di un servizio o un prodotto.

    Ad esempio, potresti andare alla pagina Cluster Kubernetes e poi seleziona la scheda Osservabilità. Analogamente, puoi andare alla Carichi di lavoro Kubernetes o alla pagina dei dettagli di un di macchina virtuale (VM) e seleziona 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 mostrare, le query vengono inviate a recuperano i dati sugli eventi e la dashboard viene aggiornata.

    Quando il pulsante Seleziona eventi non è visualizzata, la scheda non può essere configurata per mostrare gli eventi.

API

Non disponibile.

Visualizza i dettagli dell'evento

Quando visualizzi un grafico in cui sono riportate le annotazioni degli eventi, puoi utilizzare i link forniti nella descrizione comando per accedere ad altre 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: il 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 passa attraverso i sink di Cloud Logging nel tuo progetto Google Cloud, possono ricevere notifiche quando si verificano questi eventi configurazione di un avviso basato su log. Query sui criteri di avviso basati su log le voci di log non appena 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 Monitoraggio.

    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 evento riporta una adatta all'uso 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, procedi nel seguente modo:

  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 che contiene la rappresentazione dell'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 inviare il gcloud alpha monitoring policies create .

Nascondi eventi

Console

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

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

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 le dashboard in base all'API.

Passaggi successivi