Les notifications standard d’AlertManager peuvent manquer de clarté et de pertinence pour les équipes.
Des notifications peu claires peuvent entraîner des retards dans la réponse aux incidents critiques.
Cet article explore comment personnaliser les notifications d’AlertManager en utilisant des templates, afin de fournir des alertes plus informatives et adaptées.
Devenez expert dans la supervision d'infrastructures avec Prometheus.
La personnalisation des notifications permet d’adapter le contenu des messages envoyés par AlertManager en fonction des besoins opérationnels ou des préférences des équipes. Cela se fait via l’utilisation de templates, qui définissent la mise en forme et les informations à inclure dans chaque notification.
Template Notification AlertManager
Les templates dans AlertManager sont des fichiers de configuration écrits au format Go Templates. Ils permettent de :
- Personnaliser le contenu :Ajouter des informations spécifiques comme le statut, l’instance, ou tout autre détail pertinent.
- Modifier la présentation :Structurer les notifications avec des balises HTML pour un rendu plus lisible.
- Réutiliser des modèles :Créer des templates communs pour plusieurs types de notifications, facilitant leur gestion et leur mise à jour.
Créer un Template AlertManager
La création d’un template est une étape essentielle pour adapter les notifications aux besoins spécifiques des équipes. Elle permet de standardiser le contenu, de le rendre plus lisible grâce à l’utilisation de balises HTML, et d’inclure des informations pertinentes pour un diagnostic rapide des alertes. Un bon template améliore la réactivité et la compréhension des messages envoyés.
Pour créer un template de notification :
Ouvrez un éditeur de texte avec la commande suivante :
sudo vi /etc/prometheus/alertmanager_templates/demo.tmpl
Ajoutez le contenu suivant, en modifiant si nécessaire pour répondre aux besoins spécifiques de votre équipe :
{{ define "email.demo.html" }}
<html>
<head>
<title>Alerte !</title>
<style id="wpr-lazyload-bg-container"></style><style id="wpr-lazyload-bg-exclusion"></style>
<noscript>
<style id="wpr-lazyload-bg-nostyle">.jet-image-accordion__item-loader span{--wpr-bg-fe095fae-0595-42be-b824-88a7fb218f7c: url('https://blog.alphorm.com/wp-content/plugins/jet-tabs/assets/images/spinner-32.svg');}.rll-youtube-player .play{--wpr-bg-edeb48ff-0e79-4709-a8b2-8bd9d59ccfe5: url('https://blog.alphorm.com/wp-content/plugins/wp-rocket/assets/img/youtube.png');}</style>
</noscript>
<script type="application/javascript">const rocket_pairs = [{"selector":".jet-image-accordion__item-loader span","style":".jet-image-accordion__item-loader span{--wpr-bg-fe095fae-0595-42be-b824-88a7fb218f7c: url('https:\/\/blog.alphorm.com\/wp-content\/plugins\/jet-tabs\/assets\/images\/spinner-32.svg');}","hash":"fe095fae-0595-42be-b824-88a7fb218f7c","url":"https:\/\/blog.alphorm.com\/wp-content\/plugins\/jet-tabs\/assets\/images\/spinner-32.svg"},{"selector":".rll-youtube-player .play","style":".rll-youtube-player .play{--wpr-bg-edeb48ff-0e79-4709-a8b2-8bd9d59ccfe5: url('https:\/\/blog.alphorm.com\/wp-content\/plugins\/wp-rocket\/assets\/img\/youtube.png');}","hash":"edeb48ff-0e79-4709-a8b2-8bd9d59ccfe5","url":"https:\/\/blog.alphorm.com\/wp-content\/plugins\/wp-rocket\/assets\/img\/youtube.png"}]; const rocket_excluded_pairs = [];</script></head>
<body>
<h1>{{ .CommonAnnotations.title }}</h1>
<p>
<b>Alert</b>: {{ .CommonLabels.alertname }}<br />
<b>Status</b>: {{ .status }}<br />
<b>Job</b>: {{ .CommonLabels.job }}<br />
<b>Instance</b>: {{ .CommonLabels.instance }}<br />
</p>
<script>class RocketElementorAnimation{constructor(){this.deviceMode=document.createElement("span"),this.deviceMode.id="elementor-device-mode-wpr",this.deviceMode.setAttribute("class","elementor-screen-only"),document.body.appendChild(this.deviceMode)}_detectAnimations(){let t=getComputedStyle(this.deviceMode,":after").content.replace(/"/g,"");this.animationSettingKeys=this._listAnimationSettingsKeys(t),document.querySelectorAll(".elementor-invisible[data-settings]").forEach(t=>{const e=t.getBoundingClientRect();if(e.bottom>=0&&e.top<=window.innerHeight)try{this._animateElement(t)}catch(t){}})}_animateElement(t){const e=JSON.parse(t.dataset.settings),i=e._animation_delay||e.animation_delay||0,n=e[this.animationSettingKeys.find(t=>e[t])];if("none"===n)return void t.classList.remove("elementor-invisible");t.classList.remove(n),this.currentAnimation&&t.classList.remove(this.currentAnimation),this.currentAnimation=n;let s=setTimeout(()=>{t.classList.remove("elementor-invisible"),t.classList.add("animated",n),this._removeAnimationSettings(t,e)},i);window.addEventListener("rocket-startLoading",function(){clearTimeout(s)})}_listAnimationSettingsKeys(t="mobile"){const e=[""];switch(t){case"mobile":e.unshift("_mobile");case"tablet":e.unshift("_tablet");case"desktop":e.unshift("_desktop")}const i=[];return["animation","_animation"].forEach(t=>{e.forEach(e=>{i.push(t+e)})}),i}_removeAnimationSettings(t,e){this._listAnimationSettingsKeys().forEach(t=>delete e[t]),t.dataset.settings=JSON.stringify(e)}static run(){const t=new RocketElementorAnimation;requestAnimationFrame(t._detectAnimations.bind(t))}}document.addEventListener("DOMContentLoaded",RocketElementorAnimation.run);</script></body>
</html>
{{ end }}
Ce template définit un email formaté en HTML, contenant le titre de l’alerte, son statut, le job, et l’instance associée.
Associer Template à AlertManager
Cette étape permet de lier le template personnalisé au fichier de configuration d’AlertManager, garantissant que les notifications envoyées respectent le format défini.
- Modifiez le fichier alertmanager.yml pour intégrer le template :
sudo vi /etc/prometheus/alertmanager.yml
- Ajoutez ou modifiez la sectionreceiverscomme suit :
receivers:
- name: 'team-X-mails'
email_configs:
- to: 'team-X+alerts@example.org'
html: '{{ template "email.demo.html" . }}'
Valider Configuration AlertManager
La validation de la configuration garantit que les modifications apportées au fichier d’AlertManager sont correctement prises en compte et fonctionnelles. Elle permet également d’éviter toute erreur potentielle avant le redémarrage du service, assurant ainsi une intégration fluide du template personnalisé.
Testez le fichier de configuration pour détecter d’éventuelles erreurs avec la commande suivante :
amtool check-config /etc/prometheus/alertmanager.yml
Si tout est correct, un message de validation s’affichera :
Redémarrez le service AlertManager pour appliquer les modifications :
sudo systemctl restart prometheus-alertmanager.service
Vérifiez que le service est en cours d’exécution :
sudo systemctl status prometheus-alertmanager.service
Le statut Running confirme que le service fonctionne correctement.
Résultats Notifications Inbucket
Après la configuration, simulez une alerte et vérifiez le résultat dans Inbucket (accessible via
http://localhost:9000).
Un email contenant les informations définies dans le template sera affiché, avec un rendu formaté comme dans votre template.
La personnalisation des notifications offre une meilleure lisibilité et une adaptation aux besoins spécifiques de votre organisation, ce qui facilite la prise de décision rapide en cas d’incident. En créant des messages clairs et informatifs, elle renforce la réactivité des équipes tout en garantissant une communication adaptée à chaque contexte opérationnel. Cette approche améliore également la gestion des alertes en permettant de prioriser efficacement les actions à entreprendre.
Formez-vous gratuitement avec Alphorm !
Maîtrisez les compétences clés en IT grâce à nos formations gratuites et accélérez votre carrière dès aujourd'hui.
FAQ
Comment personnaliser les notifications dans AlertManager ?
Qu'est-ce qu'un template de notification dans AlertManager ?
Comment créer un template de notification pour AlertManager ?
Comment valider la configuration d'un template dans AlertManager ?
Quels sont les avantages de la personnalisation des notifications AlertManager ?
Conclusion
La personnalisation des notifications via AlertManager peut considérablement améliorer la gestion des alertes. Comment votre organisation pourrait-elle bénéficier de notifications personnalisées pour une meilleure réactivité ?
