Mostra gli eventi in una dashboard

Questo documento descrive come visualizzare gli eventi sui grafici di 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 quando stai risolvendo un problema.

Come vengono identificati gli eventi

Le dashboard eseguono query sugli eventi 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 tuo 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 visualizzati gli eventi

I grafici nella dashboard vengono annotati man mano che si verificano eventi. Gli eventi identificati tramite l'analisi delle voci di log vengono mostrati con un riferimento temporale singolo.

Lo screenshot seguente mostra un grafico che mostra un evento che è stato identificato analizzando le voci di log:

Grafico che mostra annotazioni di eventi.

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

  • Nome dell'evento.
  • Il servizio Google Cloud o la risorsa che ha causato l'evento.
  • La data e l'ora di inizio dell'evento.
  • Un pulsante Visualizza che, se selezionato, apre una pagina contenente ulteriori informazioni sull'evento. Ad esempio, potrebbe aprire Esplora log per visualizzare le voci di log.

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

Per le dashboard personalizzate, puoi anche configurare la visualizzazione degli eventi utilizzando l'API Cloud Monitoring.

Prima di iniziare

  • Per ottenere le autorizzazioni necessarie per visualizzare grafici e voci di log e per creare criteri di avviso, chiedi all'amministratore di concederti i seguenti ruoli IAM sul tuo progetto:

    • Visualizza i grafici e per visualizzare e creare criteri di avviso: Editor Monitoring (roles/monitoring.editor).
    • Visualizza tutte le voci di log, tranne le voci di log di accesso ai dati create nel tuo progetto Google Cloud: Visualizzatore log (roles/logging.viewer).
    • Visualizza le voci di log degli accessi ai dati create nel tuo progetto Google Cloud: Visualizzatore log privati (roles/logging.privateLogViewer).

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

    Potresti anche essere in grado di ottenere le autorizzazioni richieste tramite i ruoli personalizzati o altri ruoli predefiniti.

Mostra eventi

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

Console

Per mostrare gli eventi della sessione corrente:

  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 il cui 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 non è visualizzato, significa che la dashboard non supporta la visualizzazione degli eventi.

  4. Per ogni tipo di evento da visualizzare, fai clic su Aggiungi evento nella barra degli strumenti della dashboard, poi seleziona il tipo di evento dal menu.

    Ad esempio, potresti configurare la dashboard in modo da visualizzare gli eventi "Deployment del carico di lavoro GKE".

    Dopo aver aggiunto un tipo di evento, Cloud Monitoring esegue una query sui dati dei log, il che richiede alcuni istanti, e poi aggiunge le annotazioni ai grafici nella dashboard:

    • Informazioni: un messaggio informativo.
    • Avviso: indica un errore, ad esempio un riavvio o un arresto anomalo.
    • Avviso: indica che è stato aperto un incidente.

  5. Per visualizzare il riepilogo di un evento o per accedere ai link alle voci di log, utilizza il puntatore per attivare la descrizione comando.

  6. (Facoltativo) La configurazione si applica solo alla sessione corrente. Per salvare la configurazione:

    1. Nella barra degli strumenti della dashboard, fai clic su Impostazioni, seleziona JSON e quindi seleziona Editor JSON.

    2. Nell'editor JSON, aggiungi un oggetto annotations. Questo oggetto contiene un array di oggetti EventAnnotation che specificano i tipi di evento da visualizzare.

      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 ulteriori informazioni sull'oggetto annotations, seleziona la scheda API di questa tabella.

    3. Fai clic su Applica modifiche e poi su Salva.

API

Per configurare una dashboard personalizzata 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 la ricerca di eventi per i progetti Google Cloud. 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 è specificato o se il valore di questo campo è una stringa vuota, viene visualizzato 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 è in posizione on e gli eventi vengono mostrati nella dashboard. Quando false, il pulsante 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. Quando 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 in cui 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 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 e Esempio: abilitare gli eventi sulle dashboard.

Visualizza dettagli evento

Quando visualizzi un grafico che mostra annotazioni di 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 aperta dal pulsante Visualizza dipende 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.

  • Per visualizzare le voci di log con timestamp corrispondenti a un'annotazione, utilizza il puntatore per attivare la descrizione comando per l'annotazione, vai alla riga di riepilogo della descrizione comando e fai clic su Visualizza log.

Crea criteri di avviso

Per ricevere una notifica quando viene visualizzato un evento nei log, configura un avviso basato su log. I criteri di avviso basati su log eseguono query sulle voci di log non appena le ricevi. Quando la query restituisce un risultato non vuoto, viene creato un incidente e vengono inviate notifiche.

Console

Per creare un avviso basato su log:

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

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

      Vai ad Avvisi

      Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato il cui 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, quindi 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 il cui 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 le quali inviare un avviso, inserisci una query o aggiorna la query copiata dal riquadro Query quando hai selezionato Crea avviso.

    Per ogni tipo di evento, nella pagina Tipi di evento viene elencata una query adatta all'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:

  1. Identifica la query da includere nella condizione del criterio di avviso. Per ogni tipo di evento, nella pagina Tipi di evento viene elencata una query adatta all'utilizzo 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 su un esempio, consulta Progettare il 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, nella barra degli strumenti della dashboard assicurati che l'opzione Eventi sia disattivata.

Per nascondere un tipo di evento, imposta il pulsante 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 e imposta il campo enabled su false.

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

Passaggi successivi