Page History

Contexte

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

• 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 ( méthode de notification ou commande ) livré par un pack Shinken pour un besoin spécifique,
  • il est important de créer la vôtre,
  • car à la prochaine mise à jour de Shinken vous proposera de remplacer vos modifications.

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 pour les notifications

Création d'une commande

Corps de la commande

Les commandes sont exécutées par le Reactionner ( voir la page Le Reactionner ) lorsque les conditions définies par la Logique de notification sont  sont réunies.Elles ont accès spécifiquement à un certain nombre de notations de remplacement dynamique de contenu

• Il est possible d'utiliser des Variables pour avoir accès aux informations des éléments ( voir la page

• Les Variables ( Remplacement dynamique de contenu - Anciennement les

• Macros ) ).
• Ces

• informations concernant Hôtes, Clusters, Check, Utilisateurs 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.

Voir un listing NON exhaustif des informations qui peuvent être pertinents dans une notification, mais la pageLes Variables ( Remplacement dynamique de contenu - Anciennement les Macros ), vous donne la liste complète de ce qui est accessible.

Variables globales

Vous pouvez utiliser dans votre commande des Variables globales.

• L'intérêt est d'avoir des informations fixes pour toutes vos commandes de notification.
• Nous vous conseillons de rajouter dans le répertoire /etc/shinken/resource.d votre fichier de définition de variable globale ( Voir la page Données globales ( Répertoire resource.d ) ).
• Pour information, les variables globales suivantes sont disponibles, pour inspiration, dans les notifications livrées par défaut.

Variables liées à l'élément

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

• Dans le cas d'une notification d'un check, les variables l'hôte et du check sont toutes les deux disponibles.
• De la même façon que les variables globales, toutes les variables des éléments peuvent être utilisées, mais les variables suivantes sont spécifiquement utiles :

Variables liées au contact

Variables liées à la notification

Des 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

Partir

d'une

méthode 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).

Information sur la commande 

existante

Pour une première commande de notification, vous pouvez vous aussi duppliquer une commande existante et la modifier.

• La page Créer/Cloner des commandes de notification MAIL ( basé sur le script SHINKEN notify_by_email.py ) vous en détaille un exemple.

Personnalisation

Faire le clone

Pour faire un clone d'une commande livré par Shinken, il y a plusieurs étapes à suivre qui sont expliqué dans la page Personnaliser une commande livrée par un pack Shinken

Utilisation de la commande --help du script

Il vous est possible d'afficher l'aide du script, apportant des précisions concernant chaque option prise en charge par ce dernier, en tapant :

/var/lib/shinken/libexec/notifications/notify_by_email.py --help

Modification de la Ligne de commande

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 ( 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$" --SMTP 192.168.1.200

Option absent de ligne de commande

Certaines options sont optionnelles. Si elles ne sont pas renseignées, alors les parties correspondantes des mails pourront être cachés

Par exemple, pour la commande suivante, 

$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$ 

le mail ressemblera à :

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 Blockls | mailx -s test mon.mail@shinkendom.local