Sommaire
25 Nuage de points
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 Scatter plot 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 Scatter plot, 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 Nuage de points.
| 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. |
| Référence | 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 |
Jeu de données
Les paramètres suivants sont pris en charge pour configurer un jeu de données.
Le premier nombre dans le nom de propriété (par exemple, ds.0.hosts.0, ds.0.items.0) représente le jeu de données particulier, tandis que le second nombre, s'il est présent, représente l'hôte ou l'élément configuré.
| Paramètre | < | type | name | value | |
|---|---|---|---|---|---|
| Type de jeu de données | < | 0 | ds.0.dataset_type | 0 - Liste d'éléments ; 1 - (par défaut) Modèles d'éléments. |
|
| Jeu de données : Liste d'éléments | < | < | < | ||
| Couleur | < | 1 | ds.0.color.0 | Code couleur hexadécimal (par exemple, FF0000).Comportement du paramètre : - obligatoire si Type de jeu de données est défini sur "Liste d'éléments" |
|
| Axe X | < | 4 | ds.0.x_axis_itemids.0 | ID d'élément. Lors de la configuration du widget sur un tableau de bord de modèle, seuls les éléments configurés sur le modèle doivent être définis. Remarque : Pour configurer plusieurs éléments, créez un objet de champ de widget de tableau de bord pour chaque élément avec un numéro incrémenté dans le nom de propriété. Comportement du paramètre : - obligatoire si Type de jeu de données est défini sur "Liste d'éléments" et que Axe X (Widget) n'est pas défini |
|
| Axe X (Widget) | < | 1 | ds.0.x_axis_itemids.0._reference | Au lieu de l'ID d'é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.Remarque : Pour configurer plusieurs widgets, créez un objet de champ de widget de tableau de bord pour chaque widget avec un numéro incrémenté dans le nom de propriété. Comportement du paramètre : - obligatoire si Type de jeu de données est défini sur "Liste d'éléments" et que Axe X n'est pas défini |
|
| Axe Y | < | 4 | ds.0.y_axis_itemids.0 | ID d'élément. Lors de la configuration du widget sur un tableau de bord de modèle, seuls les éléments configurés sur le modèle doivent être définis. Remarque : Pour configurer plusieurs éléments, créez un objet de champ de widget de tableau de bord pour chaque élément avec un numéro incrémenté dans le nom de propriété. Comportement du paramètre : - obligatoire si Type de jeu de données est défini sur "Liste d'éléments" et que Axe Y (Widget) n'est pas défini |
|
| Axe Y (Widget) | < | 1 | ds.0.y_axis_itemids.0._reference | Au lieu de l'ID d'é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.Remarque : Pour configurer plusieurs widgets, créez un objet de champ de widget de tableau de bord pour chaque widget avec un numéro incrémenté dans le nom de propriété. Comportement du paramètre : - obligatoire si Type de jeu de données est défini sur "Liste d'éléments" et que Axe Y n'est pas défini |
|
| Remplacer l'hôte | < | 1 | ds.0.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. |
|
| Jeu de données : Modèles d'éléments | < | < | < | ||
| Couleur | < | 1 | ds.0.color | Code couleur hexadécimal (par exemple, FF0000).Comportement du paramètre : - pris en charge si Type de jeu de données est défini sur "Modèles d'éléments" et que Palette de couleurs n'est pas définie |
|
| Palette de couleurs | < | 0 | ds.0.color_palette | Indice de palette de couleurs. Plage de valeurs possibles : 0-11. Par défaut : 0. Comportement du paramètre : - pris en charge si Type de jeu de données est défini sur "Modèles d'éléments" et que Couleur n'est pas définie |
|
| Modèles d'hôte | < | 1 | ds.0.hosts.0 | Nom ou modèle d'hôte (par exemple, "Zabbix*"). Comportement du paramètre : - obligatoire si Type de jeu de données est défini sur "Modèles d'éléments" 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éments de l'axe X | < | 1 | ds.0.x_axis_items.0 | Nom ou modèle d'élément (par exemple, "*: Number of processed *values per second"). Lors de la configuration du widget sur un tableau de bord de modèle, seuls les modèles pour les éléments configurés sur le modèle doivent être définis. Comportement du paramètre : - obligatoire si Type de jeu de données est défini sur "Modèles d'éléments" |
|
| Modèles d'éléments de l'axe Y | < | 1 | ds.0.y_axis_items.0 | Nom ou modèle d'élément (par exemple, "*: Number of processed *values per second"). Lors de la configuration du widget sur un tableau de bord de modèle, seuls les modèles pour les éléments configurés sur le modèle doivent être définis. Comportement du paramètre : - obligatoire si Type de jeu de données est défini sur "Modèles d'éléments" |
|
| Groupes d'hôtes | < | 2 | groupids.0 | ID de 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 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 de groupe d'hôtes :ABCDE._hostgroupids - définir un widget compatible (avec son paramètre Référence 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. |
|
| Remplacer l'hôte | < | 1 | ds.0.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. |
|
| Balises 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 de balise | 1 | host_tags.0.tag | Toute valeur de chaîne. Remarque : Le nombre dans le nom de propriété fait référence à l'ordre des balises dans la liste d'évaluation des balises. Comportement du paramètre : - obligatoire lors de la configuration des Balises 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 nombre dans le nom de propriété fait référence à l'ordre des balises dans la liste d'évaluation des balises. Comportement du paramètre : - obligatoire lors de la configuration des Balises 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 de balise | 1 | host_tags.0.value | Toute valeur de chaîne. Remarque : Le nombre dans le nom de propriété fait référence à l'ordre des balises dans la liste d'évaluation des balises. Comportement du paramètre : - obligatoire lors de la configuration des Balises 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. |
|
| Marqueur | < | 0 | ds.0.marker | 0 - (par défaut) Ellipse ; 1 - Carré ; 2 - Triangle ; 3 - Losange ; 4 - Étoile ; 5 - Croix. |
|
| Taille du marqueur | < | 0 | ds.0.marker_size | 0 - (par défaut) Petit (6px) ; 1 - Moyen (9px) ; 2 - Grand (15px). |
|
| Décalage temporel | < | 1 | ds.0.timeshift | Chaîne temporelle valide (par exemple, 3600, 1h, etc.).Vous pouvez utiliser des suffixes temporels. Les valeurs négatives sont également autorisées. Par défaut : "" (vide). |
|
| Intervalle d'agrégation | < | 1 | ds.0.aggregate_interval | Chaîne temporelle valide (par exemple, 3600, 1h, etc.).Vous pouvez utiliser des suffixes temporels. Par défaut : 15m. |
|
| Fonction d'agrégation | < | 0 | ds.0.aggregate_function | 0 - non utilisé ; 1 - min ; 2 - max ; 3 - (par défaut) avg ; 4 - count ; 5 - sum ; 6 - first ; 7 - last. |
|
Options d'affichage
Les paramètres suivants sont pris en charge pour configurer les options d'affichage.
| Paramètre | type | name | value |
|---|---|---|---|
| Sélection des données d'historique | 0 | source | 0 - (par défaut) Auto; 1 - Historique; 2 - Tendances. |
| Noms d'hôte dans les étiquettes | 0 | show_hostnames | 0 - (par défaut) Auto; 1 - Afficher; 2 - Masquer. Ce paramètre n'est pas pris en charge lors de la configuration du widget sur un tableau de bord de modèle. |
Période de temps
Les paramètres suivants sont pris en charge pour configurer la Période de temps.
| Paramètre | type | name | value | |
|---|---|---|---|---|
| Période de temps | 1 | time_period._reference | DASHBOARD._timeperiod - définit le sélecteur de période de temps du tableau de bord comme source de données ;ABCDE._timeperiod - définit un widget compatible (avec son paramètre Reference défini sur "ABCDE") comme source de données.Par défaut : DASHBOARD._timeperiodVous pouvez également définir la période de temps uniquement dans les paramètres From et To. |
|
| From | 1 | time_period.from | Chaîne de temps valide en syntaxe temporelle absolue (YYYY-MM-DD hh:mm:ss) ou relative (now, now/d, now/w-1w, etc.).Comportement du paramètre : - pris en charge si Période de temps n'est pas défini - obligatoire si time_period.to est défini |
|
| To | 1 | time_period.to | Chaîne de temps valide en syntaxe temporelle absolue (YYYY-MM-DD hh:mm:ss) ou relative (now, now/d, now/w-1w, etc.).Comportement du paramètre : - pris en charge si Période de temps n'est pas défini - obligatoire si time_period.from est défini |
|
Axes
Les paramètres suivants sont pris en charge pour configurer les axes.
| Paramètre | type | name | value |
|---|---|---|---|
| Axe X | 0 | x_axis | 0 - Désactivé; 1 - (par défaut) Activé. |
| Axe Y | 0 | y_axis | 0 - (par défaut) Désactivé; 1 - Activé. |
| Min | 1 | x_axis_min | Toute valeur numérique. Par défaut : "" (vide). |
| y_axis_min | |||
| Max | 1 | x_axis_max | Toute valeur numérique. Par défaut : "" (vide). |
| y_axis_max | |||
| Unités (type) | 0 | x_axis_units | 0 - (par défaut) Auto; 1 - Statique. |
| y_axis_units | |||
| Unités (valeur) | 1 | x_axis_static_units | Toute valeur de chaîne. Par défaut : "" (vide). |
| y_axis_static_units |
Légende
Les paramètres suivants sont pris en charge pour configurer la Légende.
| Paramètre | type | name | value |
|---|---|---|---|
| Afficher la légende | 0 | legend | 0 - Désactivé ; 1 - (par défaut) Activé. |
| Afficher la fonction d’agrégation | 0 | legend_aggregation | 0 - (par défaut) Désactivé ; 1 - Activé. Comportement du paramètre : - pris en charge si Afficher la légende est défini sur « Activé » |
| Lignes | 0 | legend_lines_mode | 0 - (par défaut) Fixe ; 1 - Variable. Comportement du paramètre : - pris en charge si Afficher la légende est défini sur « Activé » |
| Nombre de lignes/ Nombre maximal de lignes |
0 | legend_lines | Plage de valeurs possible : 1-10. Par défaut : 1. Comportement du paramètre : - pris en charge si Afficher la légende est défini sur « Activé » |
| Nombre de colonnes | 0 | legend_columns | Plage de valeurs possible : 1-4. Par défaut : 4. Comportement du paramètre : - pris en charge si Afficher la légende est défini sur « Activé » |
Seuils
Les paramètres suivants sont pris en charge pour configurer les seuils.
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 le frontend Zabbix
(par exemple, "thresholds.0.threshold":"5" → "thresholds.0.threshold":"1" ; "thresholds.1.threshold":"1" → "thresholds.1.threshold": "5").
| Paramètre | type | name | value |
|---|---|---|---|
| Interpolation des couleurs | 0 | interpolation | 0 - (par défaut) Désactivée ; 1 - Activée. |
| Couleur | 1 | thresholds.0.color | Code couleur hexadécimal (par exemple, FF0000). |
| Axe X | 1 | thresholds.0.x_axis_threshold | Toute valeur numérique. Les suffixes (par exemple, "1d", "2w", "4K", "8G") sont pris en charge. |
| Axe Y | 1 | thresholds.0.y_axis_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 de tableau de bord pour le widget Scatter plot.
Pour plus d’informations sur la configuration d’un tableau de bord, consultez dashboard.create.
Configuration d’un widget Nuage de points
Configurez un widget Nuage de points de la manière suivante :
- 5 ensembles de données de type « Item patterns », chacun avec l’agrégation par défaut (avg, 15m) et des marqueurs différents.
- La légende affiche les éléments configurés sur une seule ligne et en deux colonnes.
- Des seuils sont configurés pour colorer un marqueur en rouge lorsque sa valeur atteint 80 sur l’un des axes.
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "scatterplot",
"name": "Scatter plot",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 1,
"name": "ds.0.color",
"value": "0C5A87"
},
{
"type": 1,
"name": "ds.0.hosts.0",
"value": "de-frankfurt*"
},
{
"type": 1,
"name": "ds.0.x_axis_items.0",
"value": "Memory utilization"
},
{
"type": 1,
"name": "ds.0.y_axis_items.0",
"value": "CPU utilization"
},
{
"type": 0,
"name": "ds.0.marker",
"value": 0
},
{
"type": 0,
"name": "ds.0.marker_size",
"value": 1
},
{
"type": 1,
"name": "ds.1.color",
"value": "66B0D9"
},
{
"type": 1,
"name": "ds.1.hosts.0",
"value": "fr-paris*"
},
{
"type": 1,
"name": "ds.1.x_axis_items.0",
"value": "Memory utilization"
},
{
"type": 1,
"name": "ds.1.y_axis_items.0",
"value": "CPU utilization"
},
{
"type": 0,
"name": "ds.1.marker",
"value": 1
},
{
"type": 0,
"name": "ds.1.marker_size",
"value": 1
},
{
"type": 1,
"name": "ds.2.color",
"value": "0A466A"
},
{
"type": 1,
"name": "ds.2.hosts.0",
"value": "lv-riga*"
},
{
"type": 1,
"name": "ds.2.x_axis_items.0",
"value": "Memory utilization"
},
{
"type": 1,
"name": "ds.2.y_axis_items.0",
"value": "CPU utilization"
},
{
"type": 0,
"name": "ds.2.marker",
"value": 2
},
{
"type": 0,
"name": "ds.2.marker_size",
"value": 1
},
{
"type": 1,
"name": "ds.3.color",
"value": "3394C3"
},
{
"type": 1,
"name": "ds.3.hosts.0",
"value": "pl-warsaw*"
},
{
"type": 1,
"name": "ds.3.x_axis_items.0",
"value": "Memory utilization"
},
{
"type": 1,
"name": "ds.3.y_axis_items.0",
"value": "CPU utilization"
},
{
"type": 0,
"name": "ds.3.marker",
"value": 3
},
{
"type": 0,
"name": "ds.3.marker_size",
"value": 1
},
{
"type": 1,
"name": "ds.4.color",
"value": "1492C8"
},
{
"type": 1,
"name": "ds.4.hosts.0",
"value": "se-stockholm*"
},
{
"type": 1,
"name": "ds.4.x_axis_items.0",
"value": "Memory utilization"
},
{
"type": 1,
"name": "ds.4.y_axis_items.0",
"value": "CPU utilization"
},
{
"type": 0,
"name": "ds.4.marker",
"value": 4
},
{
"type": 0,
"name": "ds.4.marker_size",
"value": 1
},
{
"type": 0,
"name": "legend_columns",
"value": 2
},
{
"type": 0,
"name": "interpolation",
"value": 1
},
{
"type": 1,
"name": "thresholds.0.color",
"value": "D40000"
},
{
"type": 1,
"name": "thresholds.0.x_axis_threshold",
"value": "80"
},
{
"type": 1,
"name": "thresholds.0.y_axis_threshold",
"value": ""
},
{
"type": 1,
"name": "thresholds.1.color",
"value": "D40000"
},
{
"type": 1,
"name": "thresholds.1.x_axis_threshold",
"value": ""
},
{
"type": 1,
"name": "thresholds.1.y_axis_threshold",
"value": "80"
},
{
"type": 1,
"name": "reference",
"value": "JQISY"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Réponse :
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}