8 Graphique
Description
Ces paramètres et les valeurs de propriété possibles pour les objets de champ du widget de tableau de bord respectifs permettent de configurer le widget Graph 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 Graph, veuillez vous référer au comportement des paramètres décrit dans les tableaux ci-dessous.
Paramètres
Les paramètres suivants sont supportés pour le widget Graph
| Paramètre | type | nom | valeur |
|---|---|---|---|
| Interval de mise à jour | 0 | rf_rate | 0 - Pas de mise à jour; 10 - 10 secondes; 30 - 30 secondes; 60 - (defaul) 1 minute; 120 - 2 minutes; 600 - 10 minutes; 900 - 15 minutes. |
| Réference | 1 | reference | Toute valeur de chaîne composée de 5 caractères (exemple : ABCDE ou JBPNL). Cette valeur doit être unique au sein du tableau de bord auquel appartient le widget.Comportement des paramètres: - requis |
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 ex. ds.0.hosts.0, ds.0.items.0) représente le jeu de données concerné, 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. |
|
| Éléments | 4 | ds.0.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 Éléments (widget) n'est pas défini |
|
| Éléments (widget) | 1 | ds.0.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 Éléments n'est pas défini |
|
| Couleur | 1 | ds.0.color.0 | Code couleur hexadécimal (par ex. FF0000).Comportement du paramètre : - obligatoire si Type de jeu de données est défini sur "Liste d'éléments" |
|
| Modèles d'hôte | 1 | ds.0.hosts.0 | Nom ou modèle d'hôte (par ex. "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 | 1 | ds.0.items.0 | Nom ou modèle d'élément (par ex. "*: 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" |
|
| Couleur | 1 | ds.0.color | Code couleur hexadécimal (par ex. 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. Les valeurs possibles vont de 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 |
|
| Tracer | 0 | ds.0.type | 0 - (par défaut) Ligne ; 1 - Points ; 2 - Escalier ; 3 - Barre. |
|
| Empilé | 0 | ds.0.stacked | 0 - (par défaut) Désactivé ; 1 - Activé. Comportement du paramètre : - pris en charge si Tracer est défini sur "Ligne", "Escalier" ou "Barre" |
|
| Largeur | 0 | ds.0.width | Les valeurs possibles vont de 1 à 10. Par défaut : 1. Comportement du paramètre : - pris en charge si Tracer est défini sur "Ligne" ou "Escalier" |
|
| Taille des points | 0 | ds.0.pointsize | Les valeurs possibles vont de 1 à 10. Par défaut : 3. Comportement du paramètre : - pris en charge si Tracer est défini sur "Points" |
|
| Transparence | 0 | ds.0.transparency | Les valeurs possibles vont de 1 à 10. Par défaut : 5. |
|
| Remplissage | 0 | ds.0.fill | Les valeurs possibles vont de 1 à 10. Par défaut : 3. Comportement du paramètre : - pris en charge si Tracer est défini sur "Ligne" ou "Escalier" |
|
| Données manquantes | 0 | ds.0.missingdatafunc | 0 - (par défaut) Aucune ; 1 - Connectées ; 2 - Traiter comme 0 ; 3 - Dernière valeur connue. Comportement du paramètre : - pris en charge si Tracer est défini sur "Ligne" ou "Escalier" |
|
| 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. |
|
| Axe Y | 0 | ds.0.axisy | 0 - (par défaut) Gauche ; 1 - Droite. |
|
| Décalage temporel | 1 | ds.0.timeshift | Chaîne temporelle valide (par ex. 3600, 1h, etc.).Vous pouvez utiliser des suffixes temporels. Les valeurs négatives sont également autorisées. Par défaut : "" (vide). |
|
| Fonction d'agrégation | 0 | ds.0.aggregate_function | 0 - (par défaut) non utilisée ; 1 - min ; 2 - max ; 3 - avg ; 4 - count ; 5 - sum ; 6 - first ; 7 - last. |
|
| Intervalle d'agrégation | 1 | ds.0.aggregate_interval | Chaîne temporelle valide (par ex. 3600, 1h, etc.).Vous pouvez utiliser des suffixes temporels. Par défaut : 1h. |
|
| Agréger | 0 | ds.0.aggregate_grouping | 0 - (par défaut) Chaque élément ; 1 - Jeu de données. Comportement du paramètre : - pris en charge si Fonction d'agrégation est définie sur "min", "max", "avg", "count", "sum", "first" ou "last" |
|
| Approximation | 0 | ds.0.approximation | 1 - min ; 2 - (par défaut) avg ; 4 - max ; 7 - all. |
|
| Libellé du jeu de données | 1 | ds.0.data_set_label | N'importe quelle valeur de chaîne. Par défaut : "" (vide). |
|
| Tags d'élément | ||||
| Type d'évaluation | 0 | ds.0.item_tags_evaltype | 0 - (par défaut) Et/Ou ; 2 - Ou. |
|
| Nom du tag | 1 | ds.0.item_tags.0.tag | N'importe quelle valeur de chaîne. Remarque : le nombre dans le nom de 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 | ds.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 nombre dans le nom de 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 | ds.0.item_tags.0.value | N'importe quelle valeur de chaîne. Remarque : le nombre dans le nom de 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 |
|
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. |
|
| Déclencheurs simples | 0 | simple_triggers | 0 - (par défaut) Désactivé ; 1 - Activé. |
|
| Temps de travail | 0 | working_time | 0 - (par défaut) Désactivé ; 1 - Activé. |
|
| 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. |
|
| Ligne de percentile (gauche) | ||||
| Statut | 0 | percentile_left | 0 - (par défaut) Désactivé ; 1 - Activé. Comportement du paramètre : - pris en charge si Axe Y (dans la configuration de Jeu de données) est défini sur "Gauche" |
|
| Valeur | 0 | percentile_left_value | Les valeurs possibles vont de 1 à 100. Comportement du paramètre : - pris en charge si Axe Y (dans la configuration de Jeu de données) est défini sur "Gauche" |
|
| Ligne de percentile (droite) | ||||
| Statut | 0 | percentile_right | 0 - (par défaut) Désactivé ; 1 - Activé. Comportement du paramètre : - pris en charge si Axe Y (dans la configuration de Jeu de données) est défini sur "Droite" |
|
| Valeur | 0 | percentile_right_value | Les valeurs possibles vont de 1 à 100. Comportement du paramètre : - pris en charge si Axe Y (dans la configuration de Jeu de données) est défini sur "Droite" |
|
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 |
|---|---|---|---|
| Y gauche | 0 | lefty | 0 - Désactivé; 1 - (par défaut) Activé. Comportement du paramètre : - pris en charge si Axe Y (dans la configuration de Jeu de données) est défini sur « Gauche » |
| Y droite | 0 | righty | 0 - (par défaut) Désactivé; 1 - Activé. Comportement du paramètre : - pris en charge si Axe Y (dans la configuration de Jeu de données) est défini sur « Droite » |
| Échelle | 0 | lefty_scale | 0 - (par défaut) Linéaire; 1 - Logarithmique. |
| righty_scale | |||
| Min | 1 | lefty_min | Toute valeur numérique. Par défaut : "" (vide). |
| righty_min | |||
| Max | 1 | lefty_max | Toute valeur numérique. Par défaut : "" (vide). |
| righty_max | |||
| Unités (type) | 0 | lefty_units | 0 - (par défaut) Auto; 1 - Statique. |
| righty_units | |||
| Unités (valeur) | 1 | lefty_static_units | Toute valeur de chaîne. Par défaut : "" (vide). |
| righty_static_units | |||
| Axe X | 0 | xaxis | 0 - Désactivé; 1 - (par défaut) Activé. |
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 min/moy/max | 0 | legend_statistic | 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é" |
| 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 | Les valeurs possibles vont de 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 | Les valeurs possibles vont de 1 à 4. Par défaut : 4. Comportement du paramètre: - pris en charge si Afficher la légende est défini sur "Activé", et Afficher min/moy/max est défini sur "Désactivé" |
Problèmes
Les paramètres suivants sont pris en charge pour configurer les Problèmes.
| Paramètre | type | name | value | |
|---|---|---|---|---|
| Afficher les problèmes | 0 | show_problems | 0 - (par défaut) Désactivé ; 1 - Activé. |
|
| Éléments sélectionnés uniquement | 0 | graph_item_problems | 0 - Désactivé ; 1 - (par défaut) Activé. |
|
| Hôtes des problèmes | 1 | problemhosts.0 | Nom de l’hôte. Remarque : Le nombre dans le nom de propriété fait référence à l’hôte configuré. Pour configurer plusieurs hôtes, créez un objet de champ de widget de tableau de bord pour chaque hôte avec un nombre 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. |
|
| Sévérité | 0 | severities.0 | 0 - Non classé ; 1 - Information ; 2 - Avertissement ; 3 - Moyen ; 4 - Élevé ; 5 - Désastre. Par défaut : vide (tous activés). Remarque : Pour configurer plusieurs valeurs, créez un objet de champ de widget de tableau de bord pour chaque valeur avec un nombre incrémenté dans le nom de propriété. |
|
| Problème | 1 | problem_name | Nom d’événement du problème (insensible à la casse, nom complet ou partie de celui-ci). | |
| Balises de problème | ||||
| Type d’évaluation | 0 | evaltype | 0 - (par défaut) Et/Ou ; 2 - Ou. |
|
| Nom de balise | 1 | 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 de problème |
|
| Opérateur | 0 | tags.0.operator | 0 - Contient ; 1 - Égal à ; 2 - Ne contient pas ; 3 - N’est pas égal à ; 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 de problème |
|
| Valeur de balise | 1 | 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 de problème |
|
Remplacements
Les paramètres suivants sont pris en charge pour configurer les Remplacements.
Le premier nombre dans le nom de propriété (par ex. or.0.hosts.0, or.0.items.0) représente l’ensemble 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 |
|---|---|---|---|
| Modèles d’hôte | 1 | or.0.hosts.0 | Nom ou modèle d’hôte (par ex. Zabbix*).Ce paramètre n’est pas pris en charge lors de la configuration du widget sur un tableau de bord de modèle. Comportement du paramètre : - obligatoire lors de la configuration des Remplacements |
| Modèles d’élément | 1 | or.0.items.0 | Nom ou modèle d’élément (par ex. *: 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 lors de la configuration des Remplacements |
| Couleur de base | 1 | or.0.color | Code couleur hexadécimal (par ex. FF0000). |
| Largeur | 0 | or.0.width | Les valeurs possibles vont de 1 à 10. |
| Tracer | 0 | or.0.type | 0 - Ligne ; 1 - Points ; 2 - Escalier ; 3 - Barre. |
| Transparence | 0 | or.0.transparency | Les valeurs possibles vont de 1 à 10. |
| Remplissage | 0 | or.0.fill | Les valeurs possibles vont de 1 à 10. |
| Taille des points | 0 | or.0.pointsize | Les valeurs possibles vont de 1 à 10. |
| Données manquantes | 0 | or.0.missingdatafunc | 0 - Aucune ; 1 - Connectées ; 2 - Traiter comme 0 ; 3 - Dernière valeur connue. |
| Axe Y | 0 | or.0.axisy | 0 - Gauche ; 1 - Droite. |
| Décalage temporel | 1 | or.0.timeshift | Chaîne de temps valide (par ex. 3600, 1h, etc.).Vous pouvez utiliser les suffixes de temps. Les valeurs négatives sont autorisées. |
Exemples
Les exemples suivants visent à décrire uniquement la configuration des objets de champ du widget de tableau de bord pour le widget Graphique.
Pour plus d'informations sur la configuration d'un tableau de bord, consultez dashboard.create.
Configuration d’un widget Graph
Configurez un widget Graph de la manière suivante :
- 2 ensembles de données pour un total de 9 éléments sur 1 hôte.
- Le premier ensemble de données est de type « Item list » et se compose de 3 éléments représentés par des lignes de couleur différente, mais avec la même largeur, la même transparence et le même remplissage.
- Le deuxième ensemble de données est de type « Item patterns », se compose de 6 éléments, possède une agrégation configurée et est représenté par une ligne avec une couleur, une largeur, une transparence et un remplissage personnalisés.
- Le deuxième ensemble de données possède également un libellé personnalisé.
- Les données du graphique sont affichées pour une période correspondant aux 3 dernières heures.
- Les problèmes dans le graphique sont affichés uniquement pour les éléments configurés.
- Le graphique possède deux axes Y, dont l’axe Y droit affiche des valeurs uniquement pour le deuxième ensemble de données.
- La légende du graphique affiche les éléments configurés sur 4 lignes, ainsi que les valeurs minimale, maximale et moyenne des ensembles de données.
Requête :
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "svggraph",
"name": "Graph",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 0,
"name": "ds.0.dataset_type",
"value": 0
},
{
"type": 4,
"name": "ds.0.itemids.0",
"value": 23264
},
{
"type": 1,
"name": "ds.0.color.0",
"value": "FF0000"
},
{
"type": 4,
"name": "ds.0.itemids.1",
"value": 23269
},
{
"type": 1,
"name": "ds.0.color.1",
"value": "BF00FF"
},
{
"type": 4,
"name": "ds.0.itemids.2",
"value": 23257
},
{
"type": 1,
"name": "ds.0.color.2",
"value": "0040FF"
},
{
"type": 0,
"name": "ds.0.width",
"value": 3
},
{
"type": 0,
"name": "ds.0.transparency",
"value": 3
},
{
"type": 0,
"name": "ds.0.fill",
"value": 1
},
{
"type": 1,
"name": "ds.1.hosts.0",
"value": "Zabbix server"
},
{
"type": 1,
"name": "ds.1.items.0",
"value": "*: Number of processed *values per second"
},
{
"type": 1,
"name": "ds.1.color",
"value": "000000"
},
{
"type": 0,
"name": "ds.1.transparency",
"value": 0
},
{
"type": 0,
"name": "ds.1.fill",
"value": 0
},
{
"type": 0,
"name": "ds.1.axisy",
"value": 1
},
{
"type": 0,
"name": "ds.1.aggregate_function",
"value": 3
},
{
"type": 1,
"name": "ds.1.aggregate_interval",
"value": "1m"
},
{
"type": 0,
"name": "ds.1.aggregate_grouping",
"value": 1
},
{
"type": 1,
"name": "ds.1.data_set_label",
"value": "Number of processed values per second"
},
{
"type": 0,
"name": "graph_time",
"value": 1
},
{
"type": 1,
"name": "time_period.from",
"value": "now-3h"
},
{
"type": 1,
"name": "time_period.to",
"value": "now"
},
{
"type": 0,
"name": "legend_statistic",
"value": 1
},
{
"type": 0,
"name": "legend_lines",
"value": 4
},
{
"type": 0,
"name": "show_problems",
"value": 1
},
{
"type": 1,
"name": "reference",
"value": "YZABC"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}
Réponse :
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}