Esadax surveille automatiquement divers aspects de votre application Web à l'aide de l'API Checks. Ce guide explique comment utiliser les chèques dans votre flux de travail Esadax.

Table des matières

1. Introduction
2. Types de flux
3. Cycle de vie des vérifications
4. Construisez votre intégration de chèques

---

I. INTRODUCTION

Les vérifications sont des tests et des assertions qui s'exécutent après chaque déploiement réussi. Ils aident à assurer l'intégrité, la fiabilité et les performances de votre application en:

• Vérification de l'exactitude du code
• Vérification des connexions interrompues
• Surveillance des éléments vitaux du Web comme le temps de chargement et les taux d'erreur
• S’assurer que tous les composants requis sont présents

---

Types de flux activés par Checks API

L'API Checks prend en charge trois principaux types de flux:

1. Développement durable Vérifications de base

• Description : Surveillez des pages ou des API spécifiques pour vous assurer qu'elles répondent correctement.
• Objectif : Identifier les problèmes tels que les erreurs, les connexions interrompues ou les actifs manquants.

2. Performance

• Description : Recueillir et comparer les mesures vitales Web (par exemple, le temps de chargement, la taille de la réponse).
• Objectif : Comparer les nouveaux déploiements aux performances de référence pour décider de la réussite du déploiement.

3. Développement De bout en bout

• Description : Valider que tous les composants requis sont présents.
• Objectif : S’assurer que le déploiement est complet et fonctionnel.

4. Développement Optimisation

• Description : Analyser les tailles de paquets et optimiser la gestion des actifs.
• Objectif : Améliorer les performances du site web en réduisant les temps de chargement.

---

Cycle de vie des chèques

Le diagramme du cycle de vie des chèques explique comment Esadax gère les chèques:

1. Deployment Created (deployment.created webhook) : Déclenché lorsqu'un déploiement est créé, permettant aux intégrateurs d'enregistrer des vérifications.
2. Prêt pour le déploiement (webhook deployment.ready) : Avise les intégrateurs de commencer à exécuter des vérifications sur le nouveau déploiement.
3. Achèvement de la vérification : Une fois que toutes les vérifications reçoivent des résultats, Esadax applique les alias et déploie l'application en direct.

---

Créez votre intégration Checks

Pour créer une intégration réussie:

1. Solutions à faible configuration : Fournissez des vérifications préconfigurées pour faciliter l'utilisation.
2. Processus d'intégration : Guidez les développeurs de l'installation au déploiement.
3. Documentation des résultats : Affichez clairement les résultats des tests sur le tableau de bord Esadax.
4. Tests personnalisés: Permettre aux utilisateurs avancés d'étendre la fonctionnalité de vérification par défaut.

---

Anatomie des vérifications API

L'API Checks fonctionne comme suit:

• Événements déclenchés:
  • deployment.created : Vérifications du registre.
  • deployment.ready: Commencez à exécuter des vérifications.
• Vérification de l'exécution: Esadax attend que toutes les vérifications soient terminées avant d'autoriser le déploiement en direct.

---

Ce guide vous aide à tirer parti de l'API Checks d'Esadax pour assurer la fiabilité et les performances de votre application Web. Pour plus de détails, consultez la documentation d'Esadax (https://www.esadax.com/docs/integrations/checks-overview).