16 Historique des éléments
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 Historique des éléments 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 Historique des éléments, 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 Historique des éléments.
| Paramètre | type | name | value |
|---|---|---|---|
| Intervalle d’actualisation | 0 | rf_rate | 0 - Pas d’actualisation ; 10 - 10 secondes ; 30 - 30 secondes ; 60 - (par défaut) 1 minute ; 120 - 2 minutes ; 600 - 10 minutes ; 900 - 15 minutes. |
| Disposition | 0 | layout | 0 - (par défaut) Horizontale ; 1 - Verticale. |
| Colonnes (voir ci-dessous) | |||
| Afficher les lignes | 0 | show_lines | Les valeurs possibles vont de 1 à 100. Par défaut : 25. |
| 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 (voir ci-dessous) | |||
| 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 |
Colonnes
Les colonnes ont des paramètres communs et des paramètres supplémentaires selon la configuration du paramètre Élément.
Pour tous les paramètres liés aux colonnes, le numéro dans le nom de la propriété (par ex. columns.0.name) fait référence à une colonne pour laquelle le paramètre est configuré.
Les paramètres suivants sont pris en charge pour toutes les colonnes.
| Parameter | type | name | value |
|---|---|---|---|
| Nom | 1 | columns.0.name | Toute valeur de chaîne. Comportement du paramètre: - obligatoire |
| Élément | 4 | columns.0.itemid | ID de l’é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. Comportement du paramètre: - obligatoire |
| Couleur de base | 1 | columns.0.base_color | Code couleur hexadécimal (par ex. FF0000).Par défaut : "" (vide). |
Les paramètres de colonne suivants sont pris en charge si l’élément configuré est un élément de type numérique.
| Paramètre | type | name | value | |
|---|---|---|---|---|
| Affichage | 0 | columns.0.display | 1 - (par défaut) Tel quel ; 2 - Barre ; 3 - Indicateurs. |
|
| Min | 1 | columns.0.min | Toute valeur numérique. Comportement du paramètre : - pris en charge si Affichage est défini sur « Barre » ou « Indicateurs » |
|
| Max | 1 | columns.0.max | Toute valeur numérique. Comportement du paramètre : - pris en charge si Affichage est défini sur « Barre » ou « Indicateurs » |
|
| Seuils | ||||
| Couleur | 1 | columns.0.thresholds.0.color | Code couleur hexadécimal (par ex. FF0000). |
|
| Seuil | 1 | columns.0.thresholds.0.threshold | Toute valeur numérique. Les suffixes (par ex. « 1d », « 2w », « 4K », « 8G ») sont pris en charge. | |
| Données d’historique | 0 | columns.0.history | 0 - (par défaut) Auto ; 1 - Historique ; 2 - Tendances. |
|
Les paramètres de colonne suivants sont pris en charge si l’élément configuré est de type caractère, texte ou journal.
| Paramètre | type | name | value | |
|---|---|---|---|---|
| Mises en évidence | ||||
| Mise en évidence | 1 | columns.0.highlights.0.color | Code couleur hexadécimal (par ex. FF0000). |
|
| Seuil | 1 | columns.0.highlights.0.pattern | Toute expression régulière. | |
| Affichage | 0 | columns.0.display | 1 - (par défaut) Tel quel ; 4 - HTML ; 5 - Ligne unique. |
|
| Ligne unique | 0 | columns.0.max_length | Les valeurs possibles vont de 1 à 500. Par défaut : 100. Comportement du paramètre : - pris en charge si Affichage est défini sur « Ligne unique » |
|
| Utiliser une police à chasse fixe | 0 | columns.0.monospace_font | 0 - (par défaut) Utiliser la police par défaut ; 1 - Utiliser une police à chasse fixe. |
|
| Afficher l’heure locale | 0 | columns.0.local_time | 0 - (par défaut) Afficher l’horodatage ; 1 - Afficher l’heure locale. Comportement du paramètre : - pris en charge si l’élément est défini sur un élément de type journal et que Afficher l’horodatage est défini sur « Activé » |
|
Les paramètres de colonne suivants sont pris en charge si l’élément configuré est un élément de type binaire.
| Paramètre | type | name | value |
|---|---|---|---|
| Afficher la miniature | 1 | columns.0.show_thumbnail | 0 - (par défaut) Désactivé; 1 - Activé. |
Configuration avancée
Les paramètres de configuration avancée suivants sont pris en charge pour le widget Historique des éléments.
| Paramètre | type | name | value | |
|---|---|---|---|---|
| Nouvelles valeurs | 0 | sortorder | 0 - (par défaut) En haut ; 1 - En bas. |
|
| Afficher l’horodatage | 0 | show_timestamp | 0 - (par défaut) Désactivé ; 1 - Activé. |
|
| Afficher l’en-tête de colonne | 0 | show_column_header | 0 - Désactivé ; 1 - Horizontal ; 2 - (par défaut) Vertical. |
|
| Période | 1 | time_period._reference | DASHBOARD._timeperiod - définir le sélecteur de période du tableau de bord comme source de données ;ABCDE._timeperiod - définir 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 uniquement dans les paramètres From et To. |
|
| De | 1 | time_period.from | Chaîne temporelle valide en syntaxe 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 n’est pas défini - obligatoire si time_period.to est défini |
|
| À | 1 | time_period.to | Chaîne temporelle valide en syntaxe 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 n’est pas défini - obligatoire si time_period.from est défini |
|
Exemples
Les exemples suivants visent uniquement à décrire la configuration des objets de champ du widget de tableau de bord pour le widget Historique des éléments.
Pour plus d’informations sur la configuration d’un tableau de bord, consultez dashboard.create.
Configuration d’un widget Historique des éléments
Configurez un widget Historique des éléments qui affiche les dernières données de deux éléments numériques « 42269 » et « 42270 ». En outre, configurez les colonnes des éléments pour qu’elles soient affichées verticalement, avec les noms de colonnes affichés horizontalement ; limitez l’affichage à 15 lignes de données et incluez une colonne d’horodatage distincte.
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "itemhistory",
"name": "Item history",
"x": "0",
"y": "0",
"width": "18",
"height": "6",
"view_mode": "0",
"fields": [
{
"type": "0",
"name": "layout",
"value": "1"
},
{
"type": "1",
"name": "columns.0.name",
"value": "CPU utilization"
},
{
"type": "4",
"name": "columns.0.itemid",
"value": "42269"
},
{
"type": "1",
"name": "columns.1.name",
"value": "Memory utilization"
},
{
"type": "4",
"name": "columns.1.itemid",
"value": "42270"
},
{
"type": "0",
"name": "show_lines",
"value": "15"
},
{
"type": "0",
"name": "show_timestamp",
"value": "1"
},
{
"type": "0",
"name": "show_column_header",
"value": "1"
},
{
"type": "1",
"name": "reference",
"value": "KIVKD"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Réponse :
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}