Annota le visualizzazioni

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

Le annotazioni consentono di contrassegnare punti su una visualizzazione con eventi complessi. Vengono visualizzate come linee verticali e icone su tutti i pannelli grafici. Quando passi il mouse su un'annotazione, puoi ottenere la descrizione e i tag dell'evento. Il campo di testo può includere collegamenti ad altri sistemi con maggiori dettagli.

È possibile annotare le visualizzazioni in tre modi:

• Direttamente nel pannello, utilizzando la query di annotazioni integrata.

• Utilizzando l'API HTTP Grafana.

• Configurazione delle interrogazioni di annotazione nelle impostazioni della dashboard.

Nei primi due casi, stai creando nuove annotazioni, mentre nell'ultimo stai interrogando le annotazioni esistenti provenienti da fonti di dati. Anche la query di annotazione integrata supporta questa funzionalità.

Questa sezione spiega la prima e la terza opzione; per informazioni sull'utilizzo dell'API HTTP Grafana, fare riferimento a. API per le annotazioni

Le annotazioni sono supportate per i seguenti tipi di visualizzazione:

• Serie temporali

• Cronologia dello stato

• Candelabro

Crea annotazioni nei pannelli

Grafana offre la possibilità di aggiungere eventi di annotazione direttamente da un pannello utilizzando la query di annotazioni integrata presente in tutte le dashboard. Le annotazioni create in questo modo vengono archiviate in Grafana.

Per aggiungere annotazioni direttamente nel pannello:

• La dashboard deve essere già stata salvata.

• La query integrata deve essere abilitata.

Per aggiungere un'annotazione

1. Nella dashboard, seleziona il pannello a cui stai aggiungendo l'annotazione. Apparirà un menu contestuale.

2. Nel menu contestuale, seleziona Aggiungi annotazione.

3. (Facoltativo) Aggiungi una descrizione e dei tag dell'annotazione.

4. Seleziona Salva.

In alternativa, per aggiungere un'annotazione, premi Ctrl (oCmd) mentre selezioni il pannello e verrà visualizzato il popover Aggiungi annotazione.

Annotazioni regionali

Puoi anche creare annotazioni che coprono un'area o un periodo di tempo in una visualizzazione.

Per aggiungere un'annotazione regionale

1. Nella dashboard, premete Ctrl (oCmd) mentre selezionate un'area del pannello.

2. Aggiungi una descrizione dell'annotazione e dei tag (opzionale).

3. Fai clic su Save (Salva).

Per modificare un'annotazione

1. Nella dashboard, posiziona il mouse su un indicatore di annotazione su un pannello.

2. Seleziona l'icona Modifica (matita) nel tooltip di annotazione.

3. Modifica la descrizione e/o i tag.

4. Seleziona Salva.

Per eliminare un'annotazione

1. Nella dashboard, posiziona il mouse su un indicatore di annotazione su un pannello.

2. Seleziona l'icona Elimina (cestino) nel tooltip di annotazione.

Recupera le annotazioni tramite le impostazioni della dashboard

Nelle impostazioni della dashboard, in Annotazioni, puoi aggiungere nuove query per recuperare le annotazioni utilizzando qualsiasi fonte di dati, inclusa la fonte di dati di annotazione dati integrata. Le query di annotazione restituiscono eventi che possono essere visualizzati come marcatori di eventi nei grafici della dashboard.

Per aggiungere una nuova interrogazione di annotazione

1. Seleziona l'icona Impostazioni (ingranaggio) nell'intestazione della dashboard per aprire il menu delle impostazioni.

2. Seleziona Annotazioni.

3. Fai clic su Aggiungi interrogazione di annotazione.

4. Immettete un nome per la query di annotazione.

   Questo nome viene assegnato all'interruttore (casella di controllo) che consente di abilitare la visualizzazione degli eventi di annotazione derivanti da questa query.

5. Seleziona la fonte di dati per le annotazioni.

   Puoi anche scegliere Open advanced data source picker per visualizzare altre opzioni, inclusa l'aggiunta di una nuova origine dati (disponibile solo per gli amministratori).

6. Se non desideri utilizzare subito la query di annotazione, deseleziona la casella di controllo Abilitato.

7. Se non desideri che l'interruttore della query di annotazione venga visualizzato nella dashboard, seleziona la casella di controllo Nascosto.

8. Seleziona un colore per i marker degli eventi.

9. Nel menu a discesa Mostra in, scegli una delle seguenti opzioni:

   • Tutti i pannelli: le annotazioni vengono visualizzate su tutti i pannelli che supportano le annotazioni.

   • Pannelli selezionati: le annotazioni vengono visualizzate su tutti i pannelli selezionati.

   • Tutti i pannelli tranne: le annotazioni vengono visualizzate su tutti i pannelli tranne quelli selezionati.

10. Configura l'interrogazione.

    Le opzioni di interrogazione delle annotazioni sono diverse per ogni fonte di dati. Per informazioni sulle annotazioni in una fonte di dati specifica, consulta. Connessione alle origini dati

Interrogazione integrata

Dopo aver aggiunto un'annotazione, sarà ancora visibile. Ciò è dovuto alla query di annotazione integrata presente in tutti i dashboard. Questa query di annotazione recupererà tutti gli eventi di annotazione che provengono dalla dashboard corrente, che sono archiviati in Grafana, e li mostrerà nel pannello in cui sono stati creati. Ciò include le annotazioni della cronologia dello stato di avviso.

Per impostazione predefinita, la query di annotazione integrata utilizza l'origine dati Grafana speciale e le annotazioni manuali sono supportate solo utilizzando questa fonte di dati. È possibile utilizzare un'altra origine dati nella query di annotazione incorporata, ma sarà possibile creare annotazioni automatiche solo utilizzando l'editor di query per tale origine dati.

Per aggiungere annotazioni direttamente alla dashboard, questa query deve essere abilitata.

Per confermare che la query integrata è abilitata

1. Seleziona l'icona delle impostazioni della dashboard (ingranaggio) nell'intestazione della dashboard per aprire il menu delle impostazioni della dashboard.

2. Seleziona Annotazioni.

3. Trova la query Annotazioni e avvisi (integrata).

   Se mostra Disabilitato prima del nome della query, dovrai selezionare il nome della query per aprirla e aggiornare l'impostazione.

Per impedire che le annotazioni vengano recuperate e disegnate

1. Seleziona l'icona delle impostazioni della dashboard (ingranaggio) nell'intestazione della dashboard per aprire il menu delle impostazioni della dashboard.

2. Seleziona Annotazioni.

3. Seleziona la query Annotazioni e avvisi (integrata).

4. Seleziona l'interruttore Abilitato per disattivarlo.

Quando copi una dashboard utilizzando la funzione Salva con nome, riceverà un nuovo ID dashboard, quindi le annotazioni create sulla dashboard di origine non saranno più visibili nella copia. Puoi comunque mostrarle se aggiungi una nuova Annotation Query e filtra per tag. Tuttavia, questo funziona solo se le annotazioni nella dashboard di origine avevano tag in base ai quali filtrare.

Filtraggio delle query per tag

È possibile creare nuove query per recuperare le annotazioni dalla query di annotazione incorporata utilizzando l'origine Grafana dati impostando Filter by to. Tags

Ad esempio, create il nome outages di una query di annotazione e specificate un tag. outage Questa query mostrerà tutte le annotazioni (da qualsiasi dashboard o tramite API) con il outage tag. Se in una query di annotazione sono definiti più tag, Grafana mostrerà solo le annotazioni che corrispondono a tutti i tag. Per modificare il comportamento, abilita Match any e Grafana mostrerà le annotazioni che contengono uno qualsiasi dei tag che hai fornito.

Puoi anche utilizzare le variabili del modello nella query dei tag. Ciò significa che se disponi di una dashboard che mostra le statistiche per diversi servizi e di una variabile modello che determina quali servizi mostrare, puoi utilizzare la stessa variabile modello nella tua query di annotazione per mostrare solo le annotazioni per quei servizi.