Status-Badges
Überblick
Abschnitt betitelt „Überblick“OKStatus liefert ein kleines SVG-Bild mit dem Live-Status, der Verfügbarkeit in Prozent oder der Antwortzeit eines Monitors — die Art Badge, die Sie in eine README, ein Status-Widget oder ein internes Dashboard setzen. Badges sind öffentlich: kein API-Schlüssel, keine Anmeldung, denn sie sind über die nicht erratbare ID des Monitors adressiert (dasselbe Vertrauensmodell wie der Slug einer öffentlichen Statusseite).
Monitor-Badge (animiert)
Abschnitt betitelt „Monitor-Badge (animiert)“Die freundlichste Variante — ein kompaktes, animiertes Live-Status-Badge für einen Monitor:
<img src="https://okstatus.eu/badge/IHRE_MONITOR_ID" alt="Status" />IHRE_MONITOR_ID finden Sie in der URL der Detailseite des Monitors im Dashboard. Mit ?animated=false erhalten Sie eine statische Fassung:
Metrik-Badges (im Stil von shields.io)
Abschnitt betitelt „Metrik-Badges (im Stil von shields.io)“Drei flache Badges mit je einer Metrik, ein Endpunkt pro Metrik. Sie werden vom
Host der öffentlichen API ausgeliefert (api.okstatus.eu), nicht von der
Anwendungsdomain:
| Badge | URL |
|---|---|
| Status | https://api.okstatus.eu/badge/monitor/:id/status |
| Verfügbarkeit | https://api.okstatus.eu/badge/monitor/:id/uptime?range=30d |
| Antwortzeit | https://api.okstatus.eu/badge/monitor/:id/response-time |
Der Parameter range des Verfügbarkeits-Badges akzeptiert 7d, 30d oder 90d
(Standard 30d). Wie das animierte Badge oben brauchen sie keinen API-Schlüssel
— die nicht erratbare UUID des Monitors ist das Zugangsdatum.
Badge einer Statusseite
Abschnitt betitelt „Badge einer Statusseite“Für eine ganze Statusseite statt eines einzelnen Monitors — eine abgerundete „Puls”-Pille mit dem Gesamtzustand der Seite (Alle Systeme betriebsbereit, Beeinträchtigte Leistung, Teilausfall, Schwerer Ausfall):
Beide Slugs entsprechen denen in der öffentlichen URL Ihrer Statusseite —
okstatus.eu/IHR_ORG_SLUG/status/IHR_SEITEN_SLUG. Mit ?animated=false erhalten
Sie eine statische Fassung.
Der Editor der Statusseite (Statusseiten → Ihre Seite → Einbetten) zeigt eine Live-Vorschau dieses Badges samt einsatzfertigem Schnipsel, dazu das schwebende Status-Widget.
Zwischenspeicherung
Abschnitt betitelt „Zwischenspeicherung“Badges werden 60 Sekunden lang zwischengespeichert (Cache-Control: max-age=60) — ein Badge in einer viel besuchten README hämmert OKStatus also nicht, bedeutet aber auch, dass eine Statusänderung bis zu einer Minute braucht, bis sie im Badge erscheint.