Script personnalise

Le canal Custom script execute un programme a vous sur la machine de l’Integrator quand une alerte se declenche : redemarrer un service, ouvrir un ticket dans un outil que Mugnsoft ne gere pas, appeler une API interne.

Comment il s’execute

Le champ Script

Le champ accepte un nom de fichier, eventuellement suivi d’arguments :

restart_shop.bat
notify.sh $status "$displayName"
open-ticket.ps1 -Severity $status -Monitor "$displayName"

• Le nom de fichier : lettres, chiffres, _ et -, au plus une extension, ni dossier ni chemin. Tout le reste est refuse et journalise invalid script name.
• Les arguments sont separes par des blancs ; "..." ou '...' gardent ensemble une valeur avec des espaces.
• Ces variables de substitution sont remplacees avant le lancement du script :

Ce que recoit le script

En plus de ses arguments, le script recoit l’alerte en variables d’environnement : meme un script lance sans argument sait quel moniteur l’a declenche.

Le reste de l’environnement est celui de l’Integrator. Une variable est vide quand l’information est inconnue.

Etape 1 : ecrire le script

Windows - un fichier .bat, .cmd, .exe ou .ps1. Un .ps1 est lance avec powershell.exe -NoProfile -NonInteractive -ExecutionPolicy Bypass -File.

# scripts\restart_shop.ps1 - redemarre le pool IIS de la boutique quand elle est en panne
if ($env:MNS_STATUS -ne "OK") {
    Import-Module WebAdministration
    Restart-WebAppPool -Name "shop"
}

Linux - tout executable avec une ligne shebang. Un fichier sans le bit d’execution est lance via /bin/sh.

#!/bin/sh
# scripts/notify.sh - transmet l'alerte a une API interne
curl -s -X POST https://ops.example.com/alerts \
  -d "monitor=$MNS_MONITOR" -d "status=$MNS_STATUS" -d "trigger=$MNS_TRIGGER"

Gardez-le court et idempotent : il peut s’executer a chaque controle (voir plus bas), et doit se terminer avant le delai.

Etape 2 : configurer Mugnsoft

Par defaut pour tous les moniteurs d’un Integrator - Integrator → General → Notifications → Custom script : activez On fail et/ou On change, et renseignez Default script et Timeout (s).

Par moniteur - moniteur → Actions → carte Custom script : activez le ou les declencheurs, et renseignez Script et Timeout (s), ou laissez Script vide pour lancer le script par defaut de l’Integrator (avec le delai du defaut).

Enregistrez les deux formulaires avec l’icone disquette.

A quelle frequence il s’execute

Une fois par alerte, comme tout autre canal :

• On fail avec for 0 checks : a chaque controle tant que le moniteur est en echec. Pour un script de remediation, reglez la regle sur for 1 check pour qu’il ne s’execute qu’une fois par episode d’echec.
• On change : a chaque changement de statut - y compris le retour a OK (MNS_STATUS=OK). Testez le statut dans le script s’il ne doit agir que sur les echecs.

Voir ON FAIL et ON CHANGE.

Tester

1. Depuis Mugnsoft : dans le bloc Notifications de l’Integrator, cliquez sur ⚡ sur la carte Custom script. L’Integrator lance le script indique dans le champ (ou son defaut enregistre) avec MNS_TRIGGER=test et MNS_STATUS=TEST, et renvoie le code de sortie. Le script s’execute reellement : faites-lui ignorer MNS_TRIGGER=test s’il ne doit pas agir.
2. A la main : executez-le sur la machine de l’Integrator, sous le compte de service de l’Integrator, depuis le dossier scripts, avec les variables ci-dessus definies.
3. De bout en bout : passez le niveau de journal de l’Integrator en debug, activez le script pour le moniteur de test, et cherchez cette ligne dans log/integrator.log :

handleNotifications - [url_notif-test_probe-paris] - actionOnSC outCmd: ..., errCmd: ..., exitCode: 0

Depannage

Plus d’elements dans Depannage.

Traductions

• en: Custom script