Kako izraditi statusnu stranicu: komponente, incidenti i provjere dostupnosti

Statusna stranica na jednom mjestu govori tvojim korisnicima radi li tvoja usluga. Za izradu trebaš popis komponenti (web aplikacija, API, plaćanja, e-pošta), trenutni status za svaku, incidente s vremenski označenim ažuriranjima, povijest prošlih incidenata i, po želji, pretplate kako bi ljudi saznali za probleme bez provjeravanja. Sama stranica je jednostavna. Važna odluka je gdje se izvodi: statusna stranica mora ostati dostupna kad je tvoja aplikacija pala, pa ne smije dijeliti hosting, bazu podataka ni cjevovod za objavu s onim što prijavljuje.

Čemu služi statusna stranica

Kad nešto pukne, korisnici žele znati tri stvari: jesam li ja jedini s problemom, jeste li svjesni problema i kada će biti popravljeno. Statusna stranica odgovara na sve tri bez poplave upita podršci. Tijekom vremena gradi i povjerenje, jer vidljiva povijest incidenata s iskrenim izvještajima pokazuje kako rješavaš probleme.

Nije to changelog. Nove značajke idu na stranicu s promjenama; ispadi i održavanja idu ovdje.

Što stranica treba

Podaci

Statusi komponenti obično su kratak fiksni popis: Radi, Smanjena performansa, Djelomičan ispad, Veliki ispad, Održavanje.

Stranice

• Javna statusna stranica: ukupni banner („Svi sustavi rade“ ili najgori trenutni status), svaka komponenta sa statusom, svaki aktivni incident s ažuriranjima, nadolazeća održavanja i traka povijesti za 90 dana ako imaš podatke o provjerama.
• Stranica incidenta: potpuna vremenska crta ažuriranja za jedan incident, s vlastitom poveznicom da je podrška može slati.
• Povijest: prošli incidenti po mjesecima.
• Pretplata: prijava e-poštom s potvrdom i postavkama po komponentama.
• Administracija: stvaranje incidenta, objava ažuriranja, promjena statusa komponenti, zakazivanje održavanja.

Dopuštenja

Javnost vidi sve što je objavljeno. Objavljivati može samo tvoj tim. Ako možeš, prijavu administratora drži odvojeno od sustava prijave tvoje glavne aplikacije, kako ispad tvog pružatelja autentifikacije ne bi zaključao i tebe iz vlastite statusne stranice.

Ključna odluka: neka bude neovisna

Tu većina samostalno izrađenih statusnih stranica zakaže. Ako tvoja statusna stranica:

• radi na istom poslužitelju ili računu za hosting kao tvoja aplikacija,
• čita iz iste baze podataka,
• nalazi se iza iste postavke domene ili CDN konfiguracije,
• ili je objavljuje isti cjevovod,

tada će je mnogi ispadi srušiti zajedno s aplikacijom, upravo kad ljudi trebaju informaciju. Praktični koraci:

• Odvojen hosting. Drugi projekt ili pružatelj od glavne aplikacije.
• Vlastita poddomena, poput status.primjer.com, zasebno usmjerena u DNS-u. Pogledaj kako rade domene i DNS.
• Vlastiti podaci. Incidenti žive u vlastitoj pohrani statusne stranice, a ne u bazi tvoje aplikacije.
• Statička rezerva. Neki timovi javnu stranicu izrađuju kao statičnu i ponovno je generiraju pri svakom ažuriranju, pa gotovo ništa ne može pasti.

Ručna ili automatska provjera

Ručno (počni ovdje)

Tvoj tim objavljuje incidente i mijenja statuse komponenti ručno iz administratorske stranice. Tako mnoge statusne stranice zapravo rade u praksi, jer je ljudska procjena („plaćanja su spora za neke vrste kartica“) korisnija od automatske crvene točkice.

Da brzo saznaš za probleme, koristi vanjski alat za praćenje dostupnosti koji provjerava tvoju aplikaciju otprilike svake minute i šalje ti upozorenja e-poštom, SMS-om ili u chatu. Mnoge usluge praćenja imaju besplatne planove.

Automatski

Automatizacija znači da nešto redovito provjerava svaku komponentu i ažurira njezin status. Za to je potreban kod koji radi prema rasporedu, izvan infrastrukture tvoje glavne aplikacije. Dva uobičajena obrasca:

• Vanjski alat za praćenje poziva tvoju statusnu stranicu putem webhooka kad provjera padne ili se oporavi, a statusna stranica ažurira komponentu.
• Zakazani zadatak u hostingu statusne stranice pinga svaku komponentu i bilježi rezultat. Prije oslanjanja na to provjeri kako tvoj hosting upravlja zakazanim zadacima; naš vodič o pokretanju pozadinskih poslova opisuje mogućnosti.

Automatske promjene mogu treperiti (gore, dolje, gore) na sporoj mreži. Zahtijevaj dvije ili tri neuspjele provjere prije promjene statusa i pusti čovjeka da potvrdi prije objave velikog ispada.

Pisanje ažuriranja o incidentima

• Objavi rano. „Istražujemo prijave o neuspjelim prijavama“ u roku od nekoliko minuta bolje je od savršene poruke sat vremena kasnije.
• Reci što korisnici primjećuju, a ne što je interno puklo.
• Obećaj vrijeme sljedećeg ažuriranja i održi ga.
• Zatvori kratkim sažetkom kad se riješi: što se dogodilo, koliko je trajalo i što mijenjaš.

Prvi prompt koji radi

Izradi samostalnu statusnu stranicu za našu aplikaciju Parcelio, hostanu zasebno na status.parcelio.com. Komponente: Web stranica, Tracking API, Obavijesti, Plaćanja, svaka sa statusom Radi, Smanjena performansa, Djelomičan ispad, Veliki ispad ili Održavanje. Javna stranica prikazuje ukupni banner prema najgorem trenutnom statusu, svaku komponentu sa statusom, aktivne incidente s vremenski označenim ažuriranjima od najnovijeg prema najstarijem, nadolazeća održavanja i popis prošlih incidenata po mjesecima. Svaki incident ima vlastitu stranicu. Dodaj administratorsku stranicu zaštićenu lozinkom za stvaranje incidenata (naslov, utjecaj, pogođene komponente), objavu ažuriranja (poruka i status: Istraživanje, Utvrđeno, Praćenje, Riješeno), promjenu statusa komponenti i zakazivanje održavanja. Dodaj krajnju točku POST /api/check-result koja prihvaća naziv komponente i gore/dolje od vanjskog alata za praćenje, zaštićenu tajnim tokenom, i označava komponentu kao Smanjena performansa tek nakon tri uzastopna pada. Sve spremi u vlastitu bazu podataka ove aplikacije. Jednostavan, miran dizajn koji se brzo učitava na telefonu.

Koraci izrade

1. Javna stranica i administracija s ručnim incidentima. Ovo samo je već radna statusna stranica.
2. Hostaj je odvojeno i usmjeri poddomenu na nju.
3. Stranice incidenata i povijest.
4. Prozori održavanja.
5. Pretplate. Prijava e-poštom s dvostrukom potvrdom i obavijesti o novim incidentima i ažuriranjima. E-pošti treba pružatelj; pogledaj kako slati e-poštu iz aplikacije.
6. Webhook za praćenje ako želiš automatske promjene statusa.
7. Probna vježba. Stvori lažni incident, objavi ažuriranja, riješi ga, provjeri e-poruke, pa ga obriši.

Česte greške

• Hostanje zajedno s aplikacijom. Najčešća i najozbiljnija greška.
• Stranica koja uvijek kaže „Svi sustavi rade“. Ako nikad ne prikazuje probleme, korisnici joj prestanu vjerovati.
• Bez vremenskih oznaka ili vremenske zone. Uvijek prikaži vrijeme s zonom.
• Oslanjanje na prijavu glavne aplikacije za administratorsku stranicu.
• Tišina između ažuriranja. „Nema promjene, još radimo na tome“ valjano je ažuriranje.
• Treperenje automatskih statusa. Zahtijevaj ponovljene neuspjehe prije promjene.

Kada je usluga statusnih stranica bolji izbor

Usluge hostanih statusnih stranica izgrađene su oko problema neovisnosti: rade na zasebnoj infrastrukturi, obrađuju pretplate na obavijesti e-poštom i SMS-om, a često uključuju praćenje i integracije s alatima za upravljanje incidentima. Ako je dostupnost dio onoga što kupci plaćaju ili imaš ugovorne obveze prijavljivanja incidenata, namjenska usluga se obično isplati. Mnoge imaju besplatne ili jeftine planove za male timove, pa provjeri prije nego što počneš graditi.

Izradi vlastitu kad želiš punu kontrolu nad dizajnom i formulacijama, kad su tvoje potrebe jednostavne (nekoliko komponenti, ručna ažuriranja) ili kad je statusna stranica dio proizvoda koji gradiš za druge.

Izrada s Mythexom

U Mythexu statusnu stranicu možeš izraditi kao zaseban projekt, odvojen od glavne aplikacije, što joj daje zaseban hosting i vlastitu bazu podataka. Opiši je u chatu, provjeri u živom pregledu, zatim je objavi i poveži poddomenu poput status.tvojadomena.com (vlastite domene dostupne su uz Pro). Imaj na umu da objavljene Mythex aplikacije i njihove baze podataka spavaju kad su neaktivne i bude se pri sljedećem posjetu, pa prvo učitavanje nakon mirnog razdoblja može biti sporije; jednostavna, laka stranica tu pomaže.

Mythex nema dokumentirane zakazane zadatke, pa za automatske provjere koristi vanjski alat za praćenje dostupnosti koji poziva webhook krajnju točku u tvojoj statusnoj stranici (pogledaj recept za webhookove). Obavijesti pretplatnicima e-poštom idu preko tvog pružatelja, a ključ je pohranjen kao tajna projekta (recept za slanje e-pošte).

Pitanja