Badges de statut
Vue d’ensemble
Section intitulée « Vue d’ensemble »OKStatus peut servir une petite image SVG montrant le statut en direct, le pourcentage d’uptime ou le temps de réponse d’un monitor — le genre de badge qu’on colle dans un README, un widget de statut, ou un dashboard interne. Les badges sont publics : aucune clé API ni authentification nécessaire, puisqu’ils sont identifiés par l’ID non-devinable du monitor (même modèle de confiance qu’un slug de page de statut publique).
Badge monitor (animé)
Section intitulée « Badge monitor (animé) »L’option la plus conviviale — un badge de statut en direct, animé et compact, pour un monitor :
<img src="https://okstatus.eu/badge/YOUR_MONITOR_ID" alt="Status" />Trouvez YOUR_MONITOR_ID dans l’URL de la page détail du monitor, dans le dashboard. Ajoutez ?animated=false pour une version statique :
Badges métriques (style shields.io)
Section intitulée « Badges métriques (style shields.io) »Trois badges plats à métrique unique, un endpoint par métrique. Ils sont servis
par l’hôte de l’API publique (api.okstatus.eu), pas par le domaine de
l’application :
| Badge | URL |
|---|---|
| Statut | https://api.okstatus.eu/badge/monitor/:id/status |
| Uptime | https://api.okstatus.eu/badge/monitor/:id/uptime?range=30d |
| Temps de réponse | https://api.okstatus.eu/badge/monitor/:id/response-time |
Le paramètre range du badge uptime accepte 7d, 30d ou 90d (par défaut
30d). Comme le badge animé ci-dessus, ils ne nécessitent aucune clé d’API —
l’UUID indevinable du monitor fait office d’identifiant.
Badge de page de statut
Section intitulée « Badge de page de statut »Pour une page de statut entière plutôt qu’un seul monitor — une pastille « pulse » arrondie qui affiche l’état agrégé de la page (Tous les systèmes sont opérationnels, Performances dégradées, Panne partielle, Panne majeure) :
Les deux slugs correspondent à ceux de l’URL publique de votre page de statut —
okstatus.eu/YOUR_ORG_SLUG/status/YOUR_PAGE_SLUG. Ajoutez ?animated=false
pour une version statique.
L’éditeur de page de statut (Pages de statut → votre page → Intégration) affiche un aperçu en direct de ce badge avec un extrait prêt à coller, ainsi que le widget de statut flottant.
Les badges sont mis en cache 60 secondes (Cache-Control: max-age=60) — en intégrer un dans un README à fort trafic ne surchargera pas OKStatus, mais un changement de statut peut donc mettre jusqu’à une minute à apparaître sur le badge.