Page History

Contexte

Afin de pouvoir recevoir des notifications, la source cfg-file-shinken comprend un certain nombre de commande de notifications qu'il faudra importer et appliquer sur les méthodes de notifications.

Les commandes de notifications livrées sont généralistes et ne permettent pas de répondre à tous les besoins.

Si vous devez modifier un élément (commande ) livré par un pack Shinken pour un besoin spécifique, il est important de créer la vôtre.

Cette page apporte des conseils sur l'utilisation optimale des packs livrés par Shinken.

Cohabiter avec un pack livré Shinken

Pourquoi ne faut-il pas modifier les éléments livrés dans le pack ?

Des différences vous seront proposées après la mise à jour et l'import de la source "cfg-file-shinken", il vous sera donc imposé de faire un choix entre ce que vous avez surchargé et les modifications apportées par les mises à jour Shinken.

Création d'une commande de notification

Corps de la commande

Les commandes sont exécutées par le Reactionner lorsque les conditions définies par la Logique de notification sont réunies.

Elles ont accès spécifiquement à un certain nombre de notations de remplacement dynamique de contenu  (VARIABLE( voir la page LES VARIABLES ( Remplacement dynamique de contenu - Anciennement les MACROS ) ).

Ces données dynamiques peuvent venir de différents endroits :

• Une donnée globale
• L'élément à l'origine de la notification.
• Le contact à notifier
• La notification en elle-même, notamment son type.

Variables

globales

Ces notations de remplacement dynamique de contenu permettent de paramétrer globalement le comportement des notifications.

Toutes les notations globales peuvent être utilisées indifféremment dans une commande de notifications, mais les notations suivantes leur sont spécifiques :

$MAILURL$

$SENDER$

$NOTIFPLUGINDIR$

Variables liées à l'élément

Les notations de remplacement dynamique de contenu de l'élément peuvent être appelées dans la notification.

Dans le cas d'une notification de l'hôte, les notations de  variables de l'hôte sont disponibles.

Dans le cas d'une notification d'un check, les notations variables l'hôte et du check sont toutes les deux disponibles.

De la même façon que les notations globalesvariables globales, toutes les notations des variables des éléments peuvent être utilisées, mais les notations suivantes variables suivantes sont spécifiquement utiles :

Variables liées au contact

Les notations du contact pouvant être appelées dans la notification.

Variables liées à la notification

Des notations variables spéciales permettent d'avoir des données concernant la notification en elle-même et la raison pour laquelle elle a été envoyée.

SERVICEDOWNTIMECOMMENT

SERVICEDOWNTIMEAUTHOR

Pour les types de NOTIFPLUGINDIR, la liste des valeurs possibles est la suivante :

Exemple de personnalisation d'une commande de notification

Nous allons ici vous présenter un exemple de personnalisation de la commande de notification par défaut de Shinken.

Le but ici est de modifier la commande afin que la notification par email utilise un serveur SMTP de votre choix. En effet, par défaut, la commande utilise comme relais SMTP le processus Postfix du serveur qui héberge le démon Réactionner (serveur localhost).

Méthode de notification "email"

La méthode de notification incluse par défaut dans Shinken est "email". Cette méthode est d'ailleurs protégée contre le renommage et la suppression.

Cette méthode de notification utilise les commandes notify-host-by-email et notify-service-by-email.

Commande

Information sur la commande 

Voici la ligne de commande utilisée par l'objet commande notify-host-by-email  ( voir la page notify-host-by-email - Commande de notification ):

$NOTIFPLUGINDIR$/notify_by_email.py --title-tpl $NOTIFPLUGINDIR$/host_alert_title_template.tpl --content-tpl $NOTIFPLUGINDIR$/host_alert_content_template.tpl -F "$SENDER$" -r "$CONTACTEMAIL$" -n $NOTIFICATIONTYPE$ -H "$HOSTNAME$" --address "$HOSTADDRESS$" --url $MAILURL$ --huuid $_HOSTID$ --state $HOSTSTATE$ --last-state $LASTHOSTSTATEID$ --last-change $LASTHOSTSTATECHANGE$  --last-check "$DATE$ $TIME$" --output "$HOSTOUTPUT$" --long-output "$LONGHOSTOUTPUT$" --ack-author "$ACKAUTHOR$" --ack-data "$ACKDATA$" 

Cette commande est localisée dans le répertoire par défaut /var/lib/shinken/libexec/notifications/($NOTIFPLUGINDIR$). 

Le script utilisé est un script Python qui prend un certain nombre d'arguments.

Comme vous pouvez le constater, la ligne de commande fait référence à de nombreuses notations de remplacement dynamique de contenu ( voir la page LES VARIABLES ( Remplacement dynamique de contenu - Anciennement les MACROS ) ) afin d'envoyer les valeurs représentatives à l'instant T de la notification liée à l'hôte supervisé.

Personnalisation

Faire le clone

Ce script Python notify_by_email.py peut utiliser un argument --SMTP ou -S qui permet alors de passer en paramètre l'IP ou l'adresse d'un serveur SMTP pour l'envoi de l'email. 

Admettons par exemple que votre serveur SMTP est le serveur 192.168.1.200, il suffit donc de rajouter l'information --SMTP 192.168.1.200 dans votre ligne de commande :

$NOTIFPLUGINDIR$/notify_by_email.py --title-tpl $NOTIFPLUGINDIR$/host_alert_title_template.tpl --content-tpl $NOTIFPLUGINDIR$/host_alert_content_template.tpl -F "$SENDER$" -r "$CONTACTEMAIL$" -n $NOTIFICATIONTYPE$ -H "$HOSTNAME$" --address "$HOSTADDRESS$" --url $MAILURL$ --huuid $_HOSTID$ --state $HOSTSTATE$ --last-state $LASTHOSTSTATEID$ --last-change $LASTHOSTSTATECHANGE$  --last-check "$DATE$ $TIME$" --output "$HOSTOUTPUT$" --long-output "$LONGHOSTOUTPUT$" --ack-author "$ACKAUTHOR$" --ack-data "$ACKDATA$" --SMTP 192.168.1.200

Troubleshooting

Tester votre commande

Si vous souhaitez envoyer une commande depuis votre Reactionner afin de vérifier le bon envoi de l'email, loguez-vous en shinken via :

su - shinken

Puis envoyer votre commande, par exemple : 

/var/lib/shinken/libexec/notifications/notify_by_email.py --title-tpl /var/lib/shinken/libexec/notifications/service_alert_title_template.tpl 
--content-tpl /var/lib/shinken/libexec/notifications/service_alert_content_template.tpl -F "ENVOYEUR@DOMAIN.COM" -r "RECEVEUR@DOMAIN.COM" -n 
PROBLEM -H "mon-serveur" --address "172.16.0.10" --url http://172.16.0.10:7767 --huuid 7b0513f631a011e889e9080027da5b5c --check "Memory" 
--state CRITICAL --last-state 0 --last-change 1525338011.76 --last-check "03-05-2018 11:00:56" --output 
"Critical : memory consumption is too high 66%" --long-output "" --ack-author "" --ack-data ""

Vous devriez alors recevoir :

DATE,426:INFO: Mail sent successfully

Et vous devriez recevoir l'email dans votre boite email.

Logs

Si vous avez des difficultés, veuillez vérifier les logs :

• Du Réactionner dans /var/log/shinken/
• De votre serveur mail linux (postfix/smtp) dans /var/log/maillog

Configuration avancée (relais SMTP)

Si votre serveur SMTP principal est un serveur connu et généralisé dans votre architecture, vous pouvez aussi modifier votre configuration afin de relayer n'importe quel email vers ce serveur :

• Editer le fichier /etc/postfix/main.cf
• Modifier la ligne avec l'IP de votre serveur SMTP (ici 192.168.1.240)  : relayhost = 192.168.1.240

• Redémarrer postfix

  Code Block
  service postfix restart

• Test d'envoi de mail :

  Code Block
  ls | mailx -s test d.labardin@shinkendom.local