29 Top item

Descrizione

Questi parametri e i possibili valori delle proprietà per i rispettivi oggetti campo del widget dashboard consentono di configurare il widget Top items 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 Top items, fare riferimento al comportamento dei parametri descritto nelle tabelle seguenti.

Parametri

I seguenti parametri sono supportati per il widget Top items.

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.
Gruppi host 2 groupids.0 ID del gruppo host.

Nota: Per configurare più gruppi host, creare un oggetto campo widget dashboard per ciascun gruppo host con un numero incrementale nel nome della proprietà.

Questo parametro non è supportato se si configura il widget in una dashboard template.
Gruppi host (Widget) 1 groupids._reference Invece dell'ID del gruppo host:
ABCDE._hostgroupids - imposta un widget compatibile (con il parametro Reference impostato su "ABCDE") come origine dati per i gruppi host.

Questo parametro non è supportato se si configura il widget in una dashboard template.
Host 3 hostids.0 ID dell'host.

Nota: Per configurare più host, creare un oggetto campo widget dashboard per ciascun host con un numero incrementale nel nome della proprietà. Per più host, il parametro Gruppi host non deve essere configurato oppure deve essere configurato con almeno un gruppo host a cui appartengono gli host configurati.

Questo parametro non è supportato se si configura il widget in una dashboard template.
Host (Widget/Dashboard) 1 hostids._reference Invece dell'ID dell'host:
DASHBOARD.hostids - imposta il selettore host della dashboard come origine dati per gli host;
ABCDE._hostids - imposta un widget compatibile (con il parametro Reference impostato su "ABCDE") come origine dati per gli host.

Questo parametro non è supportato se si configura il widget in una dashboard template.
Tag host
Tipo di valutazione 0 host_tags_evaltype 0 - (predefinito) And/Or;
2 - Or.

Questo parametro non è supportato se si configura il widget in una dashboard template.
Nome tag 1 host_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 configura Tag host

Questo parametro non è supportato se si configura il widget in una dashboard template.
Operatore 0 host_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 configura Tag host

Questo parametro non è supportato se si configura il widget in una dashboard template.
Valore tag 1 host_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 configura Tag host

Questo parametro non è supportato se si configura il widget in una dashboard template.
Layout 0 layout 0 - (predefinito) Orizzontale;
1 - Verticale.
Mostra problemi 0 show_problems 0 - Tutti;
1 - (predefinito) Non soppressi;
2 - Nessuno.
Item (vedere sotto)

Configurazione avanzata

I seguenti parametri di configurazione avanzata sono supportati per il widget Top items.

Parametro type name value
Ordinamento degli host
Ordina per 0 host_ordering_order_by 0 - (predefinito) Nome dell'host;
3 - Valore dell'item.
Pattern degli item 1 host_ordering_item.0 Nome o pattern dell'item (ad esempio, "*: Numero di *valori elaborati al secondo").

Nota: per configurare più pattern di item, creare un oggetto campo del widget dashboard per ogni pattern di item, utilizzando un numero incrementato nel nome della proprietà.

Quando si configura il widget in una dashboard del template, impostare solo i pattern degli item configurati nel template.

Comportamento del parametro:
- obbligatorio se Ordina per è impostato su "Valore dell'item"
Ordine 0 host_ordering_order 2 - (predefinito) Primi N;
3 - Ultimi N.
Limite 0 host_ordering_limit I valori possibili sono compresi tra 1 e 100.

Predefinito: 10.
Ordinamento degli item
Ordina per 0 item_ordering_order_by 1 - Host;
2 - Nome dell'item;
3 - (predefinito) Valore dell'item.
Pattern degli host 1 item_ordering_host.0 Nome o pattern dell'host.

Nota: per configurare più pattern di host, creare un oggetto campo del widget dashboard per ogni pattern di host, utilizzando un numero incrementato nel nome della proprietà.

Comportamento del parametro:
- obbligatorio se Ordina per è impostato su "Host"
Ordine 0 item_ordering_order 2 - (predefinito) Primi N;
3 - Ultimi N.
Limite 0 item_ordering_limit I valori possibili sono compresi tra 1 e 100.

Predefinito: 10.

Colonne

Il primo numero nel nome della proprietà (ad es., columns.0.items.0, columns.0.item_tags_evaltype) rappresenta la colonna specifica, mentre il secondo numero, se presente, rappresenta l'entità configurata (ad es., pattern di item, tag).

Parametro tipo nome valore
Pattern di item 1 columns.0.items.0 Nome o pattern dell'item (ad es., "*: Numero di *valori elaborati al secondo").

Nota: per configurare più pattern di item, creare un oggetto campo del widget dashboard per ogni pattern di item, incrementando il secondo numero nel nome della proprietà.

Quando si configura il widget in una dashboard di template, impostare solo i pattern degli item configurati nel template.

Comportamento del parametro:
- obbligatorio
Tag degli item
Tipo di valutazione 0 columns.0.item_tags_evaltype 0 - (predefinito) And/Or;
2 - Or.
Nome del tag 1 columns.0.item_tags.0.tag Qualsiasi valore stringa.

Nota: il secondo 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 degli item
Operatore 0 columns.0.item_tags.0.operator 0 - Contiene;
1 - Uguale a;
2 - Non contiene;
3 - Diverso da;
4 - Esiste;
5 - Non esiste.

Nota: il secondo 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 degli item
Valore del tag 1 columns.0.item_tags.0.value Qualsiasi valore stringa.

Nota: il secondo 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 degli item
Colore di base 1 columns.0.base_color Codice colore esadecimale (ad es., FF0000).
Visualizza valore come 0 columns.0.display_value_as 1 - (predefinito) Numerico;
2 - Testo.
Visualizzazione 0 columns.0.display 1 - (predefinito) Così com'è;
2 - Barra;
3 - Indicatori;
6 - Sparkline.
Min 1 columns.0.min Qualsiasi valore numerico. Sono supportati i suffissi (ad es., "1d", "2w", "4K", "8G").

Comportamento del parametro:
- supportato se Visualizza valore come è impostato su "Numerico" e Visualizzazione è impostata su "Barra" o "Indicatori"
Max 1 columns.0.max Qualsiasi valore numerico. Sono supportati i suffissi (ad es., "1d", "2w", "4K", "8G").

Comportamento del parametro:
- supportato se Visualizza valore come è impostato su "Numerico" e Visualizzazione è impostata su "Barra" o "Indicatori"
Sparkline
Larghezza 0 columns.0.sparkline.width I valori possibili sono compresi tra 0 e 10.

Predefinito: 1.

Comportamento del parametro:
- supportato se Visualizzazione è impostata su "Sparkline"
Riempimento 0 columns.0.sparkline.fill I valori possibili sono compresi tra 0 e 10.

Predefinito: 3.

Comportamento del parametro:
- supportato se Visualizzazione è impostata su "Sparkline"
Colore 1 columns.0.sparkline.color Codice colore esadecimale (ad es., FF0000).

Predefinito: 42A5F5.

Comportamento del parametro:
- supportato se Visualizzazione è impostata su "Sparkline"
Intervallo di tempo 1 columns.0.sparkline.time_period._reference DASHBOARD._timeperiod - imposta il selettore dell'intervallo di tempo della dashboard come origine dati;
ABCDE._timeperiod - imposta un widget compatibile (con il parametro reference uguale a ABCDE) come origine dati.

Predefinito: DASHBOARD._timeperiod

In alternativa, è possibile impostare l'intervallo di tempo solo nei parametri Da e A.

Comportamento del parametro:
- supportato se Visualizzazione è impostata su "Sparkline"
Da 1 columns.0.sparkline.time_period.from Stringa temporale valida nella sintassi assoluta (YYYY-MM-DD hh:mm:ss) o relativa (now, now/d, now/w-1w, ecc.).

Comportamento del parametro:
- supportato se Visualizzazione è impostata su "Sparkline"
- obbligatorio se columns.0.sparkline.time_period.to è impostato
A 1 columns.0.sparkline.time_period.to Stringa temporale valida nella sintassi assoluta (YYYY-MM-DD hh:mm:ss) o relativa (now, now/d, now/w-1w, ecc.).

Comportamento del parametro:
- supportato se Visualizzazione è impostata su "Sparkline"
- obbligatorio se columns.0.sparkline.time_period.from è impostato
Dati storici 0 columns.0.sparkline.history 0 - (predefinito) Automatico;
1 - Cronologia;
2 - Trend.

Comportamento del parametro:
- supportato se Visualizzazione è impostata su "Sparkline"
Soglie
Colore 1 columns.0.thresholds.0.color Codice colore esadecimale (ad es., FF0000).

Comportamento del parametro:
- supportato se Visualizza valore come è impostato su "Numerico"
Soglia 1 columns.0.thresholds.0.threshold Qualsiasi valore numerico. Sono supportati i suffissi (ad es., "1d", "2w", "4K", "8G").

Comportamento del parametro:
- supportato se Visualizza valore come è impostato su "Numerico"
Evidenziazioni
Evidenziazione 1 columns.0.highlights.0.color Codice colore esadecimale (ad es., FF0000).

Comportamento del parametro:
- supportato se Visualizza valore come è impostato su "Testo"
Soglia 1 columns.0.highlights.0.pattern Qualsiasi espressione regolare.

Comportamento del parametro:
- supportato se Visualizza valore come è impostato su "Testo"
Posizioni decimali 0 columns.0.decimal_places I valori possibili sono compresi tra 0 e 10.

Predefinito: 2.
Configurazione avanzata
Funzione di aggregazione 0 columns.0.aggregate_function Se Visualizza valore come è impostato su "Numerico":
0 - (predefinito) non utilizzata;
1 - min;
2 - max;
3 - avg;
4 - count;
5 - sum;
6 - first;
7 - last.

Se Visualizza valore come è impostato su "Testo":
0 - (predefinito) non utilizzata;
4 - count;
6 - first;
7 - last.
Intervallo di tempo 1 columns.0.time_period._reference DASHBOARD._timeperiod - imposta il selettore dell'intervallo di tempo della dashboard come origine dati;
ABCDE._timeperiod - imposta un widget compatibile (con il parametro reference uguale a ABCDE) come origine dati.

Predefinito: DASHBOARD._timeperiod

In alternativa, è possibile impostare l'intervallo di tempo solo nei parametri Da e A.

Comportamento del parametro:
- supportato se Funzione di aggregazione è impostata su "min", "max", "avg", "count", "sum", "first", "last"
Da 1 columns.0.time_period.from Stringa temporale valida nella sintassi assoluta (YYYY-MM-DD hh:mm:ss) o relativa (now, now/d, now/w-1w, ecc.).

Comportamento del parametro:
- supportato se Intervallo di tempo non è impostato e Funzione di aggregazione è impostata su "min", "max", "avg", "count", "sum", "first", "last"
- obbligatorio se columns.0.time_period.to è impostato
A 1 columns.0.time_period.to Stringa temporale valida nella sintassi assoluta (YYYY-MM-DD hh:mm:ss) o relativa (now, now/d, now/w-1w, ecc.).

Comportamento del parametro:
- supportato se Intervallo di tempo non è impostato e Funzione di aggregazione è impostata su "min", "max", "avg", "count", "sum", "first", "last"
- obbligatorio se columns.0.time_period.from è impostato
Dati storici 0 columns.0.history 0 - (predefinito) Automatico;
1 - Cronologia;
2 - Trend.

Comportamento del parametro:
- supportato se Visualizza valore come è impostato su "Numerico"
Aggrega 0 columns.0.aggregate_columns 0 - (predefinito) Ogni item
1 - Combinati.

Comportamento del parametro:
- supportato se Visualizza valore come è impostato su "Numerico" e Visualizzazione è impostata su "Così com'è", "Barra" o "Indicatori".
Funzione di aggregazione combinata 0 columns.0.column_aggregate_function 1 - min;
2 - max;
3 - avg;
4 - count;
5 - sum (predefinito).

Comportamento del parametro:
- obbligatorio se si configura Aggrega.
Nome della colonna combinata 1 columns.0.combined_column_name Qualsiasi valore stringa.

Comportamento del parametro:
- obbligatorio se si configura Aggrega.

Esempi

Gli esempi seguenti hanno lo scopo di descrivere solo la configurazione degli oggetti campo del widget della dashboard per il widget Top items. Per ulteriori informazioni sulla configurazione di una dashboard, vedere dashboard.create.

Configurazione di un widget Top items

Configurare un widget Top items che visualizzi i dati per l'host "10084" e solo per gli item per i quali il tag con nome "component" contiene il valore "cpu". Inoltre, visualizzare i dati con gli host posizionati in alto e utilizzare una barra indicatrice colorata per la rappresentazione delle celle.

Richiesta:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "topitems",
                        "name": "Top items",
                        "x": 0,
                        "y": 0,
                        "width": 36,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 3,
                                "name": "hostids.0",
                                "value": 10084
                            },
                            {
                                "type": 1,
                                "name": "columns.0.items.0",
                                "value": "*"
                            },
                            {
                                "type": 1,
                                "name": "columns.0.item_tags.0.tag",
                                "value": "component"
                            },
                            {
                                "type": 0,
                                "name": "columns.0.item_tags.0.operator",
                                "value": 0
                            },
                            {
                                "type": 1,
                                "name": "columns.0.item_tags.0.value",
                                "value": "cpu"
                            },
                            {
                                "type": 0,
                                "name": "columns.0.display",
                                "value": 2
                            },
                            {
                                "type": 0,
                                "name": "layout",
                                "value": 1
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

Risposta:

{
    "jsonrpc": "2.0",
    "result": {
        "dashboardids": [
            "3"
        ]
    },
    "id": 1
}

Vedi anche