Introduction

Le gestionnaire d'événements est un système de commandes optionnelles ( scripts ou exécutables ) qui sont lancées dès qu'un hôte ou un check changent d'état.  

Comme pour les notifications, l'objectif est de pouvoir invoquer une de vos commandes que vous aurez définie pour réagir suite au changement d'état.

Voici des exemples d'utilisations :

• Redémarrer un hôte ;
• Relancer un service sur un hôte ;
• Créer un ticket dans un outil de support ;
• Tracer des événements dans une base de données ;
• Informer un Shinken distant ;
• ...

Mise en place

Activer le mécanisme de gestionnaire d'événements

Par défaut, Shinken active le mécanisme de gestionnaires d'événement ( event handlers ).

Ce comportement peut être surchargé ( activés ou désactivés ) globalement en utilisant le paramètre "enable_event_handlers" dans le fichier de configuration /etc/shinken/shinken.cfg ( Fichier de configuration ( shinken.cfg ) .

• Si ce paramètre n'est pas présent dans le fichier, il faudra l'ajouter.
• Par exemple, pour désactiver globalement l'exécution des gestionnaires d'événement.
  
  

enable_event_handlers=0

Associer un gestionnaire d'événement à un élément 

On peut aussi gérer l'activation/désactivation au cas par cas sur les hôtes, les clusters ou les checks. ( Voir Editer un Hôte#Chapitre - Gestionnaire d'événements, Editer un Cluster#Chapitre - Gestionnaire d'événements et Editer un check#Chapitre - Gestionnaire d'événements )

• Vous allez associer une commande en tant que gestionnaire d'événement.
• Cela pourra être une commande déjà existante ou une que vous aurez faite spécifiquement.

A noter que si le paramètre global est à "désactivé" les gestionnaires d'événements, le paramétrage local n’auront aucun effet .

Ecrire une commande

Les commandes de gestionnaires d’événements sont des objets "commande" de Shinken que vous pouvez définir via la page d'édition "Les commandes".

Les exemples de notation de Variables suivants permettent de régler le comportement de la commande en fonction de l'événement géré : 

Pour les checks:

• $SERVICESTATE$
• $SERVICESTATETYPE$
• $SERVICEATTEMPT$

Pour les hôtes:

• $HOSTSTATE$
• $HOSTSTATETYPE$
• $HOSTATTEMPT$

Droits pour la commande

Par défaut, la commande est exécutée avec les mêmes droits que ceux de l'utilisateur sous lequel Shinken est démarré sur la machine. Cela peut présenter un problème si vous voulez utiliser un gestionnaire d'événements qui doit redémarrer des services système, qui nécessitent généralement des accès privilégiés pour faire ce genre de tâches.

Dans l'idéal, vous devez évaluer les types de gestionnaires d'événements que vous serez en train de mettre en place et rajouter juste assez de permissions sur le user Shinken afin qu'il puisse exécuter les commandes systèmes nécessaires. Vous devrez peut-être utiliser "sudo" pour accomplir cela.

Fonctionnement

Quand est ce que vos commandes sont exécutés ?

Le gestionnaire d'événements propose des fonctionnalités similaires aux notifications, mais les événements sont appelés à chaque changement d'état, SOFT ou HARD.  

Les commandes sont exécutées :

• lorsque le statut de l'élément est en SOFT et à chaque réception d'une vérification de statut,
• lorsque le statut de l'élément passe en HARD non OK (WARNING, CRITICAL, UNKNOWN),
• lorsque le statut de l'élément passe en OK

Les états SOFT et HARD sont décrits en détail dans la page : États "HARD" et "SOFT".

Log sur le déclenchement des commandes 

Vous pouvez activer les logs en utilisant le paramètre log_event_handlers (par défaut, le paramètre est à 1)

log_event_handlers=1

Des lignes de logs seront alors présentes dans le fichier de log du Scheduler lors du déclenchement de la commande.

[2021-03-17 11:55:14] INFO   : [ scheduler-master ] SERVICE EVENT HANDLER: HOST;Process ntpd;CRITICAL;SOFT;1;manage_ntpd
...
[2021-03-17 11:56:13] INFO   : [ scheduler-master ] SERVICE EVENT HANDLER: HOST;Process ntpd;OK;SOFT;2;manage_ntpd

• HOST = Nom de l'hôte
• Process ntpd = Nom du check dont la commande de gestion d'événement va être lancé.
• CRITICAL/OK = Status du check.
• SOFT = État du check.
• 1/2 = Nombre de tentative.
• restart_ntpd = Nom de la commande qui est exécuté