Aggiungere filtri permanenti a una dashboard personalizzata

Questo documento descrive come aggiungere filtri permanenti a livello di dashboard alle tue dashboard personalizzate. I filtri permanenti, che ti consentono di modificare i dati visualizzati da una dashboard senza dover modificare ogni widget, hanno uno stato predefinito e possono essere applicati all'intera dashboard o solo a widget specifici. La barra degli strumenti della dashboard visualizza tutti i filtri permanenti, insieme un menu che ti consente di modificare temporaneamente il valore del filtro.

Quando si desidera definire una presentazione predefinita dei dati in una dashboard insieme con opzioni basate su menu per modificare la visualizzazione e aggiungere filtri permanenti. Ad esempio, se vuoi visualizzare le metriche per tutte le zone e anche per una zona specifica, crea un filtro permanente in base all'etichetta zone.

Puoi creare e applicare filtri permanenti utilizzando la console Google Cloud oppure l'API Cloud Monitoring. Questo documento descrive come utilizzare nella console Google Cloud. Per informazioni sull'utilizzo dell'API Cloud Monitoring, consulta Creare e gestire le dashboard tramite API: filtri della dashboard.

Per informazioni su come aggiungere e modificare raggruppamenti e filtri temporanei, consulta Aggiungere filtri temporanei a una dashboard personalizzata.

Come funzionano i filtri nella dashboard

Un filtro della dashboard specifica un'etichetta e un valore. La serie temporale delle visualizzazioni della dashboard determinano le etichette disponibili per l'applicazione dei filtri. Il modo in cui un widget supporta un filtro a livello di dashboard dipende dal tipo di dati viene visualizzato il widget e la relativa configurazione:

  • Per i widget che mostrano dati delle serie temporali, come i grafici a linee, si applicano le seguenti regole:

    • Se le serie temporali visualizzate dal widget non supportano l'etichetta in un il filtro a livello di dashboard non modifica i dati visualizzati.

      Ad esempio, se aggiungi un filtro all'etichetta instance_id, ma un grafico nella dashboard non mostra i dati con l'etichetta instance_id, il filtro non modifica i dati visualizzati.

    • Se il widget specifica un valore per un'etichetta, il filtro per l'intera dashboard non modifica i dati visualizzati.

      Ad esempio, se aggiungi un filtro all'etichetta instance_id, ma un grafico Nella dashboard includa un filtro basato sull'etichetta instance_id, quindi il filtro a livello di dashboard non modifica i dati visualizzati.

    • In caso contrario, il grafico filtra i dati mostrati solo per quei dati. serie temporali che soddisfano il filtro a livello di dashboard.

  • Per i widget del riquadro dei log, i filtri a livello di dashboard basati su un l'etichetta della risorsa aggiorna la query. Ad esempio, se aggiungi filtro a livello di dashboard cluster_name: mycluster, la query aggiornato per includere resource.labels."cluster_name"="mycluster".

Puoi aggiungere più filtri a livello di dashboard. Questi filtri sono uniti con una logicità AND.

Prima di iniziare

Per ottenere le autorizzazioni necessarie per aggiungere o modificare i filtri permanenti utilizzando la console Google Cloud, chiedi all'amministratore di concederti Ruolo IAM Editor Monitoring (roles/monitoring.editor) per il progetto. 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 i ruoli personalizzati o altri ruoli predefiniti.

Per ulteriori informazioni sui ruoli, consulta Controllare l'accesso con Identity and Access Management.

Crea un filtro permanente

Quando progetti una dashboard, potresti identificare più modi per visualizzare i dati visualizzati. Ad esempio, quando una dashboard mostra metriche per le istanze VM, può essere utile visualizzare le metriche per tutte le VM e potresti voler visualizzare le metriche per le VM in una zona specifica. Puoi creare un filtro permanente per l'etichetta zone con il valore predefinito impostato su tutte le zone, *. Quando visualizzi la dashboard, puoi utilizzare i comandi menu sul filtro zone per selezionare una zona specifica.

Puoi limitare un filtro permanente a widget specifici. Considera uno scenario in cui vuoi visualizzare affiancate le metriche per le VM in due zone diverse. Crei due raccolte di grafici e creare un filtro per ogni raccolta. La tua configurazione predefinita soddisfi l'obiettivo originale. Tuttavia, quando visualizzi la dashboard, la barra degli strumenti elenca le variabili e include menu che ti consentono di selezionare diversi valori. Puoi utilizzare questi menu per visualizzare i dati relativi a zone diverse.

I filtri permanenti che si applicano solo a widget specifici a volte sono chiamati variabili modello. Dopo aver creato un filtro di questo tipo, quando aggiunti un widget alla dashboard, puoi applicare il filtro anche al widget. Per ulteriori informazioni, consulta Applicare un filtro permanente a un widget.

Per creare un filtro permanente:

  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. Nella barra degli strumenti della dashboard, fai clic su Impostazioni e poi seleziona Gestisci filtri.
  3. Fai clic su Etichetta, quindi seleziona un'etichetta. Ad esempio, puoi selezionare zone.

  4. Fai clic su Valore predefinito e seleziona il valore predefinito. per l'etichetta. Per trovare una corrispondenza per tutti i valori, seleziona *.

    Una volta creato, il filtro viene aggiunto alla barra degli strumenti della dashboard. Per modificare temporaneamente il valore del filtro, selezionalo e poi effettua una selezione dal menu.

  5. Esegui una di queste operazioni:

    • Per applicare il filtro a tutti i widget sulla dashboard, procedi nel seguente modo: seleziona Applica a tutti, quindi seleziona Applica.

    • Per creare una variabile o applicare il filtro ad alcuni widget in dashboard:

      1. Deseleziona Applica a tutto.
      2. Nel campo Nome variabile, inserisci un nome visualizzato per la variabile.

      3. Espandi il menu Applica ai grafici, seleziona i widget a cui si applica il filtro e poi seleziona OK.

      4. Fai clic su Applica.

Applicare un filtro permanente a un widget

Per applicare un filtro permanente a un widget, devi associarlo alla variabile:

  • Per i grafici configurati utilizzando i menu, puoi: eseguire questa associazione durante la creazione o la modifica del filtro.

  • Per il riquadro dei log, modifica il widget e configura la query predefinita. Assicurati di seguire le indicazioni riportate nella sezione Sintassi per applicare un filtro permanente.

  • Per i grafici e le tabelle definiti in MQL o PromQL, modifica il grafico o tabella e poi modificare MQL o PromQL. Assicurati di seguire le indicazioni nella sezione intitolata Sintassi per applicare un filtro permanente.

Sintassi per applicare un filtro permanente

Ad esempio, di seguito è riportata la rappresentazione JSON parziale di una dashboard che definisce una variabile del modello e un filtro a livello di dashboard:

{
  "dashboardFilters": [
      {
        "filterType": "RESOURCE_LABEL",
        "labelKey": "instance_id",
        "stringValue": "3133577226154888113",
        "templateVariable": "iid"
      },
      {
        "filterType": "RESOURCE_LABEL",
        "labelKey": "zone"
      }
    ],
  "displayName": "Illustrate Template Variables",
  ...

Nel JSON visualizzato, la prima voce nella struttura dashboardFilters riguarda una variabile del modello con il nome iid e un filtro a livello di dashboard con la chiave dell'etichetta zone. La variabile del modello è Un alias dell'etichetta instance_id.

La struttura dei dati per una variabile di modello non elenca i widget a cui si applica. Devi invece associare un widget a una variabile di modello. Modificando la query del widget per includere un riferimento alla variabile. Quando il widget viene visualizzato nella dashboard, il valore della variabile del modello sia risolto.

Per informazioni su come annotare i riquadri e i grafici dei log, consulta le sezioni seguenti:

Riquadro dei log

Per configurare un riquadro dei log per filtrare la visualizzazione in base al valore di un , aggiungila al riquadro delle query. L'esempio seguente illustra una query che filtra in base al valore della variabile del modello iid:

${iid}

Prima che il riquadro dei log effettui query sui log da visualizzare, la variabile del modello viene risolta. In questo esempio, se il valore della variabile del modello è "12345", il valore ${iid} viene sostituito con l'istruzione resource.labels."instance_id"="12345".

In una query puoi anche includere solo il valore di una variabile del modello. Ti consigliamo di utilizzare il valore solo come parte di un filtro definito con un un'espressione regolare. Ad esempio, la seguente query utilizza un'espressione regolare per trovare le voci di log con un payload JSON contenente la stringa descritta:

jsonPayload.message=~"Connected to instance: ${iid.value}"

Se hai configurato una query per il riquadro dei log e poi selezioni il pulsante per aprire Esplora log, le variabili del modello vengono risolte prima dell'apertura di Esplora log.

La tabella seguente mostra in che modo la variabile del modello viene risolta tramite riquadro dei log:

Sintassi Valore
selezionato		 Espressione del riquadro dei log risolti
${iid} 12345 resource.labels."instance_id"="12345"
${iid} * ""
${iid.value} 12345 12345
${iid.value} * .*

Grafici e tabelle definiti in MQL

Quando utilizzi Monitoring Query Language (MQL) per configurare un grafico, aggiungi una barra verticale e la variabile alla stringa di query:

fetch gce_instance
| metric 'compute.googleapis.com/instance/cpu/utilization'
| every 1m
| ${iid}

Prima che il grafico esegua query sulle serie temporali da visualizzare, la variabile del modello viene risolta. In questo esempio, se il valore della variabile del modello è "12345", il valore ${iid} viene sostituito con l'istruzione filter (resource.instance_id == '12345'). Questo filtro corrisponde al tempo serie con l'etichetta resource.instance_id e solo quando il valore di quell'etichetta è esattamente 12345.

Quando vuoi filtrare le serie temporali utilizzando un'espressione regolare, configura la query in modo da includere solo il valore della variabile del modello. Per illustrare la sintassi, procedi come riportato di seguito mostra come utilizzare un'espressione regolare per determinare se il valore dell'attributo L'etichetta resource.instance_id contiene il valore della variabile di modello iid:

fetch gce_instance
| metric 'compute.googleapis.com/instance/cpu/utilization'
| filter resource.instance_id=~"${iid.value}"
| group_by 1m, [value_utilization_mean: mean(value.utilization)]
| every 1m

La seguente tabella mostra come viene risolta la variabile del modello per le query MQL:

Sintassi Valore
selezionato		 Espressione MQL risolta
${iid} 12345 filter (resource.instance_id == '12345')
${iid} * filter (true)
${iid.value} 12345 12345
${iid.value} * .*

Grafici e tabelle definiti tramite PromQL

Quando definisci un grafico utilizzando PromQL, aggiungi alla stringa di query il valore variabile racchiusa tra parentesi graffe:

compute_googleapis_com:instance_cpu_utilization {
    project_id="my-project", ${iid}
}

Prima che il grafico esegua query sulle serie temporali da visualizzare, la variabile del modello sia stato risolto. In questo esempio, se il valore della variabile del modello è "12345", ${iid} viene sostituito dall'istruzione instance_id == '12345'.

In modo simile a MQL, quando definisci un widget con PromQL, la query può estrarre solo il valore della variabile del modello. Ti consigliamo di utilizzare il valore solo all'interno di un filtro definito con un'espressione regolare. A illustrano la sintassi, quanto segue mostra come utilizzare un'espressione regolare per determina se il valore dell'etichetta instance_id contiene il valore dell'attributo variabile di modello iid:

compute_googleapis_com:instance_cpu_utilization{
    instance_id=~"${iid.value}"
}

La tabella seguente mostra come viene risolta la variabile del modello per le query PromQL:

Sintassi Selected
Value		 Espressione PromQL risolta
${iid} 12345 instance_id == '12345'
${iid} * noop_filter=~".*"
${iid.value} 12345 12345
${iid.value} * .+

Grafici e tabelle definiti con filtri delle serie temporali

Quando definisci un grafico utilizzando i filtri delle serie temporali, aggiungi la variabile alla stringa del filtro:

"filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\"
           resource.type=\"gce_instance\" ${iid}"

A differenza dei grafici definiti in MQL e PromQL, non puoi utilizzare il valore di una variabile di modello in un filtro delle serie temporali.

La tabella seguente mostra come viene risolta la variabile del modello:

Sintassi Valore
selezionato		 Espressione di filtro risolta
${iid} 12345 resource.instance_id == "12345"
${iid} * Omessa
${iid.value} 12345 Non supportata
${iid.value} * Non supportata

Modificare un filtro permanente

Per modificare temporaneamente il valore di qualsiasi filtro visualizzato nella barra degli strumenti della dashboard, fai clic sul nome del filtro e inserisci un valore o effettua una selezione dal menu.

Se la dashboard contiene una tabella che mostra i dati delle serie temporali, puoi aggiungere filtri temporanei o modificare filtri e variabili permanenti utilizzando il pulsante Filtra dashboard in base a questo valore di una cella. Se selezionato, questo pulsante applica un nuovo filtro temporaneo o aggiorna il valore di un filtro o di una variabile esistente. Filtri e variabili esistenti Vengono aggiornati quando la chiave di etichetta della colonna della tabella corrisponde alla chiave di etichetta per un filtro o una variabile.

Per modificare la configurazione di un filtro permanente:

  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. Nella barra degli strumenti della dashboard, fai clic su Impostazioni e poi seleziona Gestisci filtri.
  3. Trova il filtro da modificare, poi utilizza i menu per modifiche.
  4. Fai clic su Applica.

Eliminare un filtro permanente

  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. Nella barra degli strumenti della dashboard, fai clic su Impostazioni e poi seleziona Gestisci filtri.
  3. Trova il filtro da rimuovere e fai clic su. Elimina.
  4. Fai clic su Applica.

Passaggi successivi