Options d'un check

Introduction

Cette page liste l’ensemble des paramètres disponibles lors de la création ou modification d’un check Gward. Le formulaire est organisé en onglets : Général, Fréquence, Commande, Valeur conservée, Alerte, Remédiation, Contexte d’alerte, Agents ciblés et Notification Teams.

Onglet Général

Paramètre	Type	Description
name	string	Nom du check (minimum 2 caractères), affiché dans la plateforme
description	string	Description du check
enabled	boolean	Active ou désactive le check
platforms	checkbox	Plateformes cibles : linux, windows, macos (au moins une requise)

Note

La problem_key est générée automatiquement par le système et affichée en lecture seule sur les checks existants. Elle ne peut pas être modifiée manuellement.

Onglet Fréquence

Paramètre	Type	Description
interval_seconds	integer	Intervalle d’exécution en secondes (minimum : 1)
jitter_seconds	integer	Délai aléatoire ajouté à chaque exécution pour éviter les pics de charge (≥ 0)
cron	string	Expression cron optionnelle (ex: 0 * * * *). Alternative ou complément à interval_seconds

Note

Au moins un des champs interval_seconds ou cron doit être renseigné.

Onglet Commande

Paramètre	Type	Description
type	string	Type de check : actuellement command uniquement
timeout_seconds	integer	Durée maximale d’exécution du script avant échec forcé (≥ 1)
script	string	Script exécuté localement sur l’agent

Condition de succès (success_if)

Le champ success_if définit la condition qui détermine si le check est en succès. Il est obligatoire : tout check rend un verdict. Pour un check qui sert surtout à relever une valeur, la condition minimale est « la sortie n’est pas vide » : matches avec \S.

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 < "100"	Inférieur à (numérique)
matches	stdout matches "(?i)error"	La sortie correspond à l’expression régulière (recherche partielle ; ancrer avec ^…$ pour une correspondance complète)

Note

Les expressions régulières sont évaluées par l’agent, avec la syntaxe RE2. Les assertions ((?=…), (?<!…)) et les références arrière (\1) n’y existent pas : une expression qui les utilise est refusée à l’enregistrement.

Onglet Valeur conservée

L’onglet Valeur conservée décide si le résultat du check est conservé dans le temps. Désactivé, la valeur sert au verdict puis est jetée.

Paramètre	Type	Description
valeur.nature	enum	etat (la valeur actuelle et depuis quand) ou metrique (l’évolution)
valeur.type	enum	texte, nombre, pourcentage, booleen, ip, date, json
valeur.unite	string	Libellé d’axe : %, ms, GB, °C. Optionnel
valeur.historise	boolean	Régime etat uniquement : conserver les valeurs passées
valeur.retention_jours	integer	Obligatoire dès qu’un historique est conservé

Note

La nature ne se déduit pas du type : « nombre de cœurs CPU » et « nombre de connexions actives » sont tous deux des nombres, mais le premier est un état et le second une métrique. Elle n’est plus modifiable une fois des valeurs collectées.

Le détail d’usage est décrit dans Conserver et grapher la valeur d’un check.

Onglet Alerte

L’alerting s’active via le toggle Alerte. Une fois activé, les champs suivants sont disponibles :

Paramètre	Type	Description
alert.enabled	boolean	Active ou désactive l’alerting pour ce check
alert.condition.operator	string	Opérateur de déclenchement de l’alerte (mêmes opérateurs que success_if)
alert.condition.value	string	Valeur seuil de déclenchement
alert.severity	enum	Criticité de l’alerte : info, low, medium, high, critical
alert.message	string	Message descriptif de l’alerte (requis si alerting activé)
alert.failure_threshold	integer	Nombre d’échecs consécutifs avant ouverture de l’alerte (≥ 1, par défaut : 1)

Note

La condition alert.condition est distincte de success_if. Elle définit quand déclencher l’alerte, indépendamment de la condition de succès du check.

Onglet Remédiation

L’auto-remédiation s’active via le toggle Remédiation. Une fois activée :

Paramètre	Type	Description
remediation.condition.operator	string	Condition de déclenchement de la remédiation
remediation.condition.value	string	Valeur seuil de déclenchement
remediation.max_attempts	integer	Nombre maximum de tentatives de remédiation
steps[].name	string	Nom de l’étape
steps[].script	string	Script exécuté lors de l’étape
steps[].timeout_seconds	integer	Timeout de l’étape (≥ 1)
steps[].on_failure	enum	Comportement en cas d’échec : continue ou stop

Onglet Contexte d’alerte

L’onglet Contexte d’alerte permet d’ajouter des scripts complémentaires exécutés au moment d’un impact. Leur résultat est capturé et conservé pour faciliter le diagnostic.

Chaque entrée de contexte contient :

Champ	Description
label	Nom de l’entrée (ex: État du service, Logs nginx)
script	Script exécuté pour capturer les informations (ex: systemctl is-active nginx)

Onglet Agents ciblés

L’onglet Agents ciblés décide sur quels agents le check s’exécute. Trois modes de ciblage sont proposés :

Mode	Agents ciblés	Agents enrôlés plus tard
Sélection manuelle	Les agents cochés, et eux seuls	Non ciblés : à ajouter à la main
Tous les agents	Tout le parc	Ciblés automatiquement
Par filtre	Les agents qui correspondent au filtre	Ciblés automatiquement s’ils correspondent

Sélection manuelle

Les agents s’affichent en grille de cartes : cochez ceux qui doivent exécuter le check. La recherche par nom, le filtre des agents et le bouton Tout sélectionner facilitent la sélection, et Afficher uniquement les sélectionnés permet de la relire avant d’enregistrer.

Tous les agents

Le check s’exécute sur l’ensemble du parc, y compris sur les agents enrôlés après sa création : un nouvel agent le reçoit dès son enrôlement. C’est le mode adapté aux contrôles universels (espace disque, synchronisation de l’horloge, version de l’agent).

Par filtre

Le check cible les agents qui correspondent à un filtre, combinant :

• une catégorie ;
• des valeurs de labels dynamiques, chacune avec son mode :

Mode	Signification
OR	L’agent possède au moins une des valeurs en OR
AND	L’agent doit posséder cette valeur
NOT	L’agent ne doit pas posséder cette valeur

Par exemple, production en AND, Ubuntu 22.04 et Ubuntu 24.04 en OR, et recette en NOT ciblent les agents de production sous Ubuntu, hors recette. Au moins une catégorie ou une valeur de label est requise.

La liste suit le parc. Un agent qui entre dans le filtre reçoit le check, un agent qui en sort le perd, sans repasser sur le check. L’affectation est recalculée :

• à l’enregistrement du check ;
• à l’enrôlement d’un agent et à la modification de ses catégories ;
• quand les valeurs de labels remontées par un agent changent ;
• quand une catégorie ou un label est modifié ou supprimé.

L’onglet affiche les agents ciblés aujourd’hui et leur nombre. Avec un ciblage par règle (Tous les agents ou Par filtre), cette liste est calculée : elle se consulte, mais ne se coche pas.

Note

Sur la page d’un agent, un check reçu par une règle est signalé par un badge Tous les agents ou Par filtre. Il ne se retire pas depuis l’agent : il faut modifier la règle du check, ou les labels et catégories de l’agent.

Tip

Un même filtre s’utilise partout dans Gward : les modes OR, AND et NOT sont ceux du filtre Labels & catégories des écrans Agents, Santé et Timeline. Construisez votre filtre sur l’écran Agents pour vérifier qui il retient, puis reportez-le sur le check.

Onglet Notification Teams

Paramètre	Type	Description
webhookTeamsLink	URL	Webhook Microsoft Teams (optionnel). Envoie une notification lors de la création d’une alerte, de l’ajout d’un agent impacté ou de la résolution d’un impact

Pour aller plus loin

• Créer son premier check
• Utiliser les labels dynamiques
• Cycle de vie des alertes