Débuter avec les tests API
Rapport de recherche Datadog : Bilan sur l'adoption de l'informatique sans serveur Rapport : Bilan sur l'adoption de l'informatique sans serveur

Débuter avec les tests API

Créer un test API

Les tests API vous permettent de surveiller vos endpoints d’API et de recevoir des alertes en cas d’échec ou de lenteur excessive. Ces checks vérifient que vos applications répondent aux requêtes et respectent les conditions que vous avez définies, comme le temps de réponse, le code de statut HTTP, ainsi que les contenus de l’en-tête et du corps de message. Utilisez l’API Datadog pour voir la liste complète.

Dans cet exemple, un test API est créé pour vérifier que votre site reste toujours disponible et qu’il répond aux requêtes dans les délais impartis.

Configurer la requête

  1. Dans l’application Datadog, passez votre curseur sur l’option UX Monitoring du menu de gauche et sélectionnez Synthetics Test.
  2. Cliquez sur le bouton New Test en haut à droite.
  3. Sélectionnez API test.
  4. Définissez la configuration de votre test API :

    • Ajoutez l’URL du site que vous souhaitez surveiller. Si vous ne savez pas quel site utiliser, faites un test avec l’application Web https://www.shopist.io.
    • Sélectionnez Advanced Options pour personnaliser les en-têtes, les identifiants d’authentification, le contenu du corps ou les cookies de la requête.
    • Ajoutez des tags pour organiser et filtrer vos tests plus facilement.
    • Sélectionnez les localisations à tester.
    • Cliquez sur le bouton Test URL.

Définir vos conditions d’alerte

Si vous n’avez pas encore créé d’assertions, des assertions sont automatiquement ajoutées une fois le test terminé. Chaque test API doit comprendre au moins une assertion gérée par Datadog. Une assertion est définie par un paramètre, une propriété facultative, un comparateur et une valeur cible.

Dans cet exemple, trois assertions par défaut sont ajoutées une fois l’URL testée :

Ces assertions correspondent à vos conditions d’alerte et peuvent être personnalisées. Pour ajouter une assertion personnalisée, cliquez sur l’en-tête de votre choix dans l’aperçu de la réponse. Vous pouvez également cliquer sur le bouton New Assertion pour ajouter une assertion manuellement (exemple : body contient Shop.ist.)

Échec du test Browser

Vous pouvez configurer vos conditions d’alerte de façon à n’être alerté que si votre endpoint est indisponible pendant plus de trois minutes et pour deux localisations différentes :

An alert is triggered if your test fails for 3 minutes from any 2 of 13 locations

Vous pouvez également définir le nombre minimum de tentatives à effectuer avant qu’une localisation soit considérée comme non disponible. Les nouvelles tentatives seront effectuées juste après l’échec du test. Vous pouvez configurer le test à l’aide de l’option ci-dessous :

Retry x time before location is marked as failed

Remarque : le temps d’attente entre chaque nouvelle tentative est de 300 ms par défaut. Cet intervalle peut être configuré via l’API.

Une fois vos conditions d’alerte définies, saisissez un message d’alerte, indiquez les services et les personnes qui doivent recevoir la notification d’alerte, puis cliquez sur Save Test. Vous pouvez recevoir les notifications sur d’autres services en configurant des intégrations telles que Slack, PagerDuty, Webhooks, etc.

Résultats du test

La page d’accueil d’un test API affiche automatiquement des données le concernant une fois le test enregistré. Cette page affiche les caractéristiques du test, l’historique des temps de réponse et de l’uptime sous forme de graphiques, des exemples de résultats, ainsi que l’ensemble des événements et des résultats du test.

Pour dépanner un test qui n’a pas réussi, faites défiler la page jusqu’à la section Test Results et cliquez sur l’onglet Test Results. Cliquez sur le test concerné (celui-ci affiche un statut Alert) pour visualiser les résultats détaillés. Passez en revue les assertions qui ont échoué et les détails de la réponse, tels que le code de statut, le temps de réponse ainsi que les en-têtes et le corps associés pour résoudre le problème.

Datadog offre également la possibilité d’intégrer l’APM avec Synthetics pour vous permettre d’identifier la cause de l’échec du test en visualisant les traces générées durant son exécution.