Versions Compared

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 des checks sur un même hôte.

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 toute la configuration de vérification pour chacun de ces services, en leur dédiant à chacun des checks.

Un template donné ne s'applique qu'à un hôte dans son ensemble et ne peut pas y être dupliqué. Pour pouvoir dupliquer les vérifications, il faut utiliser des checks ayant la propriété "Duplicate for each host data", et configurer la façon dont ils seront dupliqués sur cet hôte : quelle partie sera copiée (commande, intervalle...) et quelle partie sera spécifique à chaque check (identifiants, port de connexion...)

.

 

Structure de la donnée duplicate Foreach:

  • KEY: Correspond à la clé, appelé $KEY$.
     

  • VALUE: Correspond à un paramètre, appelé $VALUE$ si il y en a qu'un ou $VALUEx$, avec x allant de 1 à 16.
    Info

    Remarque: L'utilisation de ces variables est possible dans une commande. Il faut utiliser le délimiteur $ au début et fin de chaque variable pour l'appeler.

    Exemple des structures possible:

    Structure simple (sans paramètre):

    Nombre de générationStructure simpleExemple1
    Code Block
    themeMidnight
    KEY
    Code BlockDB1

     

     

    2
    Code Block
    themeMidnight
    KEY-name1,KEY-name2
    Code Block
    DB1,DB2
    n+1
    Code Block
    languagejs
    themeMidnight
    KEY-name-n

     

     

    Info
    iconfalse
    Remarque: Cette structure peu être répéter autant de fois que nécessaire. Chaque structure correspond à une génération de check. (Cf. Structure avancée ci-dessous)

     

     

    Structure avancée:

    Nombre de générationStructure avancéeExemple1
    Code Block
    themeMidnight
    KEY$(value1)$
    Code Block
    DB1$(2222)$
    2
    Code Block
    themeMidnight
    KEY-name1$(value1)$,KEY-name2$(value1,value2)$

     

     

    Code Block
    DB1$(2222)$,DB2$(3333,ssl)$
    n+1

     

     

    Code Block
    DB1$(22)$,DB2$(3000)$,DB2$(1521)$

     

     

    Fonctionnement

    Les checks

    Pour qu'un check soit dupliqué, il doit remplir plusieurs conditions.

    • Le champ "Duplicate for each host data" (1) doit contenir le nom d'une donnée définie dans l'hôte. C'est la donnée qui servira à dupliquer le check.
    • (Optionnel) Le champ "Duplicate for each default arguments" (2) permet de spécifier les valeurs par défaut pour les macros $VALUEn$.
    • Le nom du check doit contenir $KEY$ (3). Cette macro sera remplacée par les données de l'hôte, de manière à ne pas générer de collision de nom.

    Le check peut alors utiliser, dans sa configuration, $KEY$, et $VALUE1$ à $VALUE16$. Ces macros seront remplacées de façon spécifique à chaque copie.

    Le champ "Default value" (2) permet de spécifier les valeurs par défaut pour les macros $VALUEn$. 

     

     

    Panel
    Image Modified

     

     

    L'hôte

    Pour que l'hôte duplique ses checks, il doit alors renseigner les valeurs à dupliquer, sous la forme de données.

    Un hôte ayant des checks à dupliquer lui étant attachés doit obligatoirement fournir des valeurs, et les données apparaîtront en Warning si elle sont manquantes.

     

     

     

    Panel

    La donnée renseignée dans la donnée doit définir une ou plusieurs clés séparées par des virgules comme montré dans l'exemple.

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

    Panel

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

    Panel

    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.

     

     

    La syntaxe est la suivante :

     

     

     

    Code Block
    themeMidnight
    red$(255,0,0)$,green$(0,255,0)$,blue$(0,0,255)$

    Dans cet example, chaque copie aura accès à trois valeurs, $VALUE1$, $VALUE2$, et $VALUE3$.

     

    CheckMacroValeur
    Check-Duplicate-red

    $VALUE1$

    $VALUE2$

    $VALUE3$

    255

    0

    0

    Check-Duplicate-green

    $VALUE1$

    $VALUE2$

    $VALUE3$

    0

    255

    0

    Check-Duplicate-blue

    $VALUE1$

    $VALUE2$

    $VALUE3$

    0

    0

    255

     

     

     

     

     

    Description

    La fonctionnalité duplicate foreach s'active directement depuis le check que l'on souhaite générer plusieurs fois. Deux champs sont à renseigner:

     

    Duplicate for Each:

    Ce champ correspond au nom de la donnée de l'hôte ou cluster à utiliser.

    Une fois le nom de la donnée défini, Shinken interprète au niveau de l'hôte ou cluster: Crée un check pour chaque valeur de cette donnée, sous la forme KEY1,KEY2,KEY3

        • Info
          iconfalse

          remarque: Le nom du check doit contenir un $KEY$ pour l'identifier de façon unique.

    Duplicate for Each default:

    Ce champs correspond à la valeur par défaut des arguments de la donnée utiliser pour le "duplicate foreach", soit le nom de la donnée renseigné dans le champ "duplicate foreach".

        • Info
          iconfalse
          remarque: Si il y a plusieurs arguments par défaut, utiliser la virgule comme séparateur

     

    Utilisation 

    En partant du postulat d'avoir 3 base de données, DB1DB2 et DB3 avec un port par défaut à 1521 et une connexion sécurisée en ssl. Le nom de la donnée de l’hôte/cluster choisi pour le "duplciate foreach" est DATABASES.

    Sans les valeurs des arguments par default:

    Page d'édition d'un check:

    (1) Renseignez le champ "duplciate foreach" avec DATABASES.

    Page d'édition d'un hôte/cluster:

    (2) Ajouter la donnée DATABASES avec pour valeur: DB1$(1521,ssl)$,DB2$(1521,ssl)$,DB3$(1521,ssl)$

     

    Avec les valeurs des arguments par default:

    Page d'édition d'un check:

    (1) Renseignez le champ "duplciate foreach" avec DATABASES.

    (2) Renseignez la valeur par default des arguments du champ "duplciate foreach" avec 1521,ssl.

    Page d'édition d'un hôte/cluster:

    (3) Ajouter la donnée DATABASES avec pour valeur: DB1,DB2,DB3

          • Info
            iconfalse

            Remarque: Définir un port particulier sur DB2 donnerait: Ajouter la donnée DATABASES avec pour valeur DB1,DB2$(2222)$,DB3