Versions Compared

Old Version 2

changes.mady.by.user Soubrié Grégoire

Saved on

compared with

New Version 3

changes.mady.by.user clément Roussy

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction

La fonctionnalité de duplication des Checks par donnée de l'Hôte (ou "duplicate foreach") permet de pouvoir dupliquer trés très simplement des checks sur un même hôte grâce à une donnée dédiée à cet effet.

  • En effet, si un hôte héberge plusieurs services de même type (par exemple, plusieurs bases de données) il peut être intéressant de dupliquer autant de fois l'ensemble des checks de monitoring qu'il y a de base de donnéedonnées.
  • Un template donné modèle de donnée ne s'applique qu'à un hôte dans son ensemble et ne peut pas y être dupliqué. Pour pouvoir dupliquer les checks d'un hôte, il faut utiliser des checks ayant la propriété "Duplicate for each" (Dupliqué pour chaque valeur de la Donnée de l'hôte).
  • Nous verrons dans ce chapitre la façon dont ils seront dupliqués sur cet hôte, et notamment comment obtenir des données spécifiques à chaque copie, qui seront récupérées dans cette Variable (propriété) de Duplicate for each ou via les arguments par défaut.

Fonctionnement

Les checks


Pour qu'un check soit dupliqué, il doit remplir plusieurs conditions. Prenons le cas d'une commande qui prend deux arguments tel que le check_dummy.


Panel
titleCommande d'exemple "cmd-dummy"


Voici comment le check ou check template sera défini :

  • ( 1 ) Obligatoire - Le nom du check doit contenir $KEY$.
    Cette Variable sera remplacée par les différentes valeurs de la donnée de Duplicate for each de l'hôte, de manière à ne pas générer de collision de nom.

  • ( 2 ) Optionnel - Le champ "Args" permet de passer des arguments séparés entre ! 
    Attention, particularité, pour des arguments lors d'un Duplicate for each, les Variables sont $VALUEn$, "n" allant de 1 à 16.

  • ( 3 ) Obligatoire - Le champ "Duplicate for each key name" doit renseigner le nom de la donnée qui sera définie dans l'hôte. C'est la donnée qui servira à dupliquer le check.

  • ( 4 ) Optionnel - Le champ "Duplicate for each default arguments" permet de spécifier les valeurs par défaut pour les Variables $VALUEn$. 

    Exemple de syntaxe (si la syntaxe n'est pas respectée, un message d'erreur s'affichera) :

    Code Block
    themeMidnight
    $(ma_valeur_par_défaut_1)$$(ma_valeur_par_défaut_2)$



Le check peut donc utiliser, dans sa configuration, $KEY$, et $VALUE1$ jusqu'à $VALUE16$.

Ces Variables seront remplacées de façon spécifique à chaque copie.

Plus d'information sur les Variables ici avec le cas spécifique du "Duplicate for each". 



Panel


Cas d'erreur

Anchor
Cas d'erreur donnée
Cas d'erreur donnée


Le champ "Duplicate for each key name" renseignée dans le paragraphe précédent (3) ne doit pas contenir le nom d'une donnée chiffrée.

Ces noms de données sont définies via la commande shinken-protected-fields-data-manage.

Si ce champ contient un des noms précédemment définie, un avertissement apparaîtra indiquant que les checks ne seront pas générés.


Panel

screenshot-4.png


L'hôte


Pour que l'hôte duplique ses checks, il faut renseigner la valeur de la donnée "Duplicate for each". Ce champ est obligatoire, en cas d'oubli la donnée apparaît en erreur et aucun check n'est généré.


Panel


Un hôte ayant des checks à dupliquer qui lui sont directement attachés ou provenant de modèles hérités, doit dois obligatoirement fournir des valeurs dans sa donnée de Duplicate for eachFor Each.

Lors de l'édition, chaque clé peut être spécifiée avec ses valeurs sur une ligne séparée.


Panel


Lorsque plusieurs checks utilisent la même donnée Duplicate For Each ( ex: BROKER_LIST dans le screen ci-dessous ), celle-ci n’apparaît qu'une fois et sa valeur est partagée pour tous les checks.


Panel


Cas d'erreurs

Si la donnée définie est une donnée chiffrée (voir Cas d'erreur), un avertissement apparaîtra dans la liste des données.


Panel

screenshot-5.png


Les checks ne seront alors pas générés et un message "Attention" apparaîtra dans la liste des checks.


Panel

screenshot-6.png


Syntaxe de la valeur "Duplicate for each":


La valeur de la donnée

duplicate for each

Duplicate For Each a une syntaxe précise:

Code Block
themeMidnight
ma_cle1$(mon_arg1_cle1)$$(mon_arg2_cle1)$


On définit le nom de la clé et les arguments sont passés entre $( et )$ de manière consécutive. Les arguments sont facultatifs (s'ils ne sont pas renseignés, les arguments par défaut pourront être utilisés).


Pour renseigner plusieurs clés, on reprend la même syntaxe séparée par des virgules:

Code Block
themeMidnight
Exemple 1 : ma_cle1$(mon_arg1_cle1)$$(mon_arg2_cle1)$, ma_cle2$(mon_arg1_cle2)$$(mon_arg2_cle2)$, ma_cle3$(mon_arg1_cle3)$$(mon_arg2_cle3)$
Exemple 2 : ma_cle1, ma_cle2$(mon_arg1_cle2)$$(mon_arg2_cle2)$, ma_cle3$(mon_arg1_cle3)$


Dès que la saisie du champ est terminée, le nombre de checks de l'hôte est mis à jour.

 Exemple de donnée "Duplicate for each":

Code Block
themeMidnight
ok,warning$(1)$$(Dummy WARNING)$,critical$(2)$$(Dummy CRITICAL)$,unknown$(3)$$(Dummy UNKNOWN)$


Dans cet exemple, la première valeur/clé "ok" n'a aucun argument défini, la valeur par défaut des arguments sera alors utilisée, à savoir, 2 arguments dans notre exemple :

Code Block
themeMidnight
 $(0)$$(Dummy OK)$


Pour la valeur/clé  "warning", cette clé a deux arguments "1" et "Dummy WARNING".

Plus de détails sont dans la prochaine section "Les valeurs".


Panel



L'onglet check permet de vérifier le résultat de la duplication.

Les checks obtenus ont des configurations identiques. Pour pouvoir leur donner des données spécifiques, il faudra utiliser les valeurs.

On voit ici que le check a bien été dupliqué pour les 4 valeurs de données "Duplicate for each".

Pour chaque duplication, les arguments sont bien récupérés pour le passage dans la commande. (Via les Variables spéciales $VALUEn$ qui correspondent aux différents $ARGn$)


Panel


Panel
titleEvaluation de commande


Les valeurs


Pour que chaque check puisse exécuter une vérification différente sur l'hôte, il est possible de paramétrer spécifiquement chaque copie.

Pour cela, l'hôte peut passer des arguments de duplication à chaque copie sous la forme de valeurs dans la donnée de "Duplicate for eachFor Each".


Par exemple, pour une commande qui demande deux arguments, la syntaxe de la donnée de "Duplicate for each" est la suivante :

Code Block
themeMidnight
red$(IndianRed)$$(CD5C5C)$,green$(ForestGreen)$,blue


Info
 Remarque: Les arguments manquants seront remplacés par les valeurs par défaut.



CheckVariables Valeur
Check-Duplicate-red

$KEY$

$VALUE1$

$VALUE2$

red

IndianRed

CD5C5C

Check-Duplicate-green

$KEY$

$VALUE1$

$VALUE2$

green

ForestGreen

default_value2

Check-Duplicate-blue

$KEY$

$VALUE1$

blue

default_value1


 $VALUE2$ default_value2


Syntaxe des fichiers de configuration

Voici dans notre exemple, la définition d'un check duplicate for each Duplicate For Each qui va s'appliquer à un modèle d'hôte:

Code Block
define service {
   service_description          check-dummy-$KEY$
   register                     0
   host_name                    testpack-host-tpl
   use                          check-dummy-tpl
   duplicate_foreach            _STATUS
   default_value                $(0)$$(Dummy OK)$
}


define host {
    name                testpack-host-tpl
    check_command       check-host-alive
    check_interval      1
    retry_interval      1
    register            0
    _STATUS             ok,warning$(1)$$(Dummy WARNING)$,critical$(2)$$(Dummy CRITICAL)$,unknown$(3)$$(Dummy UNKNOWN)$
}