Notification on Zwindler's Reflection

Configurer l’envoi de notification email et RSS dans XWiki

Thu, 04 Aug 2016 18:00:49 +0000

Notifications (RSS et email) dans XWiki

Disponible nativement pratiquement depuis les toutes premières versions de XWiki (introduit autour de la 1.3), les utilisateurs peuvent être notifiés lors de la modification des pages auxquels ils se sont abonnés.

L’abonnement est géré de façon automatique via une politique qui est définie par défaut ou modifiée par l’utilisateur lui même.

A partir de cette liste des abonnements, l’utilisateur peut également définir la manière dont il souhaite être notifié : soit via un flux RSS des pages favorites, soit via un email contenant un export de type diff des pages modifiées.04

Ce tutoriel a pour but de vous donner les étapes pour configurer ces notifications de bout en bout.

Configurer le serveur de mail

Si vous souhaitez utiliser la notification par email, la première chose est bien entendu de configurer votre serveur pour l’envoi d’email ou de renseigner dans l’application un serveur SMTP qui pourra faire le relais. Tout se gère dans le menu d’administration du XWiki.

Configurer les alertes par email (désactivé par défaut)

Ensuite, côté utilisateur, il faut configurer son compte pour recevoir des emails lors de modification de pages favorites. Se connecter au Wiki et ouvrir la page des préférences de l’utilisateur (située en haut à droite de l’écran).

On arrive alors sur les préférences de l’utilisateur. Cliquer sur le menu « Favoris » puis sur le crayon pour éditer les préférences actuelles.

Sélectionner dans le menu déroulant la fréquence d’envoi d’email souhaitée.

Ne pas oublier de valider avec Enregistrer en bas du formulaire.

Les nouveaux paramètres sont pris en compte.

Remarque : on peut également s’abonner au flux RSS sur cette même page :

Je trouve la mise en page à la mode flux RSS plus plaisante car on a juste des liens vers les pages modifiées. Le diff est complexe à lire dans les notifications email.

Sélection des pages « favorites »

Pour rappel, la plupart des fonctionnalités de votre XWiki sont gérées par des applications. Celle qui gère les pages favorites (notion d’abonnement) est l’application Watchlist.

Les pages favorites sont sélectionnées automatiquement par XWiki si vous avez laissé les valeurs par défaut. Toutes les pages créées et auquel vous aurez contribué en tant qu’utilisateur seront automatiquement inscrites dans vos pages favorites.

Dans le cas où vous souhaiteriez en ajouter de nouvelles, vous pouvez le faire manuellement en cliquant sur le bouton en forme de cloche en haut à droite à côté de votre avatar de connexion.

Une fois la page favorite sélectionnée, on clique sur le bouton en forme de cloche, puis on sélectionne si on souhaite ne s’abonner qu’à cette page (premier bouton), à cette page et ses fils (second bouton) ou à tout le wiki dans sa globalité.

Dans le cas où l’on souhaite disposer de la liste des pages auxquelles on est abonné, il est possible d’en avoir la liste et si nécessaire d’en supprimer dans le menu des préférences utilisateur.

Bonus : le planificateur de tâches

Petit bonus, lorsque j’ai fais les tests de notifications, je n’ai pas voulu attendre l’heure passée pour recevoir l’email ;-). J’ai donc été voir du côté du Scheduler, le planificateur de traitements interne au XWiki.

On peut couper/relancer ou même forcer le déclenchement des traitements de l’application WatchList (et des autres !).

Enregistrer

Piloter Nagios (API) à travers le nagios.cmd

Thu, 21 Jul 2016 12:00:55 +0000

I command thee, Nagios

Pas la peine de vous faire l’affront de vous présenter Nagios ! Si vous tombez sur cet article, c’est probablement que vous connaissez déjà l’outil et que vous cherchez juste à automatiser des tâches à l’aide d’une API ou d’un CLI pour étendre les fonctionnalités par défaut.

Car au delà de la configuration manuelle par fichier de configuration (ou via une interface web si vous utilisez Centreon par exemple), et l’interface web, il y a peu de moyens pour interagir avec Nagios.

Par manque de documentation, je me souviens avoir notamment galéré pour récupérer des statistiques de santé de Nagios. Alors qu’en fait il existe un binaire nagiostats ! Même s’il n’est pas forcément super facilement exploitable, c’est quand même un bon début…

Et donc, même si ce n’est pas du tout mis en avant par Nagios, OUI, il existe une méthode pour interagir avec le processus Nagios via des lignes de commandes. Mais je vous préviens tout de suite, il va falloir fouiller les docs archivées !

Petite explication de la façon dont Nagios fonctionne

Nagios est une application monolithique écrite en C. L’interface graphique de Nagios est présentée par un serveur web apache à l’aide de scripts CGI. Je ne sais pas si le fait que l’interface de Nagios soit si … « austère » (qui à dit « moche » ?) est une limitation liée aux choix technologique ou un réel choix ergonomique.

Troll à part, il faut comprendre que par défaut, il n’y a pas de méthode native pour faire communiquer Apache et l’application en C. La méthode la plus simple sous Unix consiste alors à passer par un fichier particulier : un pipe nommé. Sans rentrer dans les détails techniques :

L’utilisateur clique sur un lien lié à une action (comme acquitter une alerte)
D’un côté, le script CGI écrit des commandes dans ce fichier fictif qu’est le pipe nommé
De l’autre, au lieu que les commandes soient écrites sur disques, elles sont envoyées directement dans le processus Nagios qui les interprété.

Eurêka, j’ai trouvé mon premier exemple !

A partir de là, on a trouvé la solution. Il est donc possible d’émuler le comportement de la GUI pour réaliser des actions en ligne de commande. Il suffit d’écrite dans le pipe nommé la bonne commande.

Forcément, on est par contre limité aux actions qu’on pourrait faire via la GUI. Typiquement, vous ne pourrez pas faire un script pour ajouter des hôtes à chaud. Ce type d’actions ne sont possibles qu’en modifiant la configuration texte, pas de miracle…

Ça peut quand même être très utile. En astreinte, des administrateurs (rebelles) désactivaient les notifications des services qui les dérangeaient… Les fourbes ! Voilà un petit script pour réactiver tous les mardi matin les alertes appartenant au groupe de services « Services en astreinte ».

#!/bin/bash
#Script permettant de reactiver les notifications Nagios des services du groupe
#"Service_en_Astreinte" au cas ou elles auraient ete desactivees
################################################################################
now=`date +%s`
COMMANDFILE='/usr/local/nagios/var/rw/nagios.cmd'
SERVICEGROUP='Services_en_Astreinte'
/usr/bin/printf "[%lu] ENABLE_SERVICEGROUP_SVC_NOTIFICATIONS;$SERVICEGROUP\n" $now > $COMMANDFILE

Et un petit cron

# Reinitialisation des notifications sur le groupe Service_en_astreinte (le mardi en HO)
30 10 * * 2 /scripts/reset_production_notifications.sh

Pour trouver la liste des commandes disponibles, vous pouvez soit cliquer sur tous les boutons de l’interface graphique tout en surveillant le nagios.log (c’est comme ça que j’ai trouvé mes premières commandes ;-)), soit fouiller le site de Nagios pour retrouver les archives de la v2.

old.nagios.org/developerinfo/externalcommands/commandlist.php

Deuxième exemple

En fouillant le site, je suis tombé sur une autre commande qui m’a paru très utile. Après avoir installé un nouveau site, j’ai voulu vérifier que l’envoi des notifications fonctionnaient bien sur les services important. Pour le tester, j’aurai pu créer un service à positionner exprès en CRITICAL. Cependant je préfère cette solution qui se base sur la commande SEND_CUSTOM_SVC_NOTIFICATION.

SEND_CUSTOM_SVC_NOTIFICATION

Command Format:

SEND_CUSTOM_SVC_NOTIFICATION;;;;;

Description:

Allows you to send a custom service notification. Very useful in dire situations, emergencies or to communicate with all admins that are responsible for a particular service. When the service notification is sent out, the $NOTIFICATIONTYPE$ macro will be set to « CUSTOM ». The field is a logical OR of the following integer values that affect aspects of the notification that are sent out: 0 = No option (default), 1 = Broadcast (send notification to all normal and all escalated contacts for the service), 2 = Forced (notification is sent out regardless of current time, whether or not notifications are enabled, etc.), 4 = Increment current notification # for the service(this is not done by default for custom notifications). The comment field can be used with the $NOTIFICATIONCOMMENT$ macro in notification commands.

Et le script qui va avec :

#!/bin/sh
now=`date +%s`
commandfile='/usr/local/nagios/var/rw/nagios.cmd'
/usr/bin/printf "[%lu] SEND_CUSTOM_SVC_NOTIFICATION;SERVER1;/var;0;Test_notifier;Petit coucou de la part de ma nouvelle installation!\n" $now > $commandfile

Avec ce petit script, j’ai bien reçu ma notification de la part du service /var de SERVER1 !

Il y a bien sûr plein d’autres scripts qu’on peut imaginer, avec les actions sur les acquittements, les commentaires, les rechecks, les actions externes, … Je vous laisse y penser !