Sonde XML
Vue d'ensemble
La Sonde XML d'Onagre vous permet de surveiller et de valider les réponses XML d'un endpoint HTTP. Elle s'assure que des éléments ou attributs spécifiques contiennent les valeurs attendues, aidant les équipes à vérifier l'exactitude des réponses d'API et à détecter les modifications inattendues dans les données structurées.
Options de configuration
Lors de la mise en place d'une Sonde XML, les paramètres suivants peuvent être configurés :
- URL : L'endpoint cible retournant des données XML.
- Méthode HTTP : La méthode de requête à utiliser (GET, POST, etc.).
- Corps de requête (optionnel) : Données à envoyer avec les requêtes POST ou PUT.
- En-têtes (optionnel) : En-têtes personnalisés à inclure dans la requête.
- Timeout : Temps maximal d'attente d'une réponse avant de considérer la requête comme échouée.
- Codes de statut HTTP attendus : Définissez les codes de réponse acceptables (par ex. 200 OK).
- Authentification (optionnel) : Supporte l'authentification Basic et Bearer Token.
- Expression XPath : La requête XPath permettant d'extraire la valeur à valider.
- Valeur attendue : Le contenu attendu de l'élément ou attribut XML sélectionné.
- Opérateur de comparaison : Définit comment la valeur attendue doit être comparée (par ex. égal à, supérieur à, contient).
- Intervalle de vérification : Définit la fréquence d'envoi de la requête (par ex. toutes les minutes, toutes les cinq minutes).
Validation de la réponse
La Sonde XML valide les réponses en se basant sur :
- Correspondance exacte de valeur : Vérifie si l'élément ou attribut extrait correspond à une valeur attendue.
- Comparaisons numériques : Permet des comparaisons supérieur à, inférieur à et par plage.
- Correspondance de chaînes : Supporte la recherche de sous-chaînes et les options de sensibilité à la casse.
- Validation booléenne : S'assure qu'un champ est
trueoufalse.
Alertes et notifications
Si la réponse XML ne correspond pas aux conditions attendues, la sonde peut déclencher des alertes via :
- Slack, Microsoft Teams, Discord, Google Chat, Webhooks, Pushover
- Notifications par e-mail
- Tableau de bord Onagre pour le suivi des Incidents
Cas d'utilisation
- S'assurer qu'une API retourne la bonne valeur dans une réponse XML.
- Vérifier des seuils numériques, comme la charge serveur ou le nombre d'utilisateurs actifs.
- Contrôler des indicateurs booléens, comme les indicateurs de santé du système.
- Surveiller les modifications dans les données XML structurées.
Déploiement
La Sonde XML peut être utilisée avec des ressources publiques et privées. Pour la surveillance interne, l'agent privé d'Onagre peut être déployé pour vérifier les endpoints non accessibles depuis internet.
Résumé
La Sonde XML est un outil essentiel pour surveiller les réponses structurées d'API, permettant une validation précise des valeurs clés et la détection d'anomalies en temps réel. Avec une configuration flexible et une intégration avec les outils de communication modernes, elle aide les équipes à maintenir l'intégrité des données et la fiabilité des services.