Procedure consigliate per i dashboard

Questo argomento della documentazione è progettato per le aree di lavoro Grafana che supportano la versione 10.x di Grafana.

Per le aree di lavoro Grafana che supportano la versione 9.x di Grafana, vedere. Lavorare nella versione 9 di Grafana

Per le aree di lavoro Grafana che supportano la versione 8.x di Grafana, vedere. Funzionamento in Grafana versione 8

Questa sezione fornisce informazioni sulle migliori pratiche per gli amministratori e gli utenti di Grafana su come creare e gestire i dashboard Grafana.

Per informazioni sui diversi tipi di dashboard che puoi creare, consulta le dashboard Grafana: una guida completa a tutti i diversi tipi di dashboard che puoi creare post sul sito Web di Grafana Labs.

Nota

Questa sezione può aiutarti a creare una strategia per il monitoraggio e la manutenzione del pannello di controllo. Conoscete meglio i vostri sistemi e dovreste usare questa sezione per guidarvi nella comprensione. In definitiva, è tua responsabilità creare la strategia migliore per il tuo sistema.

Strategie comuni di osservabilità

Quando hai molte cose da monitorare, come una server farm, hai bisogno di una strategia per decidere cosa è abbastanza importante da monitorare. Questa pagina descrive diversi metodi comuni per scegliere cosa monitorare.

Una strategia logica consente di creare dashboard uniformi e scalare più facilmente la piattaforma di osservabilità.

Linee guida per le strategie

• Il metodo USE ti dice quanto sono felici le tue macchine, il metodo RED ti dice quanto sono felici i tuoi utenti.

• USE riporta le cause dei problemi.

• RED riporta l'esperienza dell'utente ed è più probabile che riporti i sintomi dei problemi.

• Il monitoraggio di entrambi è importante per comprendere il sistema. È buona norma prestare attenzione ai sintomi anziché alle cause. In genere, gli avvisi sono configurati sui dashboard RED.

Metodo USE

USE sta per:

• Utilizzo: percentuale di tempo in cui la risorsa è occupata, ad esempio l'utilizzo della CPU del nodo.

• Saturazione: quantità di lavoro che una risorsa deve svolgere, spesso la lunghezza della coda o il carico dei nodi.

• Errori: conteggio degli eventi di errore.

Questo metodo è ideale per le risorse hardware dell'infrastruttura, come CPU, memoria e dispositivi di rete. Per ulteriori informazioni, consulta il post sul blog di Brendan Gregg The USE Method.

Metodo RED

RED sta per:

• Velocità: richieste al secondo

• Errori: numero di richieste non riuscite.

• Durata: quantità di tempo impiegata da queste richieste, distribuzione delle misurazioni della latenza.

Questo metodo è più applicabile ai servizi, in particolare a un ambiente di microservizi. Per ciascuno dei tuoi servizi, utilizza il codice per esporre queste metriche per ogni componente. I dashboard RED sono utili per avvisi e SLA. Una dashboard RED ben progettata funge da proxy per l'esperienza utente.

Per ulteriori informazioni, consulta il post sul blog di Tom Wilkie The RED method: How to instrument your services.

I quattro segnali dorati

Secondo il manuale di Google SRE, se riesci a misurare solo quattro metriche del tuo sistema rivolto agli utenti, concentrati su queste quattro.

Questo metodo è simile al metodo RED, ma include la saturazione.

• Latenza: tempo impiegato per soddisfare una richiesta.

• Traffico: quanta richiesta viene immessa nel sistema.

• Errori: percentuale di richieste non riuscite.

• Saturazione: quanto è «pieno» il sistema,

Modello di maturità per la gestione delle dashboard

La maturità della gestione delle dashboard si riferisce a quanto sia ben progettato ed efficiente il tuo ecosistema di dashboard. Ti consigliamo di rivedere periodicamente la configurazione della dashboard per valutare a che punto sei e come puoi migliorare.

In generale, la maturità della dashboard può essere definita come bassa, media o alta.

Gran parte del contenuto di questo argomento è stato tratto dal talk Fool-Proof Kubernetes Dashboards for Sleep-Deprived Oncalls del KubeCon 2019.

Basso: stato predefinito

In questa fase, non è disponibile una strategia di gestione del pannello di controllo coerente. Quasi tutti iniziano da qui.

Come fai a sapere che sei qui?

• Tutti possono modificare le tue dashboard.

• Molte dashboard copiate, riutilizzo minimo o nullo delle dashboard.

• Dashboard uniche che durano per sempre.

• Nessun controllo della versione (dashboard JSON nel controllo della versione).

• Naviga molto alla ricerca di dashboard, cerca la dashboard giusta. Ciò significa perdere molto tempo a cercare la dashboard di cui hai bisogno.

• Non hai avvisi che ti indirizzino alla dashboard giusta.

Dashboard metodici di medie dimensioni

In questa fase, stai iniziando a gestire l'uso della dashboard con dashboard metodiche. Potresti aver definito una strategia, ma ci sono alcune cose che potresti migliorare.

Come fai a sapere che sei qui?

• Previeni l'espansione incontrollata utilizzando le variabili del modello. Ad esempio, non è necessaria una dashboard separata per ogni nodo, è possibile utilizzare variabili di query. Ancora meglio, puoi trasformare l'origine dei dati anche in una variabile modello, in modo da poter riutilizzare la stessa dashboard su diversi cluster e backend di monitoraggio.

  Fai riferimento all'elenco degli esempi inVariables, per idee.

• Dashboard metodici secondo una strategia di osservabilità.

• Dashboard gerarchici con approfondimenti al livello successivo.

• Il design del pannello di controllo riflette le gerarchie dei servizi. Ad esempio, è possibile utilizzare il metodo RED con una riga per servizio. L'ordine delle righe potrebbe riflettere il flusso di dati, mentre scorri verso il basso la dashboard.

• Confronta i like con i like: dividi le dashboard dei servizi quando la grandezza è diversa. Assicurati che le metriche aggregate non offuschino informazioni importanti.

• Grafici espressivi con un uso significativo del colore e degli assi di normalizzazione, ove possibile.

  • Esempio di colore significativo: il blu significa che è buono, il rosso significa che è cattivo. Le soglie possono aiutare in questo senso.

  • Esempio di normalizzazione degli assi: quando confronti l'utilizzo della CPU, misura in percentuale anziché in numero grezzo, poiché le macchine possono avere un numero diverso di core. La normalizzazione dell'utilizzo della CPU in base al numero di core riduce il carico cognitivo perché lo spettatore può contare sul fatto che tutti i core vengano utilizzati al 100%, senza dover conoscere il numero di CPU.

• La navigazione diretta riduce le ipotesi.

  • Le variabili del modello rendono più difficile la navigazione in modo casuale o senza meta.

  • La maggior parte delle dashboard dovrebbe essere collegata tramite avvisi.

  • La navigazione è diretta tramite link. Per ulteriori informazioni, consulta Gestione dei collegamenti alla dashboard.

• Dashboard JSON con controllo della versione.

Utilizzo altamente ottimizzato

In questa fase, hai ottimizzato l'uso della gestione della dashboard con una strategia coerente e ponderata. Richiede manutenzione, ma i risultati ne valgono la pena.

• Ridurre attivamente l'espansione incontrollata.

  • Esamina regolarmente le dashboard esistenti per assicurarti che siano ancora pertinenti.

  • Solo i dashboard approvati sono stati aggiunti all'elenco dei dashboard principali.

  • Monitoraggio dell'utilizzo della dashboard. Puoi sfruttare le informazioni sull'utilizzo.

• Coerenza fin dalla progettazione.

• Utilizza le librerie di script per generare dashboard e garantire la coerenza nel modello e nello stile.

  • grafonnet (Jsonnet)

  • grafanalib (Python)

• Nessuna modifica nel browser. I visualizzatori della dashboard modificano le visualizzazioni con variabili.

• La ricerca di dashboard è l'eccezione, non la regola.

• Esegui sperimentazioni e test in un'istanza Grafana separata dedicata a tale scopo, non in un'istanza di produzione. Quando una dashboard nell'ambiente di test si dimostra utile, aggiungi quella dashboard all'istanza principale di Grafana.

Le migliori pratiche per la creazione di dashboard

Questa sezione descrive alcune best practice da seguire per la creazione di dashboard Grafana.

Prima di iniziare

Ecco alcuni principi da considerare prima di creare una dashboard.

Una dashboard dovrebbe raccontare una storia o rispondere a una domanda

Che storia stai cercando di raccontare con la tua dashboard? Prova a creare una progressione logica dei dati, ad esempio da grandi a piccoli o da generali a specifici. Qual è l'obiettivo di questa dashboard? (Suggerimento: se la dashboard non ha un obiettivo, chiediti se ne hai davvero bisogno.)

Mantieni i tuoi grafici semplici e concentrati sulla risposta alla domanda che ti stai ponendo. Ad esempio, se la tua domanda è «quali server sono in difficoltà?» , allora forse non è necessario mostrare tutti i dati del server. Basta mostrare i dati per chi è in difficoltà.

Le dashboard dovrebbero ridurre il carico cognitivo, non aumentarlo

Il carico cognitivo è fondamentalmente la difficoltà con cui devi pensare a qualcosa per capirlo. Rendi la tua dashboard facile da interpretare. Gli altri utenti e voi future (quando starete cercando di capire cosa si è rotto alle 2 del mattino) lo apprezzerete.

Chiediti:

• Posso dire cosa rappresenta esattamente ogni grafico? È ovvio o devo pensarci?

• Se lo mostro a qualcun altro, quanto tempo impiegheranno a capirlo? Si perderanno?

Avere una strategia di monitoraggio

È facile creare nuove dashboard. È più difficile ottimizzare la creazione di dashboard e rispettare un piano, ma ne vale la pena. Questa strategia dovrebbe governare sia lo schema generale del dashboard che imporre la coerenza nella progettazione delle singole dashboard.

Per ulteriori informazioni, consulta le strategie comuni di osservabilità e i livelli di maturità della gestione dei dashboard.

Scrivilo

Una volta che hai una strategia o delle linee guida di progettazione, scrivile per mantenere la coerenza nel tempo.

Le migliori pratiche da seguire

• Quando crei una nuova dashboard, assicurati che abbia un nome significativo.

  • Se stai creando una dashboard per giocare o sperimentare, inserisci la parola TEST o TMP nel nome.

  • Prendi in considerazione l'idea di includere il tuo nome o le tue iniziali nel nome della dashboard o come tag in modo che le persone sappiano chi è il proprietario della dashboard.

  • Rimuovi i pannelli di controllo temporanei degli esperimenti quando hai finito di usarli.

• Se crei molte dashboard correlate, pensa a come incrociarle per facilitarne la navigazione. Per ulteriori informazioni, consulta Best practice per la gestione delle dashboard, più avanti in questa sezione.

• Grafana recupera i dati da una fonte di dati. È importante una conoscenza di base delle fonti di dati Connessione alle origini dati in generale e specifiche.

• Evita l'aggiornamento non necessario della dashboard per ridurre il carico sulla rete o sul backend. Ad esempio, se i dati cambiano ogni ora, non è necessario impostare la frequenza di aggiornamento della dashboard su 30 secondi.

• Usa gli assi Y sinistro e destro per visualizzare serie temporali con unità o intervalli diversi.

• Aggiungi documentazione a dashboard e pannelli.

  • Per aggiungere documentazione a una dashboard, aggiungi una visualizzazione del pannello di testo alla dashboard. Registra elementi come lo scopo della dashboard, i link alle risorse utili e tutte le istruzioni di cui gli utenti potrebbero aver bisogno per interagire con la dashboard.

  • Per aggiungere documentazione a un pannello, modifica le impostazioni del pannello e aggiungi una descrizione. Qualsiasi testo aggiunto verrà visualizzato se posizionate il cursore sul piccolo angolo i in alto a sinistra del pannello.

• Riutilizza le dashboard e rafforza la coerenza utilizzando modelli e variabili.

• Fai attenzione a impilare i dati dei grafici. Le visualizzazioni possono essere fuorvianti e nascondere dati importanti. Si consiglia di disattivarlo nella maggior parte dei casi.

Le migliori pratiche per la gestione delle dashboard

Questa pagina descrive alcune best practice da seguire per la gestione delle dashboard Grafana.

Prima di iniziare

Ecco alcuni principi da considerare prima di iniziare a gestire le dashboard.

Osservabilità strategica

Esistono diverse strategie di osservabilità comuni. Dovresti ricercarli e decidere se uno di essi funziona per te o se vuoi inventarne uno tuo. Ad ogni modo, prepara un piano, scrivilo e seguilo.

Adatta la tua strategia alle mutevoli esigenze, se necessario.

Livello di maturità

Qual è il livello di maturità della tua dashboard? Analizza la configurazione attuale della dashboard e confrontala con il modello di maturità della gestione della dashboard. Capire dove ti trovi può aiutarti a decidere come arrivare dove vuoi essere.

Le migliori pratiche da seguire

• Evita la proliferazione incontrollata delle dashboard, ovvero la crescita incontrollata delle dashboard. L'espansione incontrollata delle dashboard influisce negativamente sul tempo necessario per trovare la dashboard giusta. Duplicare le dashboard e modificare «una cosa» (peggio ancora: mantenere i tag originali) è il tipo di espansione incontrollata più semplice.

  • Esamina periodicamente le dashboard e rimuovi quelle non necessarie.

  • Se crei una dashboard temporanea, magari per testare qualcosa, inserisci come prefisso il nome. TEST: Elimina la dashboard quando hai finito.

• Copiare i pannelli di controllo senza modifiche significative non è una buona idea.

  • Ti perdi gli aggiornamenti alla dashboard originale, come le modifiche alla documentazione, le correzioni di bug o le aggiunte alle metriche.

  • In molti casi vengono create delle copie per personalizzare semplicemente la visualizzazione impostando i parametri del modello. Ciò dovrebbe invece essere fatto mantenendo un collegamento alla dashboard principale e personalizzando la visualizzazione con i parametri URL.

• Quando devi copiare una dashboard, rinominala chiaramente e non copiare i tag della dashboard. I tag sono metadati importanti per i dashboard utilizzati durante la ricerca. La copia dei tag può generare false corrispondenze.

• Gestisci una dashboard composta da dashboard o dashboard con riferimenti incrociati. Questa operazione può essere eseguita in diversi modi:

  • Crea collegamenti alla dashboard, ai pannelli o ai dati. I link possono andare ad altre dashboard o a sistemi esterni. Per ulteriori informazioni, consulta Gestire i collegamenti alla dashboard.

  • Aggiungi un pannello con l'elenco della dashboard. Puoi quindi personalizzare ciò che vedi effettuando ricerche per tag o cartelle.

  • Aggiungi un pannello di testo e usa markdown per personalizzare la visualizzazione.