Présentation
Un widget météo permet d'afficher des informations clés sur un service en particulier ( hôte ou cluster ).
Un widget météo est composé de ces informations :
- le nom du service ;
- le statut et son contexte ( s'il en a ) ;
- la valeur du SLA ;
- la tendance actuelle du SLA ( ascendante ou descendante ) ;
Pour plus d'informations sur les widgets météo, référez-vous à la page Widget Météo - Détail - Météo |
Description
Pour un widget météo il faut configurer :
- sa position X, Y, largeur et hauteur;
- son service ( nom ou identifiant )
Configuration
...
"grid_elements": [
{
"position_x": 30,
"position_y": 3,
"width" : 15,
"height" : 3,
"content" : {
"type" : "weather_widget",
"item": {
"item_uuid" : "50589d91a4ff11e7b9eff8bc12640001",
"item_type" : "host",
"item_name" : "MVP_VMWARE_VCENTER_HEALTH_SUDOUEST"
}
}
}
]
... |
Positionnement et Dimensionnement
...
"grid_elements": [
{
"position_x": 30,
"position_y": 3,
"width" : 15,
"height" : 3,
...
}
]
... |
| Nom | Type | Défaut | Commentaire | |
|---|---|---|---|---|
| Numéro de cellule | --- | Abscisse du point "le plus en haut à gauche" d'un widget :
| |
| Numéro de cellule | --- | Ordonnée du point "le plus en haut à gauche" d'un widget :
| |
| Nombre de cellules | --- | Correspond à la largeur du widget :
Si le paramètre "width" n'est pas présent dans la configuration du widget, c'est comme s'il valait "default". | |
| Nombre de cellules | --- | Correspond à la hauteur du widget :
Si le paramètre "height" n'est pas présent dans la configuration du widget, c'est comme s'il valait "default". |
Contenu du widget météo
...
"grid_elements": [
{
...
"content" : {
"type" : "weather_widget",
"item": {
...
}
}
}
]
... |
| Nom | Type | Défaut | Valeur attendue | ||
|---|---|---|---|---|---|
| String | --- | Type du widget, dans le cas du widget météo ce paramètre doit être obligatoirement défini à la valeur : weather_widget. | ||
| Object | --- | Permet de définir quel élément va être affiché ( voir le chapitre Identification du service de la widget ). | ||
|
| ||||
|
| ||||
|
| ||||
|
|
Identification du service de la widget
...
"item": {
"item_uuid" : "50589d91a4ff11e7b9eff8bc12640001",
"item_type" : "host",
"item_name" : "MVP_VMWARE_VCENTER_HEALTH_SUDOUEST"
}
... |
| Nom | Type | Défaut | Valeur attendue | |
|---|---|---|---|---|
| String | --- | L'identifiant du service ( uuid ) si défini le contenu de "item_name" sera ignoré | |
| String | --- | Le type du service ( host ou cluster ); | |
| String | --- | Le nom de l'élément Shinken ( propriété host_name ). Si aucun identifiant "item_uuid" n'est défini, l'élément sera recherché par le nom de l'élément |
Exemple
...
"grid_elements": [
...
{
"position_x": 30,
"position_y": 3,
"width" : 15,
"height" : 3,
"content" : {
"type" : "weather_widget",
"item": {
"item_uuid" : "50589d91a4ff11e7b9eff8bc12640001",
"item_type" : "host",
"item_name" : "MVP_VMWARE_VCENTER_HEALTH_SUDOUEST"
}
}
},
...
]
... |
La configuration ci-dessus correspond à la configuration du widget météo encadré en bleu dans l'image ci-dessous.
Définir les valeurs par défaut du widget "météo" dans une météo
Dans chapitre "layouts" de la grille, il suffit de définir / compléter le chapitre "weather_widget_layout" :
- Il ne faut définir que les valeurs pour lesquels on souhaite mettre un paramètre par défaut;
- Certains paramètres ne peuvent pas avoir de valeur par défaut :
- position_x,
- position_y,
- type,
- item.
- Certains paramètres ne sont configurable que dans le layout ( pour des questions de cohérence d'affichage ) :
- property_used_as_name
- state_icon
- background
- display_sla
- Si vous utilisez la valeur "default" pour un paramètre qui l'accepte, la valeur sera alors celle présente dans le fichier de configuration du module "
webui-module-service-weather".- Vous trouverez la définition de ces paramètres de configuration dans la page Configuration de la disposition par défaut des widgets.
...
"layouts" : {
"weather_widget_layout" : {
"width" : 10,
"height" : 3,
"content" : {
"property_used_as_name" : "definition_name",
"state_icon" : "only_status",
"background" : "context_then_status",
"display_sla" : true
}
},
... |
| Nom | Type | Défaut | Commentaire | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Texte | definition_name | Définis quel sera le nom qui va être affiché dans le widget.
| |||||||||||||||||||||
| Texte | from_webui | Permet de configurer le type d'affichage des icônes du statut et du contexte.
| |||||||||||||||||||||
| Texte | from_webui | Permet de configurer la couleur de fond du widget par rapport au statut et au contexte.
| |||||||||||||||||||||
| Booléen | true | Permet d'activer ou désactiver l'affichage du taux SLA.
|