Editer un modèle de check

Onglet Général

Nom du Check

• Clé d'import: service_description
  

  Les caractères ~!$%^&*"'|<>?,()=/+ sont interdits dans ce champ.

   Un caractère non autorisé provoquera un compteur erreur

  Le nom doit être unique.

  Ce champ ne peut pas rester vide

Modèles de Check appliqués

• Clé d'import : use
  Les modèles de checks qui sont attachés au check permettant au check d'hériter de leurs propriétés et de leurs données.
  
  • L'ordre des modèles est important.
  • Une valeur définie dans deux modèles prendra la valeur du modèle le plus proche du début de la liste.
  • Les valeurs définit pour une propriété ou une donnée, serons prioritaire sur celles héritées de modèles.

Impact métier

• Clé d'import : business_impact
  Cette propriété permet de définir l'importance que l'on donne à un check pour le business. ( valeur numérique entre 0 et 5 dans les fichiers d'imports, mais affichée dans l'interface avec des étoiles ou des dollars suivant le niveau ):
  • du moins important ( 0 => * )
  • ( 1 => ** )
  • ( 2 => *** )
  • ( 3 => $$$$ )
  • ( 4 => $$$$$ )
  • au plus important ( 5 => $$$$$$ )
  La valeur par défaut est 2 ( *** ).

URL externe

• Clé d'import : notes_url
  Cette propriété est utilisée pour définir une URL qui peut être utilisée pour fournir plus d'information sur ce check.
  N'importe quelle URL valide peut être mise, commençant par http:// ou https://
  
  Cette URL sera disponible dans l'interface de visualisation dans le volet détail présentant le check.
  Cela peut être pratique pour faire une description écrite détaillée du check, une procédure de reprise sur panne... qui sera visible pour les autres membres de l'équipe.

    Une URL qui ne commence pas par http:// ou https:// provoquera un compteur d'erreur et il sera impossible d'enregistrer le check

  Les caractères "' et les espaces sont interdits dans ce champ .

   Un caractère non autorisé provoquera un compteur d'erreur et il sera impossible d'enregistrer le check

Liste des URL externes

• Clé d'import : notes_multi_url
  
  Cette propriété est utilisée pour définir plusieurs URL qui peuvent être utilisées pour fournir plus d'informations sur ce check.

(1) Nom de l'URL ( label pour l'interface de visualisation ), Le nom à afficher est optionnel ( mais son absence montrera toujours un warning dans l'interface )

(2) Adresse de l'URL, N'importe quelle URL valide peut être utilisée, commençant par  http://  or  https://

(3) Icône pour l'UI de visualisation
(4) Type d'affichage dans l'interface de Visualisation

• Nouvel onglet,

• Pop-up de différente taille ( 30%, 40%, 50%, 60%, 70%, 80% de la taille de l'écran )

• Caché

(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 ).

• Le bouton d'édition permet d'éditer la propriété URL externe soit en collant un format précédemment copié ou bien en écrivant le format.

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.

Onglet Données

Cet onglet définit des données qui pourront être utilisées par des variables (  voir la page : Les Variables ( Remplacement dynamique de contenu - Anciennement les Macros ) ), notamment à l'utilisation de la commande (  voir la page Les commandes ) de check. Consultez ces pages pour plus d'info

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 maintenance planifiée

• Clé d'import : maintenance_period
  • Cette propriété permet de définir une période de temps pendant laquelle le check sera en maintenance.
  • En maintenance, les checks de l'hôte ( ou cluster  ) seront toujours exécutés ( donc il n'y aura pas de manques dans les métriques ou l'historique ), mais les notifications et les commandes du gestionnaire d’événement ne seront pas lancées.

Vérification du statut de l'élément

Actif

Actif activé

• Clé d'import : active_checks_enabled
  Cette propriété permet de définir si Shinken ordonnance et lance la commande de vérification pour déterminer l'état de ce check.
  Ses valeurs peuvent être:
  • True: Shinken va ordonnancer et lancer la commande de vérification
  • False: Shinken ne va pas ordonnancer et lancer la commande de vérification

Commande de vérification

• Clé d'import : check_command
  Cette propriété permet de spécifier la commande qui est employée pour vérifier si le check est dans un statut en OK ou CRITIQUE.
  Si la propriété est vide, la commande de contrôle par défaut sera employée.
  
  Pour le passage de plusieurs arguments, le séparateur est !
  Exemple : mavaleur1!mavaleur2
  Pour Duplicate For Each : $VALUE1$!$VALUE2$
  

  Ce champ ne peut pas rester vide

Affichage des seuils

• Clé d'import : thresholds_display
  
  Cette propriété a pour but de décrire et d'afficher les seuils utilisés sur lesquels la commande de supervision se base afin de déterminer le Statut du check ( OK, CRITIQUE, ... ).
  Le contenu est libre, donc il est possible ajouter n'importe quel format de texte.

À savoir :

• • Les données seront interprétées dans le "Rendu final" pour avoir la dynamique de configuration des seuils. ( voir la page Les Variables ( Remplacement dynamique de contenu - Anciennement les Macros ) )
  • Le HTML sera interprété.
  • Le rendu sera calculé au chargement de la page, mais il nécessitera l'appui sur le bouton "Mettre à jour" lors d'une édition de l'élément.
  • Dès qu'une propriété ou une donnée influant sur le rendu final sera modifiée, ce dernier sera effacé et devra être mis à jour manuellement.

Tag de poller

• Clé d'import : poller_tag
  Cette propriété permet de définir le poller_tag du check.
  Le check ne sera exécuté que par les Pollers ayant cette valeur dans la liste des Tags définie dans leur paramètre poller_tags.
  Par défaut, la valeur de Tag de Poller est "même comportement que son parent".
  Si la valeur est "non tagué" :
  • Tous les Pollers n'ayant aucun poller_tag seront utilisés pour l'exécution
  • Ou tous les Pollers spécifiant qu'ils prennent aussi les checks non tagués

Période de vérification

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

Nombre maximum de tentatives de confirmation du statut du check

• Clé d'import : max_check_attempts
  Cette propriété permet de définir le nombre de tentatives où Shinken recommencera la commande de vérification d'un check si son résultat est autre chose que le statut OK.
  Mettre cette valeur à 1 impliquera que Shinken générera une alerte dès qu'il n'est plus en état OK, sans réessayer.
  Pour que Shinken ne fasse plus de vérification de statut de ce check, laissez cette propriété à 1, mais la commande de vérification doit être vide.
  
  

Intervalle entre les vérifications ( minutes )

• Clé d'import : check_interval
  Cette propriété permet de définir le temps entre deux vérifications de l'état du check.

    La limite est fixée à 2630880 ( soit cinq ans ).

    Une valeur non numérique provoquera un compteur erreur.
  

Intervalle de nouvelles tentatives de vérification d'état ( minutes )

• Clé d'import : retry_interval
  Cette propriété permet de définir le temps d'attente avant de relancer la commande de vérification du check après un premier état différent de OK.
  Ce nombre est en minutes.
  Une fois que le nombre de relances de commandes de vérifications a atteint la valeur max_check_attempts , le dernier état récupéré est validé et la cadence des vérifications revient à la valeur normale, définie dans la propriété Intervalle entre les vérifications.

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 de l'hôte.
• Aucune valeur ou une valeur a -1, indique qu'il n'y a pas de Temps maximum défini.
  Si ni l'hôte, 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 Hôte, ou par la valeur par défaut ( shinken.cfg:warning_threshold_cpu_usage )

Passif

Passif activé

• Clé d'import : passive_checks_enabled
  Cette propriété permet de définir si Shinken accepte les résultats de commandes de checks depuis des outils externes pour cet hôte ( ou clusters )
• Les résultats externes seront reçu via le démon Receiver de Shinken.
  Les valeurs possibles sont:
  • True: accepte les résultats de commandes de checks externes
  • False: n'accepte pas ces résultats

Vérification que l'état reçu des outils externes ne soit pas expiré

• Clé d'import : check_freshness
  Cette propriété permet de définir si Shinken doit vérifier que la date de réception du dernier état reçu des outils externes ne soit pas expirée ( trop vieille ). Si la date est plus antérieure à la période d'expiration, alors Shinken va forcer l'exécution de la commande de check.
  Ses valeurs peuvent être:
  • Activé: Shinken va vérifier l'expiration
  • Désactivé: Shinken ne vérifiera pas l'expiration

Seuil d'expiration des états reçus des outils externes ( secondes )

• Clé d'import : freshness_threshold
  Cette propriété permet de définir quand Shinken doit forcer la commande pour check si le dernier état reçu des outils externes est antérieur à ce seuil.
  Cette valeur est en secondes.

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

  Une valeur non numérique provoquera un compteur erreur.

Duplicate for Each

Nom de la donnée sur l'hôte ( ou cluster ) qui contiendra les valeurs utilisées pour la duplication des checks

• Clé d'import : duplicate_foreach
  Cette propriété est utilisée pour générer plusieurs checks dans l'Arbiter avec une seule définition de check dans le Synchronizer. Shinken comprend cette propriété comme : Crée un check pour chaque valeur de cette propriété.
  
  Le nom du check doit contenir un $KEY$. En créant un check pour chaque valeur, Shinken remplacera le $KEY$ par cette Valeur. $KEY$ est aussi utilisable dans la check command si nécessaire, pour son exécution. Des paramètres peuvent être fournis aux checks ( appelé $VALUE$ si il y en a qu'un ou $VALUE x $, avec x valant de 1 à n ).
  

Valeur par défaut des arguments des valeurs utilisées pour la duplication des checks

• Clé d'import : default_value
  Il est possible de fournir plusieurs arguments pour chaque valeur définie dans la donnée de l'hôte ( ou cluster ) utilisé par la fonctionnalité Duplicate for Each.
  
  Mais si la liste des arguments devient grande et plusieurs fois la même, il est inutile de les répéter.
  
  Prenons le cas d'une base de données avec un port par défaut et une connexion sécurisée en ssl:

• • La donnée DATABASE contient DB1, DB2, DB3
  • Si on définit les arguments sur chaque base, on aurait dans la donnée DATABASE : DB1$(1521)$$(ssl)$,DB2$(1521)$$(ssl)$,DB3$(1521)$$(ssl)$
  • Définir un port particulier sur DB2 donnerait DB1$(1521)$$(ssl)$,DB2$(20000)$$(ssl)$,DB3$(1521)$$(ssl)$
  • Mais plus simplement, il est possible de définir dans cette propriété les valeurs par défaut des arguments $(1521)$$(ssl)$, alors la propriété DATABASE sur l'hôte ( ou cluster ) pourra avoir cette forme simplifiée DB1,DB2$(20000)$$(ssl)$,DB3

Données stockées

Métrologie

Lire et stocker les métriques

• Clé d'import :  process_perf_data
  
  Cette propriété permet de définir si Shinken doit lire et stocker les métriques issues de la commande de vérification du check.
  Les valeurs possibles sont:
  • Vrai: Shinken va lire et stocker les métriques issues de la commande de vérification
  • Faux: Shinken ne va pas lire et stocker les métriques issues de la commande de vérification

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 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 cibles ( Utilisateurs ou Groupes d'utilisateurs ) sur ce check.
  Les notifications sont envoyées :
  • Premièrement après la fin de la période de nouvelle tentative, une fois que l'état CRITICAL est confirmé.
  • Ensuite, après chaque intervalle de notification, exprimé en minutes
  • Quand le check redevient OK
  
  Les valeurs possibles sont :
  • Vrai : Shinken va envoyer les notifications
  • Faux : Shinken n'enverra pas les notifications

Utilisateurs

• Clé d'import :  contacts
  Cette propriété est utilisée pour définir quels sont les utilisateurs à notifier.

Groupes d'utilisateurs

• Clé d'import :  contacts_groups
  Cette propriété est utilisée pour définir quels sont les groupes d'utilisateurs à notifier.

Intervalle de temps entre les notifications ( minutes )

• Clé d'import :  notification_interval
  Cette propriété permet de définir les intervalles de temps entre les notifications.
  Cette valeur est en minutes.
  
  Note : la valeur zéro sur cette propriété signifie que seule la première notification sera envoyée.

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 de l'hôte peuvent envoyer des notifications
    La valeur est une liste d'options séparées par des virgules :
    • d : envoie une notification sur un état CRITIQUE
    • u : envoie une notification sur un état UNREACHABLE
    • r : envoie une notification lors d'un rétablissement ( signifie que le statut de l'hôte redevient OK )
    • f : envoie une notification quand l'hôte commence ou sort du contexte FLAPPING
    • s : envoie une notification quand l'hôte entre ou sort d'une période de maintenance
    • n : n'envoyer aucune notification
    Par défaut, toutes les notifications sont autorisées.

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 mis à profit par les utilisateurs pour prendre en compte le check 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.

Escalades

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

Onglet Expert

Envoyer une notification à chaque retour en erreur du check

• Clé d'import :  is_volatile
  Cette propriété permet de forcer Shinken à envoyer une notification pour chaque retour en erreur d'un check.
  
  • Si non forcé, Shinken va vérifier l'état du check avant de lancer une notification ( avec un nombre maximum de confirmations du statut ), puis ne va envoyer des notifications que tous les intervals de notifications  ( typiquement une fois par jour par défaut ).
  • Dans le cas contraire, cette option est activée, tous ces systèmes seront désactivés, et une notification sera envoyée pour chaque check retournant un statut en erreur.

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 actif.
  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 d'un check 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. La valeur o est obligatoire.
  Exemple: o,w,u

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 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 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 de temps durant laquelle elles sont actives.
  Pendant cette période, la valeur d'impact métier sera changée par celle de la modulation.

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 de temps durant laquelle elles sont actives.
  Pendant cette période, les données du check seront changées par celle de la modulation.
  

Modulations des 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 d'un check, en fonction de son statut initial, d'une période de temps, ou de sa sortie.
  

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 du statut du check:
  • quand le cehck passe d'un état OK à un état à problème ( CRITICAL ou UNKNOWN )
  • à chaque vérification additionnelle, donc un nombre  maximum de confirmation du statut
  
  Si la propriété est:
  • Vrai: va lancer la commande quand nécessaire
  • Faux: ne va pas lancer cette commande
  
  

Tag d e reactionner

• Clé d'import :  reactionner_tag
  Cette propriété permet de définir le reactionner_tag du check.
  La commande du gestionnaire d'événement définie sur ce check 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: ce Tag n'est utile que pour la commande de Gestionnaire d'événements. Les notifications utilisent le tag 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érons les événements des checks d'un hôte ( ou 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.

Autre

Ordre de définition

• Clé d'import : definition_order
  Ordre de définition