Sommaire
11 Honeycomb
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 Honeycomb 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 Honeycomb, 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 Honeycomb.
| 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. |
|
| Groupes d’hôtes | 2 | groupids.0 | ID du groupe d’hôtes. Remarque : Pour configurer plusieurs groupes d’hôtes, créez un objet de champ de widget de tableau de bord pour chaque groupe d’hôtes avec un numéro incrémenté dans le nom de la propriété. Ce paramètre n’est pas pris en charge lors de la configuration du widget sur un tableau de bord de modèle. |
|
| Groupes d’hôtes (Widget) | 1 | groupids._reference | Au lieu de l’ID du groupe d’hôtes :ABCDE._hostgroupids - définissez un widget compatible (avec son paramètre Reference défini sur "ABCDE") comme source de données pour les groupes d’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. |
|
| Hôtes | 3 | hostids.0 | ID de l’hôte. Remarque : Pour configurer plusieurs hôtes, créez un objet de champ de widget de tableau de bord pour chaque hôte avec un numéro incrémenté dans le nom de la propriété. Pour plusieurs hôtes, le paramètre Groupes d’hôtes ne doit soit pas être configuré du tout, soit être configuré avec au moins un groupe d’hôtes auquel appartiennent les hôtes configurés. Ce paramètre n’est pas pris en charge lors de la configuration du widget sur un tableau de bord de modèle. |
|
| Hôtes (Widget/Tableau de bord) | 1 | hostids._reference | Au lieu de l’ID de l’hôte :DASHBOARD.hostids - définissez le sélecteur d’hôte du tableau de bord comme source de données pour les hôtes ;ABCDE._hostids - définissez un widget compatible (avec son paramètre Reference défini sur "ABCDE") 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. |
|
| Tags d’hôte | ||||
| Type d’évaluation | 0 | evaltype_host | 0 - (par défaut) Et/Ou; 2 - Ou. Ce paramètre n’est pas pris en charge lors de la configuration du widget sur un tableau de bord de modèle. |
|
| Nom du tag | 1 | host_tags.0.tag | Toute valeur de chaîne. Remarque : Le numéro dans le nom de la propriété fait référence à l’ordre du tag dans la liste d’évaluation des tags. Comportement du paramètre : - obligatoire lors de la configuration de Tags d’hôte Ce paramètre n’est pas pris en charge lors de la configuration du widget sur un tableau de bord de modèle. |
|
| Opérateur | 0 | host_tags.0.operator | 0 - Contient; 1 - Égal à; 2 - Ne contient pas; 3 - Différent de; 4 - Existe; 5 - N’existe pas. Remarque : Le numéro dans le nom de la propriété fait référence à l’ordre du tag dans la liste d’évaluation des tags. Comportement du paramètre : - obligatoire lors de la configuration de Tags d’hôte Ce paramètre n’est pas pris en charge lors de la configuration du widget sur un tableau de bord de modèle. |
|
| Valeur du tag | 1 | host_tags.0.value | Toute valeur de chaîne. Remarque : Le numéro dans le nom de la propriété fait référence à l’ordre du tag dans la liste d’évaluation des tags. Comportement du paramètre : - obligatoire lors de la configuration de Tags d’hôte Ce paramètre n’est pas pris en charge lors de la configuration du widget sur un tableau de bord de modèle. |
|
| Modèles d’élément | 1 | items.0 | Nom ou modèle de l’élément. Remarque : Pour configurer plusieurs modèles d’élément, créez un objet de champ de widget de tableau de bord pour chaque modèle d’élément avec un numéro incrémenté dans le nom de la propriété. Comportement du paramètre : - obligatoire |
|
| Tags d’élément | ||||
| Type d’évaluation | 0 | evaltype_item | 0 - (par défaut) Et/Ou; 2 - Ou. |
|
| Nom du tag | 1 | item_tags.0.tag | Toute valeur de chaîne. Remarque : Le numéro dans le nom de la propriété fait référence à l’ordre du tag dans la liste d’évaluation des tags. Comportement du paramètre : - obligatoire lors de la configuration de Tags d’élément |
|
| Opérateur | 0 | item_tags.0.operator | 0 - Contient; 1 - Égal à; 2 - Ne contient pas; 3 - Différent de; 4 - Existe; 5 - N’existe pas. Remarque : Le numéro dans le nom de la propriété fait référence à l’ordre du tag dans la liste d’évaluation des tags. Comportement du paramètre : - obligatoire lors de la configuration de Tags d’élément |
|
| Valeur du tag | 1 | item_tags.0.value | Toute valeur de chaîne. Remarque : Le numéro dans le nom de la propriété fait référence à l’ordre du tag dans la liste d’évaluation des tags. Comportement du paramètre : - obligatoire lors de la configuration de Tags d’élément |
|
| Afficher les hôtes en maintenance | 0 | maintenance | 0 - (par défaut) Désactivé; 1 - Activé. |
|
| Afficher | 0 | show.0 | 1 - Étiquette principale; 2 - Étiquette secondaire. 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 la propriété. Par défaut : 1, 2. |
|
| Reference | 1 | reference | Toute valeur de chaîne composée de 5 caractères (par exemple, ABCDE ou JBPNL). Cette valeur doit être unique dans le tableau de bord auquel appartient le widget.Comportement du paramètre : - obligatoire |
|
Configuration avancée
Les paramètres de configuration avancée suivants sont pris en charge pour le widget Honeycomb.
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 |
|---|---|---|---|
| Libellé principal | |||
| Type | 0 | primary_label_type | 0 - (par défaut) Texte; 1 - Valeur. |
| Texte | 1 | primary_label | Toute valeur de chaîne, y compris les macros. Macros prises en charge : {HOST.*}, {ITEM.*}, {INVENTORY.*}, macros utilisateur. Par défaut : {HOST.NAME} Comportement du paramètre : - pris en charge si Type est défini sur "Text" |
| Décimales | 0 | primary_label_decimal_places | Les valeurs possibles vont de 0 à 6. Par défaut : 2. Comportement du paramètre : - pris en charge si Type est défini sur "Value" |
| Taille (type) | 0 | primary_label_size_type | 0 - (par défaut) Auto; 1 - Personnalisée. |
| Taille | 0 | primary_label_size | Les valeurs possibles vont de 1 à 100. Par défaut : 20. Comportement du paramètre : - pris en charge si Taille (type) est défini sur "Custom" |
| Gras | 0 | primary_label_bold | 0 - (par défaut) Désactivé; 1 - Activé. |
| Couleur | 1 | primary_label_color | Code couleur hexadécimal (par exemple, FF0000).Par défaut : basé sur theme de l'objet Settings et l'objet User :1F2C33 pour "blue-theme" ou "hc-light" ;EEEEEE pour "dark-theme" ou "hc-dark". |
| Unités (case à cocher) | 0 | primary_label_units_show | 0 - Désactivé; 1 - (par défaut) Activé. Comportement du paramètre : - pris en charge si Type est défini sur "Value" |
| Unités (valeur) | 1 | primary_label_units | Toute valeur de chaîne."" (vide)Comportement du paramètre : - pris en charge si Type est défini sur "Value" et Unités (case à cocher) est défini sur "Activé" |
| Position | 0 | primary_label_units_pos | 0 - Avant la valeur ; 1 - (par défaut) Après la valeur. Comportement du paramètre : - pris en charge si Type est défini sur "Value" et 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. |
| Libellé secondaire | |||
| Type | 0 | secondary_label_type | 0 - Texte; 1 - (par défaut) Valeur. |
| Texte | 1 | secondary_label | Toute valeur de chaîne, y compris les macros. Macros prises en charge : {HOST.*}, {ITEM.*}, {INVENTORY.*}, macros utilisateur. Par défaut : {{ITEM.LASTVALUE}.fmtnum(2)} Comportement du paramètre : - pris en charge si Type est défini sur "Text" |
| Décimales | 0 | secondary_label_decimal_places | Les valeurs possibles vont de 0 à 6. Par défaut : 2. Comportement du paramètre : - pris en charge si Type est défini sur "Value" |
| Taille (type) | 0 | secondary_label_size_type | 0 - (par défaut) Auto; 1 - Personnalisée. |
| Taille | 0 | secondary_label_size | Les valeurs possibles vont de 1 à 100. Par défaut : 30. Comportement du paramètre : - pris en charge si Taille (type) est défini sur "Custom" |
| Gras | 0 | secondary_label_bold | 0 - Désactivé; 1 - (par défaut) Activé. |
| Couleur | 1 | secondary_label_color | Code couleur hexadécimal (par exemple, FF0000).Par défaut : basé sur theme de l'objet Settings et l'objet User :1F2C33 pour "blue-theme" ou "hc-light" ;EEEEEE pour "dark-theme" ou "hc-dark". |
| Unités (case à cocher) | 0 | secondary_label_units_show | 0 - Désactivé; 1 - (par défaut) Activé. Comportement du paramètre : - pris en charge si Type est défini sur "Value" |
| Unités (valeur) | 1 | secondary_label_units | Toute valeur de chaîne."" (vide)Comportement du paramètre : - pris en charge si Type est défini sur "Value" et Unités (case à cocher) est défini sur "Activé" |
| Position | 0 | secondary_label_position | 0 - Avant la valeur ; 1 - (par défaut) Après la valeur. Comportement du paramètre : - pris en charge si Type est défini sur "Value" et 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 d'arrière-plan | |||
| Couleur d'arrière-plan | 1 | bg_color | Code couleur hexadécimal (par exemple, FF0000).Par défaut : basé sur theme de l'objet Settings et l'objet User :D9E7ED pour "blue-theme" ;3D5059 pour "dark-theme" ;AAD7E9 pour "hc-light" ;335463 pour "hc-dark". |
| Seuils | |||
| Interpolation des couleurs | 0 | interpolation | 0 - Désactivé; 1 - (par défaut) Activé. |
| 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. |
Exemples
Les exemples suivants visent uniquement à décrire la configuration des objets de champ de widget du widget Honeycomb.
Pour plus d’informations sur la configuration d’un tableau de bord, consultez dashboard.create.
Configuration d’un widget Honeycomb
Configurez un widget Honeycomb qui affiche l’utilisation des processus du serveur Zabbix. De plus, modifiez l’étiquette principale des cellules du nid d’abeilles et ajustez visuellement le widget à l’aide de seuils.
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": "30",
"auto_start": "1",
"pages": [
{
"widgets": [
{
"type": "honeycomb",
"name": "Honeycomb",
"x": "0",
"y": "0",
"width": "24",
"height": "5",
"view_mode": "0",
"fields": [
{
"type": 2,
"name": "groupids.0",
"value": 4
},
{
"type": 3,
"name": "hostids.0",
"value": 10084
},
{
"type": 1,
"name": "items.0",
"value": "Zabbix server: Utilization*"
},
{
"type": 1,
"name": "primary_label",
"value": "{ITEM.NAME}"
},
{
"type": 1,
"name": "thresholds.0.color",
"value": "0EC9AC"
},
{
"type": 1,
"name": "thresholds.0.threshold",
"value": "0"
},
{
"type": 1,
"name": "thresholds.1.color",
"value": "FFD54F"
},
{
"type": 1,
"name": "thresholds.1.threshold",
"value": "70"
},
{
"type": 1,
"name": "thresholds.2.color",
"value": "FF465C"
},
{
"type": 1,
"name": "thresholds.2.threshold",
"value": "90"
},
{
"type": 1,
"name": "reference",
"value": "KSTMQ"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Réponse :
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}