21 Grafico a torta
Descrizione
Questi parametri e i possibili valori delle proprietà per i rispettivi oggetti campo del widget dashboard consentono di configurare il widget Grafico a torta nei metodi dashboard.create e dashboard.update.
Le proprietà fields del widget non vengono validate durante la creazione o l'aggiornamento di una dashboard.
Ciò consente agli utenti di modificare i widget integrati e creare widget personalizzati, ma introduce anche il rischio di creare o aggiornare i widget in modo errato.
Per garantire la corretta creazione o il corretto aggiornamento del widget Grafico a torta, fare riferimento al comportamento dei parametri descritto nelle tabelle seguenti.
Parametri
I seguenti parametri sono supportati per il widget Grafico a torta.
| Parametro | type | name | value |
|---|---|---|---|
| Intervallo di aggiornamento | 0 | rf_rate | 0 - Nessun aggiornamento; 10 - 10 secondi; 30 - 30 secondi; 60 - (predefinito) 1 minuto; 120 - 2 minuti; 600 - 10 minuti; 900 - 15 minuti. |
Set di dati
I seguenti parametri sono supportati per configurare un Set di dati.
Il primo numero nel nome della proprietà (ad esempio ds.0.hosts.0, ds.0.items.0) rappresenta lo specifico set di dati, mentre il secondo numero, se presente, rappresenta l'host o l'item configurato.
| Parametro | type | name | value | |
|---|---|---|---|---|
| Tipo di set di dati | 0 | ds.0.dataset_type | 0 - Elenco item; 1 - (predefinito) Modelli di item. |
|
| Item | 4 | ds.0.itemids.0 | ID Item. Quando si configura il widget in una dashboard template, devono essere impostati solo gli item configurati sul template. Nota: Per configurare più item, creare un oggetto campo widget della dashboard per ciascun item con un numero incrementato nel nome della proprietà. Comportamento del parametro: - obbligatorio se Tipo di set di dati è impostato su "Elenco item" e Item (Widget) non è impostato |
|
| Item (Widget) | 1 | ds.0.itemids.0._reference | Invece dell'ID Item:ABCDE._itemid - imposta un widget compatibile (con il parametro Reference impostato su "ABCDE") come origine dati per gli item.Nota: Per configurare più widget, creare un oggetto campo widget della dashboard per ciascun widget con un numero incrementato nel nome della proprietà. Comportamento del parametro: - obbligatorio se Tipo di set di dati è impostato su "Elenco item" e Item non è impostato |
|
| Colore | 1 | ds.0.color.0 | Codice colore esadecimale (ad esempio FF0000).Comportamento del parametro: - obbligatorio se Tipo di set di dati è impostato su "Elenco item" |
|
| Tipo di item | 0 | ds.0.type.0 | 0 - (predefinito) Normale; 1 - Totale. Il valore "Totale" può essere impostato solo per un item nell'intero grafico. Comportamento del parametro: - supportato se Tipo di set di dati è impostato su "Elenco item" |
|
| Modelli di host | 1 | ds.0.hosts.0 | Nome o modello di Host (ad esempio, "Zabbix*"). Comportamento del parametro: - obbligatorio se Tipo di set di dati è impostato su "Modelli di item" Questo parametro non è supportato se si configura il widget in una dashboard template. |
|
| Modelli di item | 1 | ds.0.items.0 | Nome o modello di Item (ad esempio, "*: Number of processed *values per second"). Quando si configura il widget in una dashboard template, devono essere impostati solo i modelli per gli item configurati sul template. Comportamento del parametro: - obbligatorio se Tipo di set di dati è impostato su "Modelli di item" |
|
| Colore | 1 | ds.0.color | Codice colore esadecimale (ad esempio FF0000).Comportamento del parametro: - supportato se Tipo di set di dati è impostato su "Modelli di item" e Tavolozza colori non è impostata |
|
| Tavolozza colori | 0 | ds.0.color_palette | Indice della tavolozza colori. I valori possibili vanno da 0 a 11. Predefinito: 0. Comportamento del parametro: - supportato se Tipo di set di dati è impostato su "Modelli di item" e Colore non è impostato |
|
| Funzione di aggregazione | 0 | ds.0.aggregate_function | 1 - min; 2 - max; 3 - avg; 4 - count; 5 - sum; 6 - first; 7 - (predefinito) last. |
|
| Aggregazione del set di dati | 0 | ds.0.dataset_aggregation | 0 - (predefinito) nessuna; 1 - min; 2 - max; 3 - avg; 4 - count; 5 - sum. Comportamento del parametro: - supportato se Tipo di item è impostato su "Totale" |
|
| Etichetta del set di dati | 1 | ds.0.data_set_label | Qualsiasi valore stringa. Predefinito: "" (vuoto). |
|
| Tag item | ||||
| Tipo di valutazione | 0 | ds.0.item_tags_evaltype | 0 - (predefinito) And/Or; 2 - Or. |
|
| Nome tag | 1 | ds.0.item_tags.0.tag | Qualsiasi valore stringa. Nota: Il numero nel nome della proprietà fa riferimento all'ordine del tag nell'elenco di valutazione dei tag. Comportamento del parametro: - obbligatorio se si configurano i Tag item |
|
| Operatore | 0 | ds.0.item_tags.0.operator | 0 - Contiene; 1 - Uguale a; 2 - Non contiene; 3 - Diverso da; 4 - Esiste; 5 - Non esiste. Nota: Il numero nel nome della proprietà fa riferimento all'ordine del tag nell'elenco di valutazione dei tag. Comportamento del parametro: - obbligatorio se si configurano i Tag item |
|
| Valore tag | 1 | ds.0.item_tags.0.value | Qualsiasi valore stringa. Nota: Il numero nel nome della proprietà fa riferimento all'ordine del tag nell'elenco di valutazione dei tag. Comportamento del parametro: - obbligatorio se si configurano i Tag item |
|
Opzioni di visualizzazione
I seguenti parametri sono supportati per configurare le Opzioni di visualizzazione.
| Parameter | type | name | value | |
|---|---|---|---|---|
| Selezione dei dati storici | 0 | source | 0 - (predefinito) Auto; 1 - Storico; 2 - Trend. |
|
| Disegno | 0 | draw_type | 0 - (predefinito) Torta; 1 - Ciambella. |
|
| Larghezza | 0 | width | 20 - 20% del raggio; 30 - 30% del raggio; 40 - 40% del raggio; 50 - (predefinito) 50% del raggio. Comportamento del parametro: - supportato se Disegno è impostato su "Ciambella" |
|
| Larghezza del bordo | 0 | stroke | I valori possibili vanno da 0 a 10. Predefinito: 0. Comportamento del parametro: - supportato se Disegno è impostato su "Ciambella" |
|
| Mostra valore totale | 0 | total_show | 0 - (predefinito) Disabilitato; 1 - Abilitato. Comportamento del parametro: - supportato se Disegno è impostato su "Ciambella" |
|
| Dimensione | 0 | value_size_type | 0 - (predefinito) Auto; 1 - Personalizzata. Comportamento del parametro: - supportato se Mostra valore totale è impostato su "Abilitato" |
|
| Dimensione (valore per dimensione personalizzata) | 0 | value_size | I valori possibili vanno da 1 a 100. Predefinito: 20. Comportamento del parametro: - supportato se Mostra valore totale è impostato su "Abilitato" |
|
| Posizioni decimali | 0 | decimal_places | I valori possibili vanno da 0 a 6. Predefinito: 2. Comportamento del parametro: - supportato se Mostra valore totale è impostato su "Abilitato" |
|
| Unità (casella di controllo) | 0 | units_show | 0 - (predefinito) Disabilitato; 1 - Abilitato. Comportamento del parametro: - supportato se Mostra valore totale è impostato su "Abilitato" |
|
| Unità (valore) | 1 | units | Qualsiasi valore stringa. Comportamento del parametro: - supportato se Unità (casella di controllo) è impostato su "Abilitato" |
|
| Grassetto | 0 | value_bold | 0 - (predefinito) Disabilitato; 1 - Abilitato. Comportamento del parametro: - supportato se Mostra valore totale è impostato su "Abilitato" |
|
| Colore | 1 | value_color | Codice colore esadecimale (ad esempio FF0000).Comportamento del parametro: - supportato se Mostra valore totale è impostato su "Abilitato" |
|
| Spazio tra i settori | 0 | space | I valori possibili vanno da 0 a 10. Predefinito: 1. |
|
| Unisci i settori più piccoli di N% (casella di controllo) | 0 | merge | 0 - (predefinito) Disabilitato; 1 - Abilitato. |
|
| Unisci i settori più piccoli di N% (valore) | 0 | merge_percent | I valori possibili vanno da 1 a 10. Predefinito: 1. Comportamento del parametro: - supportato se Unisci i settori più piccoli di N% (casella di controllo) è impostato su "Abilitato" |
|
| Unisci i settori più piccoli di N% (colore) | 1 | merge_color | Codice colore esadecimale (ad esempio FF0000).Comportamento del parametro: - supportato se Unisci i settori più piccoli di N% (casella di controllo) è impostato su "Abilitato" |
|
Periodo di tempo
I seguenti parametri sono supportati per la configurazione di Periodo di tempo.
| Parametro | type | name | value | |
|---|---|---|---|---|
| Periodo di tempo | 1 | time_period._reference | DASHBOARD._timeperiod - imposta il selettore del periodo di tempo della dashboard come origine dati;ABCDE._timeperiod - imposta un widget compatibile (con il parametro Reference impostato su "ABCDE") come origine dati.Predefinito: DASHBOARD._timeperiodIn alternativa, è possibile impostare il periodo di tempo solo nei parametri Da e A. |
|
| Da | 1 | time_period.from | Stringa temporale valida in sintassi temporale assoluta (YYYY-MM-DD hh:mm:ss) o relativa (now, now/d, now/w-1w, ecc.).Comportamento del parametro: - supportato se Periodo di tempo non è impostato - obbligatorio se time_period.to è impostato |
|
| A | 1 | time_period.to | Stringa temporale valida in sintassi temporale assoluta (YYYY-MM-DD hh:mm:ss) o relativa (now, now/d, now/w-1w, ecc.).Comportamento del parametro: - supportato se Periodo di tempo non è impostato - obbligatorio se time_period.from è impostato |
|
Legenda
I seguenti parametri sono supportati per la configurazione della Legenda.
| Parametro | type | name | value |
|---|---|---|---|
| Mostra legenda | 0 | legend | 0 - Disabilitato; 1 - (predefinito) Abilitato. |
| Mostra valore | 0 | legend_value | 0 - (predefinito) Disabilitato; 1 - Abilitato. Comportamento del parametro: - supportato se Mostra legenda è impostato su "Abilitato" |
| Mostra funzione di aggregazione | 0 | legend_aggregation | 0 - (predefinito) Disabilitato; 1 - Abilitato. Comportamento del parametro: - supportato se Mostra legenda è impostato su "Abilitato" |
| Righe | 0 | legend_lines_mode | 0 - (predefinito) Fisso; 1 - Variabile. Comportamento del parametro: - supportato se Mostra legenda è impostato su "Abilitato" |
| Numero di righe/ Numero massimo di righe |
0 | legend_lines | I valori possibili vanno da 1 a 10. Predefinito: 1. Comportamento del parametro: - supportato se Mostra legenda è impostato su "Abilitato" |
| Numero di colonne | 0 | legend_columns | I valori possibili vanno da 1 a 4. Predefinito: 4. Comportamento del parametro: - supportato se Mostra legenda è impostato su "Abilitato" e Mostra valore è impostato su "Disabilitato" |
Esempi
Gli esempi seguenti hanno lo scopo di descrivere solo la configurazione degli oggetti campo del widget del widget Grafico a torta.
Per ulteriori informazioni sulla configurazione di una dashboard, vedere dashboard.create.
Configurazione di un widget Grafico a torta
Configurare un widget Grafico a torta nel modo seguente:
- 2 set di dati per un totale di 9 item su 1 host.
- Il primo set di dati è di tipo "Elenco item" ed è composto da 3 item, tutti di tipo "Normale" e rappresentati da un colore diverso.
- Il secondo set di dati è di tipo "Pattern di item", è composto da 6 item, ha un'aggregazione configurata per ciascun item ed è rappresentato da un colore personalizzato.
- Il secondo set di dati ha anche un'etichetta del set di dati personalizzata.
- I dati nel grafico a torta sono visualizzati come grafico ad anello con una larghezza personalizzata e il valore totale con unità al centro.
- I dati nel grafico a torta sono visualizzati e aggregati per un periodo di tempo personalizzato delle ultime 3 ore.
- La legenda del grafico a torta visualizza gli item configurati in 4 righe.
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "piechart",
"name": "Pie chart",
"x": 0,
"y": 0,
"width": 24,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 0,
"name": "ds.0.dataset_type",
"value": 0
},
{
"type": 4,
"name": "ds.0.itemids.0",
"value": 23264
},
{
"type": 1,
"name": "ds.0.color.0",
"value": "FF0000"
},
{
"type": 0,
"name": "ds.0.type.0",
"value": 0
},
{
"type": 4,
"name": "ds.0.itemids.1",
"value": 23269
},
{
"type": 1,
"name": "ds.0.color.1",
"value": "BF00FF"
},
{
"type": 0,
"name": "ds.0.type.1",
"value": 0
},
{
"type": 4,
"name": "ds.0.itemids.2",
"value": 23257
},
{
"type": 1,
"name": "ds.0.color.2",
"value": "0040FF"
},
{
"type": 0,
"name": "ds.0.type.2",
"value": 0
},
{
"type": 1,
"name": "ds.1.hosts.0",
"value": "Zabbix server"
},
{
"type": 1,
"name": "ds.1.items.0",
"value": "*: Number of processed *values per second"
},
{
"type": 1,
"name": "ds.1.color",
"value": "000000"
},
{
"type": 0,
"name": "ds.1.aggregate_function",
"value": 3
},
{
"type": 1,
"name": "ds.1.data_set_label",
"value": "Number of processed values per second"
},
{
"type": 0,
"name": "draw_type",
"value": 1
},
{
"type": 0,
"name": "width",
"value": 30
},
{
"type": 0,
"name": "total_show",
"value": 1
},
{
"type": 0,
"name": "units_show",
"value": 1
},
{
"type": 0,
"name": "graph_time",
"value": 1
},
{
"type": 1,
"name": "time_period.from",
"value": "now-3h"
},
{
"type": 1,
"name": "time_period.to",
"value": "now"
},
{
"type": 0,
"name": "legend_lines",
"value": 4
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}
Risposta:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}