6 Jauge

Description

Ces paramètres et les valeurs de propriété possibles pour les objets de champ du widget de tableau de bord correspondants permettent de configurer le widget Gauge dans les méthodes dashboard.create et dashboard.update.

Les propriétés fields du widget ne sont pas validées lors de la création ou de la mise à jour d’un tableau de bord. Cela permet aux utilisateurs de modifier les widgets intégrés et de créer des widgets personnalisés, mais introduit également le risque de créer ou de mettre à jour des widgets de manière incorrecte. Pour garantir la réussite de la création ou de la mise à jour du widget Gauge, veuillez vous référer au comportement des paramètres décrit dans les tableaux ci-dessous.

Paramètres

Les paramètres suivants sont pris en charge pour le widget Jauge.

Paramètre type name value
Intervalle d’actualisation 0 rf_rate 0 - Aucune actualisation;
10 - 10 secondes;
30 - 30 secondes;
60 - (par défaut) 1 minute;
120 - 2 minutes;
600 - 10 minutes;
900 - 15 minutes.
Élément 4 itemid.0 ID de l’élément.

Comportement du paramètre :
- obligatoire si Élément (widget) n’est pas défini
Élément (widget) 1 itemid._reference Au lieu de l’ID de l’élément :
ABCDE._itemid - définir un widget compatible (avec son paramètre Référence défini sur "ABCDE") comme source de données pour les éléments.

Comportement du paramètre :
- obligatoire si Élément n’est pas défini
Min 1 min Toute valeur numérique. Les suffixes (par ex. "1d", "2w", "4K", "8G") sont pris en charge.

Par défaut : "0".
Max 1 max Toute valeur numérique. Les suffixes (par ex. "1d", "2w", "4K", "8G") sont pris en charge.

Par défaut : "100".
Arc de valeur 1 value_arc_color Code couleur hexadécimal (par ex. FF0000).

Par défaut : "" (vide).
Arrière-plan de l’arc 1 empty_color Code couleur hexadécimal (par ex. FF0000).

Par défaut : "" (vide).
Arrière-plan 1 bg_color Code couleur hexadécimal (par ex. FF0000).

Par défaut : "" (vide).
Afficher 0 show.0 1 - Description;
2 - Valeur;
3 - Aiguille;
4 - Échelle;
5 - Arc de valeur.

Remarque : pour configurer plusieurs valeurs, créez un objet de champ de widget de tableau de bord pour chaque valeur avec un numéro incrémenté dans le nom de propriété.

Par défaut : 1, 2, 4, 5.

Les valeurs "Aiguille" et "Échelle" ne sont pas prises en charge si les deux conditions suivantes sont remplies :
- aucun objet de champ de widget de tableau de bord pour Afficher avec la valeur "Arc de valeur" n’est défini ;
- le paramètre de configuration avancée Afficher l’arc est défini sur "Désactivé".

Les paramètres de configuration avancée pour les options de Afficher ne sont pas pris en charge si aucun objet de champ de widget de tableau de bord avec les valeurs correspondantes n’est défini.
Remplacer l’hôte 1 override_hostid._reference ABCDE._hostid - définir un widget compatible (avec son paramètre Référence défini sur "ABCDE") comme source de données pour les hôtes ;
DASHBOARD._hostid - définir le sélecteur d’hôte du tableau de bord comme source de données pour les hôtes.

Ce paramètre n’est pas pris en charge lors de la configuration du widget sur un tableau de bord de modèle.

Configuration avancée

Les paramètres de configuration avancée suivants sont pris en charge pour le widget Jauge.

Le nombre dans le nom de propriété Thresholds (par exemple, thresholds.0.color) fait référence à la position du seuil dans une liste, triée par ordre croissant. Cependant, si les seuils sont configurés dans un ordre différent, les valeurs seront triées par ordre croissant après la mise à jour de la configuration du widget dans l’interface Zabbix (par exemple, "thresholds.0.threshold":"5""thresholds.0.threshold":"1"; "thresholds.1.threshold":"1""thresholds.1.threshold": "5").

Paramètre type name value
Angle 0 angle Valeurs possibles : 180 (par défaut) ou 270.
Description
Description 1 description Toute valeur de chaîne, y compris les macros.
Macros prises en charge : {HOST.*}, {ITEM.*}, {INVENTORY.*}, macros utilisateur.

Par défaut : {ITEM.NAME}.
Taille 0 desc_size Les valeurs possibles vont de 1 à 100.

Par défaut : 15.
Position verticale 0 desc_v_pos 0 - Haut ;
1 - (par défaut) Bas.
Gras 0 desc_bold 0 - (par défaut) Désactivé ;
1 - Activé.
Couleur 1 desc_color Code couleur hexadécimal (par exemple, FF0000).

Par défaut : "" (vide).
Valeur
Décimales 0 decimal_places Les valeurs possibles vont de 1 à 10.

Par défaut : 2.
Taille 0 value_size Les valeurs possibles vont de 1 à 100.

Par défaut : 25.
Gras 0 value_bold 0 - (par défaut) Désactivé ;
1 - Activé.
Couleur 1 value_color Code couleur hexadécimal (par exemple, FF0000).

Par défaut : "" (vide).
Unités
Unités (case à cocher) 0 units_show 0 - Désactivé ;
1 - (par défaut) Activé.
Unités (valeur) 1 units Toute valeur de chaîne.

Comportement du paramètre :
- pris en charge si Unités (case à cocher) est défini sur "Activé"
Taille 0 units_size Les valeurs possibles vont de 1 à 100.

Par défaut : 25.

Comportement du paramètre :
- pris en charge si Unités (case à cocher) est défini sur "Activé"
Gras 0 units_bold 0 - (par défaut) Désactivé ;
1 - Activé.

Comportement du paramètre :
- pris en charge si Unités (case à cocher) est défini sur "Activé"
Position 0 units_pos 0 - Avant la valeur ;
1 - Au-dessus de la valeur ;
2 - (par défaut) Après la valeur ;
3 - En dessous de la valeur.

Comportement du paramètre :
- pris en charge si Unités (case à cocher) est défini sur "Activé"

Ce paramètre est ignoré s’il est défini sur l’une des unités liées au temps suivantes : unixtime, uptime, s.
Couleur 1 units_color Code couleur hexadécimal (par exemple, FF0000).

Par défaut : "" (vide).
Arc de valeur
Taille de l’arc 0 value_arc_size Les valeurs possibles vont de 1 à 100.

Par défaut : 20.
Aiguille
Couleur 1 needle_color Code couleur hexadécimal (par exemple, FF0000).

Par défaut : "" (vide).

Comportement du paramètre :
- pris en charge si un objet de champ de widget de tableau de bord pour Show avec la valeur "Value arc" est défini, ou si Show arc est défini sur "Activé"
Échelle
Afficher les unités 0 scale_show_units 0 - Désactivé ;
1 - (par défaut) Activé.

Comportement du paramètre :
- pris en charge si Unités (case à cocher) est défini sur "Activé" et si un objet de champ de widget de tableau de bord pour Show avec la valeur "Value arc" est défini, ou si Show arc est défini sur "Activé"
Taille 0 scale_size Les valeurs possibles vont de 1 à 100.

Par défaut : 15.

Comportement du paramètre :
- pris en charge si un objet de champ de widget de tableau de bord pour Show avec la valeur "Value arc" est défini, ou si Show arc est défini sur "Activé"
Décimales 0 scale_decimal_places Les valeurs possibles vont de 1 à 10.

Par défaut : 0.

Comportement du paramètre :
- pris en charge si un objet de champ de widget de tableau de bord pour Show avec la valeur "Value arc" est défini, ou si Show arc est défini sur "Activé"
Seuils
Couleur 1 thresholds.0.color Code couleur hexadécimal (par exemple, FF0000).
Seuil 1 thresholds.0.threshold Toute valeur numérique. Les suffixes (par exemple, "1d", "2w", "4K", "8G") sont pris en charge.
Afficher les étiquettes 0 th_show_labels 0 - (par défaut) Désactivé ;
1 - Activé.

Comportement du paramètre :
- pris en charge si des Seuils sont définis et si un objet de champ de widget de tableau de bord pour Show avec la valeur "Value arc" est défini ou si Show arc est défini sur "Activé"
Afficher l’arc 0 th_show_arc 0 - (par défaut) Désactivé ;
1 - Activé.

Comportement du paramètre :
- pris en charge si des Seuils sont définis
Taille de l’arc 0 th_arc_size Les valeurs possibles vont de 1 à 100.

Par défaut : 5.

Comportement du paramètre :
- pris en charge si Afficher l’arc est défini sur "Activé"

Exemples

Les exemples suivants visent uniquement à décrire la configuration des objets de champ du widget de tableau de bord pour le widget Gauge. Pour plus d’informations sur la configuration d’un tableau de bord, consultez dashboard.create.

Configuration d'un widget Gauge

Configurez un widget Gauge qui affiche la valeur d'élément pour l'élément « 44474 » (Interface enp0s3: Bits envoyés). De plus, ajustez finement l'apparence du widget à l'aide de plusieurs options avancées, y compris des seuils.

Requête:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "gauge",
                        "name": "Gauge",
                        "x": 0,
                        "y": 0,
                        "width": 18,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 4,
                                "name": "itemid.0",
                                "value": 44474
                            },
                            {
                                "type": 1,
                                "name": "min",
                                "value": "100000"
                            },
                            {
                                "type": 1,
                                "name": "max",
                                "value": "1000000"
                            },
                            {
                                "type": 0,
                                "name": "show.0",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "show.1",
                                "value": 2
                            },
                            {
                                "type": 0,
                                "name": "show.2",
                                "value": 3
                            },
                            {
                                "type": 0,
                                "name": "show.4",
                                "value": 4
                            },
                            {
                                "type": 0,
                                "name": "show.5",
                                "value": 5
                            },
                            {
                                "type": 0,
                                "name": "angle",
                                "value": 270
                            },
                            {
                                "type": 0,
                                "name": "desc_size",
                                "value": 10
                            },
                            {
                                "type": 0,
                                "name": "desc_bold",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "decimal_places",
                                "value": 0
                            },
                            {
                                "type": 0,
                                "name": "value_bold",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "units_size",
                                "value": 15
                            },
                            {
                                "type": 0,
                                "name": "units_pos",
                                "value": 3
                            },
                            {
                                "type": 1,
                                "name": "needle_color",
                                "value": "3C3C3C"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.0.color",
                                "value": "FF465C"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.0.threshold",
                                "value": "700000"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.1.color",
                                "value": "FFD54F"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.1.threshold",
                                "value": "500000"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.2.color",
                                "value": "0EC9AC"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.2.threshold",
                                "value": "100000"
                            },
                            {
                                "type": 0,
                                "name": "th_show_labels",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "th_show_arc",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "th_arc_size",
                                "value": 15
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

Réponse :

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

Voir aussi