Contexte

Shinken utilise Jinja 2.7.2, un outil de templating, pour la mise en forme des notifications par mail.

Il permet facilement de concevoir un mail dynamique en fonction de vos besoins.

Bonnes pratiques

Faites une copie des templates utilisés par les commandes de notification qui vous ont été fournies lors de l'installation.

Cloner et éditer les commandes de notification par mail

Nous vous proposons plusieurs commandes de démonstration, pour vous permettre personnaliser vos notifications ( voir les pages NEW_PAGE - 003.5.6 - SEF-11240 - SHINKEN EXAMPLE [ email-with-thresholds ] - Méthode de notification, NEW_PAGE - 003.5.6 - SEF-11240 - email-with-images - Méthode de notification et NEW_PAGE - 003.5.6 - SEF-11240 - email - Méthode de notification )

Utilisation de Jinja

Le template utilisé par les commandes de pack Shinken utilise toutes les données dynamiques utilisables au sein des templates. Le template génère le mail au format HTML, pour des raisons de mise en page.

Les données dynamiques peuvent être intégrées facilement au contenu généré.

Il vous est possible de soumettre à conditions l'intégration dans le mail, de certaines parties du template.

    {% if shinken_var['my_var'] %}
        <!-- Ce code ne sera pris en compte que si la donnée shinken_var['my_var'] existe et est renseignée ->

        {{ shinken_var['my_var'] }} <!-- sera remplacé dans le mail, par le contenu de shinken_var['my_var'] ->
    {% endif %}

Il sera possible d'utiliser des boucles "for" pour créer un élément HTML à partir d'une liste ou d'objet, ou même d'attribué dynamiquement des classes à des éléments.

Documentation de Jinja

Vous pouvez trouvez toutes les informations concernant l'outil de templating Jinja à l'adresse suivante : Jinja Documentation.

Cependant, la documentation de la version utilisée par Shinken n'est plus édité, il se peut que quelques différences soient présentes avec la version que vous utiliserez.

L'utilisation du HTML et du CSS dans les mails.

En plus du template, certaines propriétés comme l'affichage des seuils permettent d'afficher des informations complexes et sous différents formats. Il sera alors possible d'intégrer ces informations dans les notifications par mails.

Il faudra prendre en compte les informations suivantes concernant l'utilisation du HTML et CSS dans vos notifications.

HTML

CSS

Les logiciels mails ( Thunderbird, Outlook, Spark, ... ) et les services de mails web ( gmail, outlook ) n'interprètent pas les balises de la même manière, voir certaines balises sont interprétées chez certains et pas chez d'autres.

Si vous souhaitez intégrer du HTML et du CSS dans les notifications mail, nous vous conseillons fortement d'identifier les clients mails qui le liront et de consulter le site Can I Email ( voir la page Can I Email ) qui est une source d'information fiable sur la prise en charge des balises web par les principaux clients mails du marché.

Shinken et le HTML/CSS

D'autres balises HTML sont interdites par Shinken pour des motifs de sécurité. Elles seront sauvegardées, mais ne seront ni interprétée, ni transmise lors des notifications.

Il s'agit des balises Script, d'image, d'input ou d'iframe. Bien que très utile, elles permettent trop de dérives pour être autorisées à passer dans le système.

Il sera possible d'intégrer ces éléments directement par le template mail, mais ils ne pourront être dynamiques en fonction de vos hôtes et/ou checks.

Variables dynamiques

Vous pouvez intégrer des variables dynamiques à l'HTML, elles seront interprétées par le système et vous permettent d'afficher des données précises ( voir la page LES VARIABLES ( Remplacement dynamique de contenu - Anciennement les MACROS ) )

Vous pouvez mettre un lien vers la page Shinken de votre hôte, ou pointer vers une donnée que vous aurez configurée.

Exemple

Exemple de HTML/CSS pris en charge par les notifications