Onglet : Général

Nom

• Clé d'import : host_name
• Cette propriété permet de définir le nom utilisé pour identifier le cluster.
• Son contenu est accessible par l'intermédiaire de la variable $HOSTNAME$ .

Définition

• Clé d'import : bp_rule
  
  Cette propriété est utilisée pour configurer en une règle logique une agrégation de plusieurs autres états ( hôtes, clusters et checks ).

  • La syntaxe complète de définition d'un cluster se trouve dans la page Les Clusters.
    
    

• Voici quelque exemples:
  
  

Modèles de cluster hérités

• Clé d'import : use

Les modèles de cluster qui sont attachés au cluster pour hériter de leurs propriétés et de leurs données.

L'ordre des modèles est important.

Liste des URL externes

• Clé d'import : notes_multi_url
  
  Cette propriété est utilisée pour définir plusieurs URL permettant de fournir plus d'informations sur ce cluster ( une description écrite détaillée de l'hôte, une procédure de reprise sur panne, etc ... ).
  Ces URL seront disponibles dans l'interface de Visualisation ( les listes et dans le volet détail présentant le cluster ).
  
  La définition d'une URL est composée de 4 parties :
  
  • (1) Du nom de l'URL ( pour l'affichage dans l'interface de Visualisation l'URL )

• • (2) De l'adresse de l'URL ( doit commencer par http:// ou https:// )

• • (3) D'une icône ( permettant de reconnaître l'URL dans l'interface de Visualisation )
  • (4) Du type d'affichage
    • Caché
    • Ouverture dans un nouvel onglet
    • Ouverture dans un popup interne à Shinken
  • (5) Valeur à copier-coller dans un fichier cfg pour retrouver cette propriété dans l'état
  • ( 6 ) Passer la souris en survol du champ format fichier Cfg pour faire apparaître les boutons de copie du format ( gauche ) et d'édition du format ( droite )

Cela peut être pratique si vous désirez faire une description écrite détaillée de l'hôte du cluster, une procédure de reprise sur panne, ou toute autre information qui sera visible pour les autres membres de l'équipe.

Les caractères < > " ' sont interdits.

Activé

• Clé d'import : enabled
  
  Permettre que cet élément soit pris en compte lors du passage de Staging en Production.

 Pack

• Clé d'import : pack

Permet de donner un nom commun à un ensemble d'éléments de Shinken. Il sera ainsi possible de filtrer par ce nom commun dans les listes des éléments pour retrouver l'ensemble des éléments.

Cette propriété n'est pas héritable.

Les caractères < > & " ' / sont interdits dans ce champ.

 Un caractère non autorisé provoquera un compteur d'erreur et il sera impossible d'enregistrer l'hôte

Onglet : Données

Cet onglet définit des données qui pourront être utilisées en tant que Variable, notamment à l'utilisation de la Commande des checks attachés à ce cluster. Consulter ces pages pour plus d'information.

La valeur de la donnée pouvant être longue, il est possible d'agrandir le champ de la valeur afin d'améliorer la lisibilité du champ.

Pour agrandir le champ de la valeur, il faut maintenir le clic sur l'icône située en bas à droite du champ et réajuster verticalement.

Onglet : Supervision

Période de DOWNTIME récurrente

• Clé d'import :  maintenance_period

Cette propriété permet de définir une période de temps durant laquelle le cluster sera en maintenance, et en sortira dès que la période de temps sera fini.

En maintenance, les checks di cluster seront toujours exécutés ( donc il n'y aura pas de manques dans les métriques ou l'historique du cluster ), mais les notifications et les commandes du gestionnaire d'évènements ne seront pas lancées.

Tag de Poller

• Clé d'import :  poller_tag
  Cette propriété permet de définir le poller_tag du Cluster.
  
  Elle n'a pas d'effet sur le cluster en lui-même, mais si une valeur est définie, les checks du cluster pourront hériter de ce tag, suivant leur configuration.

Données stockées

SLA

Seuil d'avertissement

• Clé d'import : sla_warning_threshold
  
  Cette propriété permet de définir un seuil d'avertissement pour le module SLA.
  La valeur doit être un nombre décimal entre 0 ( inclus ) et 100 ( inclus ) avec jusqu'à 3 chiffres après la virgule.

Seuil critique

• Clé d'import : sla_critical_threshold
  
  Cette propriété permet de définir un seuil critique pour le module SLA.
  La valeur doit être un nombre décimal entre 0 ( inclus ) et 100 ( inclus ) avec jusqu'à 3 chiffres après la virgule.

Onglet : Valeurs par défaut pour les checks

Période de vérification

• Clé d'import : check_period
  
  Cette propriété permet de choisir la période de supervision pendant laquelle sont faites les vérifications de l'état du cluster par Shinken.
  
  

Temps maximum d'exécution d'un check ( secondes )

• Clé d'import : check_running_timeout
  
  Cette propriété permet de définir la valeur en secondes du temps maximum permis pour le lancement d'une commande de supervision. Passé ce délai, la commande sera terminée. Si le check ou la commande définit également ce paramètre, leur valeur sera prioritaire par rapport à celle du cluster
  
  Aucune valeur ou une valeur a -1, indique qu'il n'y a pas de Temps maximum défini.
  
  Si ni le cluster, ni le check, ni la commande ne définissent ce paramètre, alors la valeur définie globalement pour Shinken ( via le fichier shinken.cfg et le paramètre check_running_timeout ) sera utilisée à la place.
  
  

Seuil d'alerte de l'utilisation CPU ( secondes )

• Clé d'import : warning_threshold_cpu_usage
  
  Nombre de secondes que peut consommer une commande avant d'apparaître en Warning dans le check 'Scheduler - Performance'
  La valeur sera récupérée dans l'ordre, par la commande, par l'élément Check, par l'élément Cluster, ou par la valeur par défaut ( shinken.cfg:warning_threshold_cpu_usage )
  

  La limite est fixée à 157852800 ( soit 5 ans ).

  Un caractère non autorisé provoquera un compteur d'erreur

Onglet : Droits de l'utilisateur

Il est possible pour chaque cluster de définir qui peut voir, éditer, ou encore recevoir les notifications. Le fonctionnement de ce mécanisme est expliqué dans la page  Droits d'accès à un cluster. Ces propriétés gèrent l'Héritage additif (le +).

Lors de la création d'un cluster, l'héritage additif est activé par défaut et l'utilisateur ( Administrateur Shinken ou Administrateur de SI ) créant le cluster est automatiquement ajouté aux droits utilisateurs suivants :

• Les utilisateurs qui voient le cluster,

• Les utilisateurs à notifier,

• Les utilisateurs qui peuvent modifier la configuration du cluster.

Ces propriétés se synchronisent les unes avec les autres, pour éviter d'avoir des droits aberrants.

Par exemple : avoir le droit d'éditer l'élément, mais sans avoir droit de le voir.

Les accès sont séparés en 3 sections :

• L'accès en visualisation du cluster
  
  • Ce paramètre permet d'autoriser certains utilisateurs ou groupes d'utilisateurs à voir le cluster concerné ( dans l'interface de Visualisation, mais aussi dans l'interface de Configuration ).
  • Il est possible de lister des utilisateurs individuellement, ainsi que des groupes d'utilisateurs.
  • Il est aussi possible, dans cette section, de choisir si le cluster peut être affiché sur les vues ne nécessitant pas une authentification à Shinken.
• L'accès aux notifications d'un cluster
  
  • Cette section permet de lister les utilisateurs ou les groupes d'utilisateurs qui recevront les notifications du cluster.

• L'accès en édition sans authentification peut être modifiée

  • Ce paramètre permet de lister les utilisateurs et les groupes pouvant éditer le cluster.

Onglet : Checks

Cet onglet détaille la liste des checks qui seront appliqués au cluster, et leur provenance ( venant de quel modèle de cluster, ou directement appliqué au cluster ) :

• Tout d'abord les checks accrochés directement sur le cluster sont listés.
• Ensuite sont listés les modèles dans l'ordre de leur apparition dans la liste des modèles hérités.
  
  • Et pour chacun leurs checks.
  • Seront aussi listé les checks duplication par la fonctionnalité permettant de Dupliquer pour chaque valeur de la Donnée du cluster ( voir la page Dupliquer des checks en fonction d'une liste de valeurs présentes dans la Donnée d'un hôte (duplicate_foreach) ), dans l'image, un seul check utilise des Duplicate Foreach ( la colonne Duplicate Foreach a une valeur pour ce check ).
    
    
• Sur cet onglet vous pouvez surcharger les valeurs des checks ( voir  la surcharge des checks ) et exclure les checks que vous ne voulez pas appliquer sur ce cluster ( voir  l'exclusion des checks ).
• Un filtre permet de naviguer plus facilement dans la liste des checks.

Pour chaque check, vous pourrez essayer le check depuis sa configuration actuelle afin de vérifier son résultat.

Essayer les checks

Les boutons dans la colonne [ Essayer ce check ] permettent d'évaluer ou d'essayer directement l'exécution d'un check, avec la résolution de ses données.

• Le premier bouton ( roue crantée ) permet de simuler la résolution des arguments, sans l'exécution du check. Cette évaluation vous permettra d'afficher la commande avec les données interprétées.

• Le second bouton ( roue crantée + icône play ) permet d'évaluer et de simuler son exécution depuis la plateforme de configuration ( Synchronizer ). Cette exécution n'utilisera pas vos pollers. Vous pouvez donc utiliser ce bouton pour tester votre commande sans affecter vos serveurs pollers en production.
  Le tableau récapitulatif présente les données récupérées et le résultat de la commande en prenant en compte les éventuelles modulations.

• Le troisième bouton ( icône play ) permet d'évaluer et de simuler son exécution directement sur les Pollers, comme lors de l'exécution normale sur votre architecture Shinken. Vous pouvez donc utiliser ce bouton pour tester votre commande sur votre environnement de production.
  Le tableau récapitulatif présente les données récupérées, et le résultat de la commande en prenant en compte les éventuelles modulations.
  
  

  Si votre check utilise des tags de Poller, l'exécution ne peut avoir lieu que si l'un des Pollers définis dans votre architecture dispose d'un tag de Poller correspondant à celui du check que vous essayez. Si le check est dans un sous royaume, il faut que l'un des Pollers du sous-royaume ait le tag rechercher. Veuillez consulter la page  Le Poller  pour plus d'informations sur les tags de poller.

  
  
  

• Le dernier bouton ( croix ) permet de cacher le bloc d'essai du check.

Les checks cachés

Certains checks peuvent être affichés en grisé avec le  libellé "Caché'".

Cette situation se produit lorsque deux checks ayant le même nom sont attachés sur deux modèles  de cluster attachés  ou bien directement attachés sur le cluster.

Dans l'ordre d'attachement, le premier check sera donc  visible  et les autres seront  cachés ( visibles pour l'utilisateur, mais grisé pour qu'il comprenne que seul le premier sera pris en compte et visible dans l'interface de visualisation ).

Inverser l'ordre d'héritage de ces modèles de cluster inversera également le statut ( caché / actif ) des checks.

Onglet : Notifications

Notifications activées

• • Clé d'import : notifications_enabled
    
    Cette propriété permet de définir si Shinken va envoyer des notifications aux utilisateurs listés comme destinataires ( Utilisateurs ou Groupes d'utilisateurs ) sur ce cluster.
    
    Les notifications sont envoyées :
    • Premièrement lorsqu'un statut non-OK est confirmé.
    • ensuite après chaque intervalle de notification, exprimé en minutes
    • quand le statut du cluster redevient OK
    
    Les valeurs possibles sont :
    • Vrai : Shinken va envoyer les notifications
    • Faux : Shinken n'enverra pas les notifications

Intervalle de temps entre les notifications ( minutes )

• Clé d'import : notification_interval
  
  Cette propriété permet de définir la période de temps durant laquelle les notifications sont autorisées.
  En dehors de cette période, aucune notification ne sera envoyée.
  
  Par défaut, il n'y a pas de période de temps, et donc les notifications ne seront jamais bloquées.
  
   La limite est fixée à 2630880 ( soit 5 ans ).
   Une valeur non numérique provoquera un compteur erreur
  
  
  

Période de temps de notification

• Clé d'import : notification_period
  
  Cette propriété permet de définir la période de temps durant laquelle les notifications sont autorisées.
  En dehors de cette période, aucune notification ne sera envoyée.
  
  Par défaut, il n'y a pas de période de temps, et donc les notifications ne seront jamais bloquées.
  
  

Options de notification

• Clé d'import : notification_options
  
  Cette propriété permet de définir quels états et contextes du cluster peuvent envoyer des notifications.
  
  La valeur est une liste d'options séparées par des virgules:
  • c: envoie une notification sur un état CRITIQUE
  • w: envoie une notification sur un état AVERTISSEMENT
  • u: envoie une notification sur un état INCONNU
  • d:envoie une notification sur un état CRITIQUE et AVERTISSEMENT
  • r: envoie une notification lors d'un rétablissement ( signifie que l’état redevient OK )
  • f: envoie une notification lors de l’entrée ou la sortie en FLAPPING
  • s: envoie une notification lors de l’entrée ou la sortie en DOWNTIME
  • n: désactive toutes les notifications
    
    
  Par défaut, tous les états permettent d'envoyer une notification.
  
   Une option non existante provoquera un compteur erreur
  
  
  

Décalage de la première notification ( minutes )

• Clé d'import : first_notification_delay
  
  Cette propriété permet de définir combien de minutes Shinken doit attendre avant d'envoyer la première notification.
  Ce temps additionnel peut être utilisé pour limiter une avalanche de notifications ; en effet, les clusters n'ont pas de gestion HARD/SOFT et leur état est donc susceptible de changer plus fréquemment.
  Ce temps additionnel peut être mis à profit par les utilisateurs pour prendre en compte le cluster depuis l'interface de visualisation avant que la notification ne soit envoyée.
  Par défaut la valeur est 0, ceci signifie que la première notification sera envoyée sans attendre.
  
   La limite est fixée à 2630880 ( soit 5 ans ).
    Une valeur non numérique provoquera un compteur erreur
  
  
  

Escalades

• Clé d'import : escalations
  
  Cette propriété permet de lier ce cluster à une ou plusieurs définitions d'escalade.
  Si, au bout d'un certain temps, le cluster n'est toujours pas revenu OK ou pas pris en compte ( Contexte ACKNOWLEDGE ou DOWNTIME ), la règle d'escalade sera appliquée.
  
  Cette propriété gère l' Héritage additif (le +) .

Onglet : Expert

Paramétrage du Flapping 

Détection du FLAPPING activée

• Clé d'import : flap_detection_enabled
  
  Cette propriété permet de définir si la détection du Contexte FLAPPING est active sur le cluster.
  Peut être:

  • Vrai: active la détection du contexte FLAPPING.
  • Faux: désactive la détection du contexte FLAPPING.

Options de la détection du FLAPPING

• Clé d'import : flap_detection_options
  
  Cette propriété permet de définir quel statut du cluster sont pris en compte pour le calcul du % de FLAPPING.
  C'est une combinaison de l'un ou de plusieurs valeurs:

  • o = statuts OK
  • w = statuts WARNING
  • c = statuts CRITICAL
  • u = statuts UNREACHABLE
    
    
  Le séparateur est la virgule.
  
  o est obligatoire.
  
  Exemple: o,w,u
  
    Une option non existante provoquera un compteur erreur
  

  
  

Sortie du Contexte FLAPPING

• Clé d'import : low_flap_threshold
  
  Sur les 21 derniers statuts, chaque fois qu'un statut est différent du précédent ( de OK à Warning par exemple ), le % de FLAPPING augmente. Donc 10 changements représenteront un % de flapping de 50% et 20 représenteront 100%.
  Si ce % calculé est  inférieur  au  % de sortie du Contexte FLAPPING, alors le Contexte de l'hôte ne sera plus FLAPPING.
  
  

Entrée du Contexte FLAPPING

• Clé d'import : high_flap_threshold
  
  Sur les 21 derniers statuts, chaque fois qu'un statut est différent du précédent ( de OK a Warning par exemple ), le % de FLAPPING augmente. Donc pour 10 changements, cela représentera un % de FLAPPING de 50% et pour 20, cela représentera 100%.
  Si ce % calculé est  supérieur  au  % d'entrée dans le Contexte FLAPPING, alors le Contexte de l'hôte deviendra FLAPPING.
  Il sortira de ce Contexte quand ce pourcentage calculé sera  inférieur au % de sortie du Contexte FLAPPING.

Modulations

Modulations d'impact métier

• Clé d'import : business_impact_modulations
  
  Cette propriété permet de définir une ou plusieurs modulations d'impact métier. Les modulations ont une période temps durant laquelle elles sont actives.
  Pendant cette période, la valeur d'impact métier de l'hôte sera changée par celle de la modulation.
  
  Cette propriété gère l' Héritage additif (le +) .
  
  

Modulations de données

• Clé d'import : macromodulations
  
  Cette propriété permet de définir une ou plusieurs modulations de données. Les modulations ont une période temps durant laquelle elles sont actives.
  Pendant cette période, les données de l'hôte seront changées par celle de la modulation.
  
  Cette propriété gère l' Héritage additif (le +) .
  
  

Modulations de résultats

• Clé d'import : resultmodulations
  
  Cette propriété permet de définir une ou plusieurs modulations de résultats. ( maximum 4 )
  Les modulations de résultats redéfinissent le statut de sortie du cluster, en fonction de son statut initial, d'une période de temps, ou de sa sortie.
  
  Cette propriété gère l' Héritage additif (le +) .
  

Gestionnaire d'événements

Gestionnaire d'événements activé

• Clé d'import : event_handler_enabled
  
  Cette propriété permet de définir si Shinken va lancer une commande ( définie par le paramètre commande de gestionnaire d'événements  ) à des étapes spécifiques lors des changements du statut du cluster :
  
  • quand le cluster passe d'un statut OK à un statut à problème ( CRITICAL ou UNKNOWN )
  • à chaque vérification additionnelle, tant que le statut n'est pas confirmé, donc un nombre maximum de confirmations du statut
  • quand le statut du cluster passe d'un statut à problème vers le statut OK 
  Si la propriété est :
  • Vrai : va lancer la commande quand nécessaire
  • Faux : ne va pas lancer cette commande

Tag de Reactionner

• Clé d'import : reactionner_tag
  
  Cette propriété permet de définir le reactionner_tag du cluster.
  La commande lancée par le gestionnaire d'événements définie sur ce cluster sera exécutée uniquement par les Reactionners qui ont dans leur paramètre reactionner_tags la valeur définie par cette propriété.. Remarque : Les notifications n'utilisent pas ce Tag, mais celui défini sur la commande de notification
  
  Par défaut, la valeur de  Tag de Reactionner  est  non tagué , donc les Reactionners n'ayant aucun reactionner_tag géreront les événements des checks d'un cluster non tagué, car la valeur par défaut pour les Reactionners est aussi  non tagué

Commande lancée par le gestionnaire d’événements

• Clé d'import : event_handler
  
  Cette propriété permet de définir la commande que lancera le gestionnaire d’événements pour ce cluster.