Créer son premier check
Introduction
Section titled “Introduction”Un check Gward est entièrement piloté par un script. Aucun SDK propriétaire n’est requis : vous écrivez la logique métier dans le langage de votre choix, et Gward exécute ce script localement sur l’agent.
Prérequis
Section titled “Prérequis”- Un agent Gward connecté à la plateforme
- Un script de supervision prêt
Étapes
Section titled “Étapes”1. Accéder à la création de check
Section titled “1. Accéder à la création de check”Depuis la plateforme, rendez-vous dans Checks > Nouveau check.
2. Renseigner les informations générales
Section titled “2. Renseigner les informations générales”Dans l’onglet Général :
- Nom : identifiant lisible du check (ex:
disk-usage-check) - Description : contexte du check
- Activé : toggle pour activer ou désactiver le check
- Plateformes : cochez au moins une plateforme cible (
linux,windows,macos)
3. Configurer le schedule
Section titled “3. Configurer le schedule”Dans l’onglet Schedule, définissez la fréquence d’exécution :
- Intervalle (s) : exécution toutes les N secondes (minimum 1)
- Jitter (s) : délai aléatoire ajouté pour éviter les pics de charge simultanés sur plusieurs agents
- Cron (optionnel) : expression cron pour des planifications précises (ex:
0 * * * *)
Au moins un des deux champs interval_seconds ou cron doit être renseigné.
4. Écrire le script et configurer la condition de succès
Section titled “4. Écrire le script et configurer la condition de succès”Dans l’onglet Check :
- Script : collez votre script de supervision
#!/bin/bashdf -h / | tail -1 | awk '{print $5}' | tr -d '%'- Timeout (s) : durée maximale d’exécution avant échec forcé
- Succès si : condition sur la sortie du script
| Opérateur | Exemple | Description |
|---|---|---|
== |
stdout == "0" |
Égalité stricte |
!= |
stdout != "error" |
Différence |
contains |
stdout contains "OK" |
La sortie contient la valeur |
not_contains |
stdout not_contains "FAIL" |
La sortie ne contient pas la valeur |
> |
stdout > "0" |
Supérieur à (numérique) |
< |
stdout < "90" |
Inférieur à (numérique) |
5. Configurer l’alerting (optionnel)
Section titled “5. Configurer l’alerting (optionnel)”Dans l’onglet Alerte, activez le toggle Alerte pour déclencher des alertes automatiques.
Une fois activé, renseignez :
- Condition de déclenchement : opérateur + valeur (peut différer de la condition de succès)
- Criticité :
info,low,medium,highoucritical - Message : description de l’alerte affichée dans la plateforme
- Nombre d’échecs consécutifs avant ouverture (
failure_threshold) : évite les faux positifs en n’ouvrant l’alerte qu’après N échecs consécutifs (par défaut : 1)
6. Sélectionner les agents cibles
Section titled “6. Sélectionner les agents cibles”Dans l’onglet Agents, sélectionnez les agents sur lesquels le check sera déployé via la grille de cartes. Vous pouvez rechercher par nom, filtrer par catégorie et tout sélectionner en une action.
7. Ajouter des entrées de contexte (optionnel)
Section titled “7. Ajouter des entrées de contexte (optionnel)”Dans l’onglet Contexte, ajoutez des scripts complémentaires exécutés au moment d’un incident. Leur résultat est capturé et conservé avec l’impact pour faciliter le diagnostic.
Exemple d’entrée :
- Label :
État du service - Script :
systemctl is-active nginx
Résultat attendu
Section titled “Résultat attendu”Le check apparaît dans la liste, s’exécute selon le schedule configuré et remonte ses résultats avec l’historique complet. Si l’alerting est activé, une alerte est ouverte automatiquement dès que le failure_threshold est atteint.