Esadax überwacht automatisch verschiedene Aspekte Ihrer Webanwendung mithilfe der Checks API. Dieser Leitfaden erklärt, wie Sie Checks in Ihrem Esadax-Workflow verwenden.
Inhaltsverzeichnis
- Einleitung
- Arten von Abläufen
- [Prüft Lebenszyklus] (#checks-lifecycle)
- Erstellen Sie Ihre Checks-Integration
Einleitung
Checks sind Tests und Assertions, die nach jeder erfolgreichen Bereitstellung ausgeführt werden. Sie tragen dazu bei, die Integrität, Zuverlässigkeit und Leistung Ihrer Anwendung zu gewährleisten, indem sie:
- Überprüfung der Codekorrektheit
- Überprüfung auf defekte Verbindungen
- Überwachung von Web-Vitals wie Ladezeit und Fehlerraten
- Sicherstellen, dass alle erforderlichen Komponenten vorhanden sind
Arten von Abläufen, die durch die Checks API aktiviert werden
Die Checks API unterstützt drei Haupttypen von Abläufen:
1 SGB V. Kernkontrollen
- Beschreibung: Überwachen Sie bestimmte Seiten oder APIs, um sicherzustellen, dass sie korrekt reagieren.
- Zweck: Identifizieren Sie Probleme wie Fehler, unterbrochene Verbindungen oder fehlende Assets.
Zwei. Performance
- Beschreibung: Sammeln und vergleichen Sie wichtige Webmetriken (z. B. Ladezeit, Antwortgröße).
- Zweck: Vergleichen Sie neue Bereitstellungen mit der Basisleistung, um den Bereitstellungserfolg zu bestimmen.
3. End-to-End
- Beschreibung: Überprüfen Sie, ob alle erforderlichen Komponenten vorhanden sind.
- Zweck: Sicherstellen, dass die Bereitstellung vollständig und funktionsfähig ist.
4. Optimierung
- Beschreibung: Analysieren Sie Bündelgrößen und optimieren Sie das Asset-Management.
- Zweck: Verbesserung der Website-Performance durch Reduzierung der Ladezeiten.
Lebenszyklus von Checks
Das Lebenszyklusdiagramm für Schecks erklärt, wie Esadax Schecks verwaltet:
- Bereitstellung erstellt (deployment.created webhook): Wird ausgelöst, wenn eine Bereitstellung erstellt wird, sodass Integratoren Prüfungen registrieren können.
- Bereitstellungsbereit (deployment.ready-Webhook): Benachrichtigt Integratoren, damit sie mit der Ausführung von Prüfungen für die neue Bereitstellung beginnen.
- Prüfung abgeschlossen: Sobald alle Prüfungen Ergebnisse erhalten, wendet Esadax Aliase an und stellt die Anwendung live bereit.
Erstellen Sie Ihre Checks-Integration
So erstellen Sie eine erfolgreiche Integration:
- Lösungen mit geringer Konfiguration: Bieten Sie vorkonfigurierte Prüfungen für eine einfache Verwendung.
- Onboarding-Prozess: Leiten Sie Entwickler von der Installation bis zur Bereitstellung.
- Ergebnisdokumentation: Zeigen Sie Testergebnisse übersichtlich auf dem Esadax-Dashboard an.
- Benutzerdefinierte Tests: Ermöglichen Sie fortgeschrittenen Benutzern, die Standardprüfungsfunktionalität zu erweitern.
Anatomie der Checks API
Die Checks API funktioniert wie folgt:
- Ausgelöste Ereignisse:
deployment.created: Registerprüfungen.deployment.ready: Prüfungen starten.
- Check Execution: Esadax wartet, bis alle Prüfungen abgeschlossen sind, bevor die Live-Bereitstellung zugelassen wird.
Dieser Leitfaden hilft Ihnen, die Checks API von Esadax zu nutzen, um die Zuverlässigkeit und Leistung Ihrer Webanwendung zu gewährleisten. Weitere Informationen finden Sie in der Esadax-Dokumentation.
