Variables

Présentation

Une variable stocke une valeur de configuration non sensible en texte clair au sein d'un environnement. Les variables sont utiles pour les valeurs qui changent d'un environnement à l'autre mais qui ne sont pas confidentielles — comme les noms d'hôte, les numéros de port ou les URL de base.

En utilisant des variables, vous évitez de coder en dur les valeurs dans vos définitions de sondes. Lorsqu'une valeur change, mettez à jour la variable une seule fois et toutes les sondes qui la référencent récupèrent la modification lors de leur prochaine exécution.


Règles de nommage

Les clés de variables doivent contenir uniquement des lettres majuscules, des chiffres et des underscores.

Exemples : API_HOST, DB_PORT, BASE_URL_V2, SMTP_SERVER.


Créer une variable

  1. Accédez à Paramètres → Environnements et sélectionnez votre environnement.
  2. Dans la section Variables, cliquez sur Ajouter une variable.
  3. Saisissez une clé et une valeur.
  4. Enregistrez.

Chaque clé doit être unique au sein d'un environnement. La même clé peut exister dans différents environnements avec des valeurs différentes — c'est le cas d'usage prévu.


Utiliser une variable dans une sonde

Référencez une variable dans tout champ de sonde pris en charge en utilisant la syntaxe ${KEY}. Onagre résout les variables au moment de l'exécution, avant d'envoyer la configuration à l'agent.

https://${API_HOST}:${API_PORT}/health

Vous pouvez combiner plusieurs variables dans le même champ. Si une variable référencée n'existe pas dans l'environnement de la sonde, celle-ci signalera une erreur de configuration.

Exemples

Champ de la sonde Valeur avec variables
URL HTTP https://${API_HOST}/api/status
Requête SQL SELECT count(*) FROM ${TABLE_NAME}
Hôte du port ${INTERNAL_HOST}

Modifier ou supprimer une variable

  • Modifier : Cliquez sur la variable, mettez à jour la valeur et enregistrez. La nouvelle valeur prend effet lors de la prochaine exécution de la sonde.
  • Supprimer : Supprimez une variable lorsqu'elle n'est plus nécessaire. Assurez-vous qu'aucune sonde active ne la référence avant de la supprimer.

Variables vs. Secrets

Variables Secrets
Contenu Configuration non sensible Identifiants, chaînes de connexion
Stockage Texte clair Chiffré (AES-GCM 256 bits)
Visible dans l'interface Oui, toujours lisible Écriture seule, jamais affiché
Syntaxe ${KEY} dans les champs de sonde Sélectionné via le menu déroulant Entrypoint
Cas d'usage Noms d'hôte, ports, URL Mots de passe de base de données, clés API

Résumé

Aspect Détails
Format Paires clé-valeur, texte clair
Règles de clé Lettres majuscules, chiffres et underscores uniquement
Référence Syntaxe ${KEY} dans les champs de sonde
Portée Isolée par environnement
Résolution Au moment de l'exécution, avant transmission à l'agent