28 Elementi principali

Descrizione

Questi parametri e i possibili valori delle proprietà per i rispettivi oggetti dei campi del widget della 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. Questo 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 l'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 nome valore
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, crea un oggetto campo del widget della dashboard per ogni gruppo host con un numero incrementato nel nome della proprietà.

Questo parametro non è supportato se si configura il widget su una dashboard del 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 su una dashboard del template.
Host 3 hostids.0 ID dell'host.

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

Questo parametro non è supportato se si configura il widget su una dashboard del template.
Host (Widget/Dashboard) 1 hostids._reference Invece dell'ID dell'host:
DASHBOARD.hostids - imposta il selettore Host 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 su una dashboard del 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 su una dashboard del 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 configurano i Tag host

Questo parametro non è supportato se si configura il widget su una dashboard del 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 configurano i Tag host

Questo parametro non è supportato se si configura il widget su una dashboard del 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 configurano i Tag host

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

Configurazione avanzata

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

Parametro type name value
Ordinamento host
Ordina per 0 host_ordering_order_by 0 - (predefinito) Nome host;
3 - Valore item.
Pattern item 1 host_ordering_item.0 Nome o pattern di Item (ad esempio, "*: Number of processed *values per second").

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

Quando si configura il widget in una template dashboard, devono essere impostati solo i pattern per gli item configurati sul template.

Comportamento del parametro:
- obbligatorio se Ordina per è impostato su "Valore item"
Ordine 0 host_ordering_order 2 - (predefinito) Primi N;
3 - Ultimi N.
Limite 0 host_ordering_limit I valori possibili vanno da 1 a 100.

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

Nota: per configurare più pattern di host, creare un oggetto campo del widget dashboard per ciascun pattern di host con 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 vanno da 1 a 100.

Predefinito: 10.

Colonne

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

Parameter type name value
Pattern degli item 1 columns.0.items.0 Nome o pattern dell'item (ad esempio, "*: Number of processed *values per second").

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

Quando si configura il widget su una dashboard del template, devono essere impostati solo i pattern per gli 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 esempio FF0000).
Mostra valore come 0 columns.0.display_value_as 1 - (predefinito) Numerico;
2 - Testo.
Visualizzazione 0 columns.0.display 1 - (predefinito) Come è;
2 - Barra;
3 - Indicatori;
6 - Sparkline.
Min 1 columns.0.min Qualsiasi valore numerico. Sono supportati i suffissi (ad esempio "1d", "2w", "4K", "8G").

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

Comportamento del parametro:
- supportato se Mostra valore come è impostato su "Numerico" e Visualizzazione è impostato su "Barra" o "Indicatori"
Sparkline
Larghezza 0 columns.0.sparkline.width Valori possibili nell'intervallo 0-10.

Predefinito: 1.

Comportamento del parametro:
- supportato se Visualizzazione è impostato su "Sparkline"
Riempimento 0 columns.0.sparkline.fill Valori possibili nell'intervallo 0-10.

Predefinito: 3.

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

Predefinito: 42A5F5.

Comportamento del parametro:
- supportato se Visualizzazione è impostato su "Sparkline"
Intervallo temporale 1 columns.0.sparkline.time_period._reference DASHBOARD._timeperiod - imposta il selettore Intervallo temporale come origine dei dati;
ABCDE._timeperiod - imposta un widget compatibile (con il parametro reference uguale a ABCDE) come origine dei dati.

Predefinito: DASHBOARD._timeperiod

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

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

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

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

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

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

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

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

Comportamento del parametro:
- supportato se Mostra valore come è impostato su "Testo"
Posizioni decimali 0 columns.0.decimal_places Valori possibili nell'intervallo 0-10.

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

Se Mostra valore come è impostato su "Testo":
0 - (predefinito) non usato;
4 - count;
6 - first;
7 - last.
Intervallo temporale 1 columns.0.time_period._reference DASHBOARD._timeperiod - imposta il selettore Intervallo temporale come origine dei dati;
ABCDE._timeperiod - imposta un widget compatibile (con il parametro reference uguale a ABCDE) come origine dei dati.

Predefinito: DASHBOARD._timeperiod

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

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

Comportamento del parametro:
- supportato se Intervallo temporale non è impostato e Funzione di aggregazione è impostato 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 in sintassi assoluta (YYYY-MM-DD hh:mm:ss) o relativa (now, now/d, now/w-1w, ecc.).

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

Comportamento del parametro:
- supportato se Mostra valore come è impostato su "Numerico"

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