28 Meilleurs é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 Top items 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 des 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 création ou la mise à jour réussie du widget Top items, 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 Top items.

Parameter type name value
Refresh interval 0 rf_rate 0 - Aucun rafraîchissement;
10 - 10 secondes;
30 - 30 secondes;
60 - (par défaut) 1 minute;
120 - 2 minutes;
600 - 10 minutes;
900 - 15 minutes.
Host groups 2 groupids.0 ID du groupe d'hôtes.

Note: 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.
Host groups (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.
Hosts 3 hostids.0 ID de l'hôte.

Note: 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 Host groups doit soit ne 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.
Hosts (Widget/Dashboard) 1 hostids._reference Au lieu de l'ID de l'hôte:
DASHBOARD.hostids - définissez le sélecteur Host 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.
Host tags
Evaluation type 0 host_tags_evaltype 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.
Tag name 1 host_tags.0.tag Toute valeur de chaîne.

Note: Le numéro dans le nom de la propriété fait référence à l'ordre des tags dans la liste d'évaluation des tags.

Comportement du paramètre:
- obligatoire lors de la configuration de Host tags

Ce paramètre n'est pas pris en charge lors de la configuration du widget sur un tableau de bord de modèle.
Operator 0 host_tags.0.operator 0 - Contient;
1 - Égal à;
2 - Ne contient pas;
3 - N'est pas égal à;
4 - Existe;
5 - N'existe pas.

Note: Le numéro dans le nom de la propriété fait référence à l'ordre des tags dans la liste d'évaluation des tags.

Comportement du paramètre:
- obligatoire lors de la configuration de Host tags

Ce paramètre n'est pas pris en charge lors de la configuration du widget sur un tableau de bord de modèle.
Tag value 1 host_tags.0.value Toute valeur de chaîne.

Note: Le numéro dans le nom de la propriété fait référence à l'ordre des tags dans la liste d'évaluation des tags.

Comportement du paramètre:
- obligatoire lors de la configuration de Host tags

Ce paramètre n'est pas pris en charge lors de la configuration du widget sur un tableau de bord de modèle.
Layout 0 layout 0 - (par défaut) Horizontal;
1 - Vertical.
Show problems 0 show_problems 0 - Tous;
1 - (par défaut) Non supprimés;
2 - Aucun.
Items (see below)

Configuration avancée

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

Paramètre type name value
Ordre des hôtes
Trier par 0 host_ordering_order_by 0 - (par défaut) Nom de l'hôte ;
3 - Valeur de l'élément.
Modèles d'élément 1 host_ordering_item.0 Nom ou modèle de l'élément (par ex. "*: Number of processed *values per second").

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é.

Lors de la configuration du widget sur un tableau de bord de modèle, seuls les modèles des éléments configurés sur le modèle doivent être définis.

Comportement du paramètre :
- obligatoire si Trier par est défini sur « Valeur de l'élément »
Ordre 0 host_ordering_order 2 - (par défaut) Top N ;
3 - Bottom N.
Limite 0 host_ordering_limit Les valeurs possibles vont de 1 à 100.

Par défaut : 10.
Ordre des éléments
Trier par 0 item_ordering_order_by 1 - Hôte ;
2 - Nom de l'élément ;
3 - (par défaut) Valeur de l'élément.
Modèles d'hôte 1 item_ordering_host.0 Nom ou modèle de l'hôte.

Remarque : pour configurer plusieurs modèles d'hôte, créez un objet de champ de widget de tableau de bord pour chaque modèle d'hôte avec un numéro incrémenté dans le nom de la propriété.

Comportement du paramètre :
- obligatoire si Trier par est défini sur « Hôte »
Ordre 0 item_ordering_order 2 - (par défaut) Top N ;
3 - Bottom N.
Limite 0 item_ordering_limit Les valeurs possibles vont de 1 à 100.

Par défaut : 10.

Colonnes

Le premier nombre dans le nom de la propriété (par exemple, columns.0.items.0, columns.0.item_tags_evaltype) représente la colonne concernée, tandis que le deuxième nombre, s'il est présent, représente l'entité configurée (par exemple, modèle d'élément, tag).

Parameter type name value
Item patterns 1 columns.0.items.0 Nom ou modèle d'élément (par exemple, "*: Number of processed *values per second").

Note: 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 deuxième nombre incrémenté dans le nom de la propriété.

Lors de la configuration du widget sur un tableau de bord de modèle, seuls les modèles correspondant aux éléments configurés sur le modèle doivent être définis.

Comportement du paramètre:
- required
Item tags
Evaluation type 0 columns.0.item_tags_evaltype 0 - (default) Et/ou;
2 - Ou.
Tag name 1 columns.0.item_tags.0.tag Toute valeur de chaîne.

Note: le deuxième nombre dans le nom de la propriété fait référence à l'ordre des tags dans la liste d'évaluation des tags.

Comportement du paramètre:
- required si vous configurez Item tags
Operator 0 columns.0.item_tags.0.operator 0 - Contient;
1 - Égal à;
2 - Ne contient pas;
3 - N'est pas égal à;
4 - Existe;
5 - N'existe pas.

Note: le deuxième nombre dans le nom de la propriété fait référence à l'ordre des tags dans la liste d'évaluation des tags.

Comportement du paramètre:
- required si vous configurez Item tags
Tag value 1 columns.0.item_tags.0.value Toute valeur de chaîne.

Note: le deuxième nombre dans le nom de la propriété fait référence à l'ordre des tags dans la liste d'évaluation des tags.

Comportement du paramètre:
- required si vous configurez Item tags
Base color 1 columns.0.base_color Code couleur hexadécimal (par exemple, FF0000).
Display value as 0 columns.0.display_value_as 1 - (default) Numérique;
2 - Texte.
Display 0 columns.0.display 1 - (default) Tel quel;
2 - Barre;
3 - Indicateurs;
6 - Sparkline.
Min 1 columns.0.min Toute valeur numérique. Les suffixes (par exemple, "1d", "2w", "4K", "8G") sont pris en charge.

Comportement du paramètre:
- supported si Display value as est défini sur "Numeric" et Display est défini sur "Bar" ou "Indicators"
Max 1 columns.0.max Toute valeur numérique. Les suffixes (par exemple, "1d", "2w", "4K", "8G") sont pris en charge.

Comportement du paramètre:
- supported si Display value as est défini sur "Numeric" et Display est défini sur "Bar" ou "Indicators"
Sparkline
Width 0 columns.0.sparkline.width Valeurs possibles de 0 à 10.

Valeur par défaut: 1.

Comportement du paramètre:
- supported si Display est défini sur "Sparkline"
Fill 0 columns.0.sparkline.fill Valeurs possibles de 0 à 10.

Valeur par défaut: 3.

Comportement du paramètre:
- supported si Display est défini sur "Sparkline"
Color 1 columns.0.sparkline.color Code couleur hexadécimal (par exemple, FF0000).

Valeur par défaut: 42A5F5.

Comportement du paramètre:
- supported si Display est défini sur "Sparkline"
Time period 1 columns.0.sparkline.time_period._reference DASHBOARD._timeperiod - définit le sélecteur de période comme source de données;
ABCDE._timeperiod - définit un widget compatible (avec son paramètre reference égal à ABCDE) comme source de données.

Valeur par défaut: DASHBOARD._timeperiod

Sinon, vous pouvez définir la période uniquement dans les paramètres From et To.

Comportement du paramètre:
- supported si Display est défini sur "Sparkline"
From 1 columns.0.sparkline.time_period.from Chaîne de temps valide au format absolu (YYYY-MM-DD hh:mm:ss) ou au format temporel relatif (now, now/d, now/w-1w, etc.).

Comportement du paramètre:
- supported si Display est défini sur "Sparkline"
- required si columns.0.sparkline.time_period.to est défini
To 1 columns.0.sparkline.time_period.to Chaîne de temps valide au format absolu (YYYY-MM-DD hh:mm:ss) ou au format temporel relatif (now, now/d, now/w-1w, etc.).

Comportement du paramètre:
- supported si Display est défini sur "Sparkline"
- required si columns.0.sparkline.time_period.from est défini
History data 0 columns.0.sparkline.history 0 - (default) Auto;
1 - Historique;
2 - Tendances.

Comportement du paramètre:
- supported si Display est défini sur "Sparkline"
Thresholds
Color 1 columns.0.thresholds.0.color Code couleur hexadécimal (par exemple, FF0000).

Comportement du paramètre:
- supported si Display value as est défini sur "Numeric"
Threshold 1 columns.0.thresholds.0.threshold Toute valeur numérique. Les suffixes (par exemple, "1d", "2w", "4K", "8G") sont pris en charge.

Comportement du paramètre:
- supported si Display value as est défini sur "Numeric"
Highlights
Highlight 1 columns.0.highlights.0.color Code couleur hexadécimal (par exemple, FF0000).

Comportement du paramètre:
- supported si Display value as est défini sur "Text"
Threshold 1 columns.0.highlights.0.pattern Toute expression régulière.

Comportement du paramètre:
- supported si Display value as est défini sur "Text"
Decimal places 0 columns.0.decimal_places Valeurs possibles de 0 à 10.

Valeur par défaut: 2.
Advanced configuration
Aggregation function 0 columns.0.aggregate_function Si Display value as est défini sur "Numeric":
0 - (default) non utilisé;
1 - min;
2 - max;
3 - avg;
4 - count;
5 - sum;
6 - first;
7 - last.

Si Display value as est défini sur "Text":
0 - (default) non utilisé;
4 - count;
6 - first;
7 - last.
Time period 1 columns.0.time_period._reference DASHBOARD._timeperiod - définit le sélecteur de période comme source de données;
ABCDE._timeperiod - définit un widget compatible (avec son paramètre reference égal à ABCDE) comme source de données.

Valeur par défaut: DASHBOARD._timeperiod

Sinon, vous pouvez définir la période uniquement dans les paramètres From et To.

Comportement du paramètre:
- supported si Aggregation function est définie sur "min", "max", "avg", "count", "sum", "first", "last"
From 1 columns.0.time_period.from Chaîne de temps valide au format absolu (YYYY-MM-DD hh:mm:ss) ou au format temporel relatif (now, now/d, now/w-1w, etc.).

Comportement du paramètre:
- supported si Time period n'est pas défini et Aggregation function est définie sur "min", "max", "avg", "count", "sum", "first", "last"
- required si columns.0.time_period.to est défini
To 1 columns.0.time_period.to Chaîne de temps valide au format absolu (YYYY-MM-DD hh:mm:ss) ou au format temporel relatif (now, now/d, now/w-1w, etc.).

Comportement du paramètre:
- supported si Time period n'est pas défini et Aggregation function est définie sur "min", "max", "avg", "count", "sum", "first", "last"
- required si columns.0.time_period.from est défini
History data 0 columns.0.history 0 - (default) Auto;
1 - Historique;
2 - Tendances.

Comportement du paramètre:
- supported si Display value as est défini sur "Numeric"

Exemples

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

Configuration d’un widget Top items

Configurez un widget Top items qui affiche les données de l’hôte « 10084 » et uniquement pour les éléments dont le tag nommé « component » contient la valeur « cpu ». De plus, affichez les données avec les hôtes placés en haut et utilisez une jauge colorée pour la représentation des cellules.

Requête :

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "topitems",
                        "name": "Top items",
                        "x": 0,
                        "y": 0,
                        "width": 36,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 3,
                                "name": "hostids.0",
                                "value": 10084
                            },
                            {
                                "type": 1,
                                "name": "columns.0.items.0",
                                "value": "*"
                            },
                            {
                                "type": 1,
                                "name": "columns.0.item_tags.0.tag",
                                "value": "component"
                            },
                            {
                                "type": 0,
                                "name": "columns.0.item_tags.0.operator",
                                "value": 0
                            },
                            {
                                "type": 1,
                                "name": "columns.0.item_tags.0.value",
                                "value": "cpu"
                            },
                            {
                                "type": 0,
                                "name": "columns.0.display",
                                "value": 2
                            },
                            {
                                "type": 0,
                                "name": "layout",
                                "value": 1
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

Réponse :

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

Voir aussi