Pour vous familiariser avec les moniteurs d’API multi-étapes, nous vous recommandons de lire les articles Vue d’ensemble de la surveillance des API et Gestion des réponses d’API dans les moniteurs multi-étapes où vous trouverez des informations sur les principales fonctionnalités du moniteur d’API multi-étapes.
Cet article vous indique comment configurer le nombre maximal de tentatives et comment cette option vous aide à vérifier les réponses d’API et à obtenir le comportement attendu.
Nombre maximal de tentatives
Dans certaines situations, une requête d’API peut nécessiter plus de temps pour que le processus s’exécute jusqu’à renvoyer une réponse satisfaisante. Par exemple, lors du chargement d’un fichier, l’API peut initialement renvoyer {"result":"processing"}
dans le corps JSON pour indiquer que l’opération est toujours en cours. Une fois l’opération terminée, l’API renvoie {"result":"success"}
. Dans des scénarios de ce type, vous pouvez configurer le moniteur pour qu’il continue d’interroger l’API jusqu’à obtenir une réponse success
.
Parfois, vos API peuvent aussi se comporter de façon inattendue en raison de circonstances imprévues ou de causes externes tels qu’un temps d’arrêt ou un problème de connectivité. Ces situations ne sont pas considérées comme des erreurs et relancer les étapes peut suffire à résoudre le problème.
Le nombre maximal de tentatives permet au moniteur de continuer de vérifier l’étape à des intervalles réguliers jusqu’à obtenir le résultat souhaité ou jusqu’à atteindre le nombre de tentatives maximal. Activer cette option ordonne au moniteur de réessayer l’étape si une ou plusieurs assertions échouent. Vous pouvez configurer une limite maximale de 50 nouvelles tentatives. La limite minimale est fixée à deux car la requête initiale compte comme une première tentative.
Vous pouvez aussi préciser un temps d’attente entre les tentatives afin de définir le délai entre l’exécution de deux tentatives. Ce délai doit être compris entre 500 ms et 30 000 ms, avec une durée par défaut de 1 000 ms.
Une fois que vous avez activé l’option pour une étape, le moniteur réessayera l’étape jusqu’à ce que le nombre maximal de tentatives soit atteint ou que toutes les assertions réussissent. À ce moment-là, le moniteur continue normalement, en exécutant le reste des étapes dans l’ordre. Si le nombre maximal de tentatives est atteint et qu’au moins une assertion a échoué, le moniteur signale une erreur dans le journal du moniteur.