Kaip sukurti statuso puslapį: komponentai, incidentai ir veikimo patikros

Statuso puslapis vienoje vietoje pasako jūsų naudotojams, ar jūsų paslauga veikia. Kad jį sukurtumėte, reikia komponentų sąrašo (svetainė, API, mokėjimai, el. pašto siuntimas), kiekvieno komponento dabartinės būsenos, incidentų su laiko žymomis atnaujinimų, praeitų incidentų istorijos ir, jei norite, prenumeratų, kad žmonės sužinotų apie problemas nebetikrindami patys. Pats puslapis paprastas. Svarbiausias sprendimas – kur jis veiks: statuso puslapis turi išlikti pasiekiamas, kai programa neveikia, todėl jis neturėtų dalytis serveriu, duomenų baze ar diegimo procesu su tuo, apie ką praneša.

Kam skirtas statuso puslapis

Kai kas nors sugenda, naudotojai nori žinoti tris dalykus: ar problema tik jų pusėje, ar jūs apie ją žinote ir kada ji bus ištaisyta. Statuso puslapis į visus tris klausimus atsako be lavinos pagalbos prašymų. Be to, laikui bėgant jis kuria pasitikėjimą, nes matoma incidentų istorija su sąžiningais aprašymais parodo, kaip tvarkotės su problemomis.

Tai nėra pakeitimų žurnalas. Naujos funkcijos eina į pakeitimų žurnalo puslapį; gedimai ir techninė priežiūra – čia.

Ko reikia puslapiui

Duomenys

Komponentų būsenos paprastai yra trumpas fiksuotas sąrašas: Veikia, Sulėtėjęs veikimas, Dalinis gedimas, Didelis gedimas, Vykdoma techninė priežiūra.

Puslapiai

• Viešas statuso puslapis: bendras baneris („Visos sistemos veikia“ arba blogiausia dabartinė būsena), kiekvienas komponentas su būsena, bet koks aktyvus incidentas su atnaujinimais, artėjanti techninė priežiūra ir 90 dienų istorijos juosta, jei turite patikrų duomenų.
• Incidento puslapis: pilna vieno incidento atnaujinimų eiga su savo URL, kad palaikymo komanda galėtų į jį nuorodą pateikti.
• Istorija: praeiti incidentai pagal mėnesį.
• Prenumerata: el. pašto registracija su patvirtinimu ir pasirinkimais pagal komponentą.
• Administravimas: sukurti incidentą, skelbti atnaujinimus, keisti komponentų būsenas, planuoti techninę priežiūrą.

Leidimai

Viešai matoma viskas, kas paskelbta. Skelbti gali tik jūsų komanda. Jei įmanoma, administratoriaus prisijungimą laikykite atskirai nuo pagrindinės programos prisijungimo sistemos, kad tapatybės tiekėjo gedimas neužrakintų jūsų pačių statuso puslapio.

Pagrindinis sprendimas: išlaikykite nepriklausomybę

Čia dažniausiai žlunga namuose kurti statuso puslapiai. Jei jūsų statuso puslapis:

• veikia tame pačiame serveryje ar hostingo paskyroje kaip programa,
• skaito iš tos pačios duomenų bazės,
• yra už to paties domeno nustatymų ar CDN konfigūracijos,
• arba yra diegiamas tuo pačiu procesu,

tai daugelis gedimų jį išjungs kartu, būtent tada, kai žmonėms jo labiausiai reikia. Praktiniai žingsniai:

• Atskiras hostingas. Kitas projektas ar tiekėjas nei pagrindinei programai.
• Savas poddomenas, pavyzdžiui status.example.com, nukreiptas atskirai DNS įrašuose. Žr. kaip veikia domenai ir DNS.
• Savi duomenys. Incidentai saugomi statuso puslapio pačio saugykloje, ne jūsų programos duomenų bazėje.
• Statinis atsarginis variantas. Kai kurios komandos viešą puslapį daro statinį ir perkuria kiekvieno atnaujinimo metu, todėl beveik nėra ką sugadinti.

Rankiniai atnaujinimai ar automatinės patikros

Rankiniai (pradėkite nuo jų)

Jūsų komanda incidentus skelbia ir komponentų būsenas keičia rankiniu būdu iš administravimo puslapio. Taip daugelis statuso puslapių veikia praktikoje, nes žmogaus sprendimas („mokėjimai lėti kai kurių tipų kortelėms“) yra naudingesnis nei automatinis raudonas taškas.

Norėdami greitai sužinoti apie problemas, naudokite išorinį veikimo stebėjimo įrankį, kuris jūsų programą tikrina maždaug kas minutę ir praneša el. paštu, SMS ar pokalbių kanalu. Daugelis stebėjimo paslaugų siūlo nemokamus planus.

Automatiniai

Automatizavimas reiškia, kad kažkas reguliariai tikrina kiekvieną komponentą ir atnaujina jo būseną. Tam reikia kodo, veikiančio pagal grafiką, iš išorės nei pagrindinė jūsų programos infrastruktūra. Du dažni variantai:

• Išorinis stebėjimo įrankis kviečia jūsų statuso puslapį per webhook, kai patikra nepavyksta arba atsistato, ir statuso puslapis atnaujina komponentą.
• Suplanuota užduotis statuso puslapio paties hostinge patikrina kiekvieną komponentą ir įrašo rezultatą. Prieš į tai pasikliaudami, patikrinkite, kaip jūsų hostingas tvarko suplanuotas užduotis; mūsų vadove apie fono užduočių vykdymą aprašytos galimybės.

Automatiniai pakeitimai gali šokinėti (veikia, neveikia, veikia) lėtame tinkle. Prieš keisdami būseną reikalaukite dviejų ar trijų nesėkmingų patikrų, o didelį gedimą paskelbti leiskite tik žmogui patvirtinus.

Kaip rašyti incidentų atnaujinimus

• Skelbkite anksti. „Tiriame pranešimus apie nepavykusius prisijungimus“ per kelias minutes geriau nei tobula žinutė po valandos.
• Pasakykite, ką pastebi naudotojai, o ne ką sugedo viduje.
• Pažadėkite kito atnaujinimo laiką ir jo laikykitės.
• Baikite trumpa santrauka, kai problema išspręsta: kas nutiko, kiek truko, ką keičiate.

Pirmasis veikiantis raginimas

Sukurk atskirą statuso puslapį mūsų programai Parcelio, talpinamą atskirai adresu status.parcelio.com. Komponentai: Svetainė, Sekimo API, Pranešimai, Mokėjimai; kiekvienas su būsena Veikia, Sulėtėjęs veikimas, Dalinis gedimas, Didelis gedimas arba Vykdoma techninė priežiūra. Viešame puslapyje rodyk bendrą banerį pagal blogiausią dabartinę būseną, kiekvieną komponentą su būsena, aktyvius incidentus su laiko žymomis naujausi viršuje, artėjančią techninę priežiūrą ir praeitų incidentų sąrašą pagal mėnesį. Kiekvienas incidentas turi savo puslapį. Pridėk administravimo puslapį, apsaugotą slaptažodžiu, kuriame galima kurti incidentus (pavadinimas, poveikis, paveikti komponentai), skelbti atnaujinimus (žinutė ir būsena: Tiriama, Nustatyta, Stebima, Išspręsta), keisti komponentų būsenas ir planuoti techninę priežiūrą. Pridėk POST /api/check-result galinį tašką, kuris priima komponento pavadinimą ir veikia/neveikia iš išorinio stebėjimo įrankio, apsaugotą slaptu žetonu, ir pažymi komponentą kaip Sulėtėjęs veikimas tik po trijų nesėkmingų patikrų iš eilės. Viską saugok šios programos duomenų bazėje. Paprastas, ramus dizainas, greitai įkeliamas telefonuose.

Kūrimo žingsniai

1. Viešas puslapis ir administravimas su rankiniais incidentais. Vien tai jau veikiantis statuso puslapis.
2. Talpinkite jį atskirai ir nukreipkite poddomeną.
3. Incidentų puslapiai ir istorija.
4. Techninės priežiūros langai.
5. Prenumeratos. Dviguba registracija el. paštu ir pranešimai apie naujus incidentus bei atnaujinimus. El. paštui reikia tiekėjo; žr. kaip siųsti el. laiškus iš programos.
6. Stebėjimo webhook, jei norite automatinių statuso pakeitimų.
7. Atlikite pratybas. Sukurkite išgalvotą incidentą, paskelbkite atnaujinimus, išspręskite jį, patikrinkite laiškus ir tada ištrinkite.

Dažniausios klaidos

• Talpinimas kartu su programa. Dažniausia ir rimčiausia klaida.
• Puslapis, kuris visada sako „Visos sistemos veikia“. Jei jis niekada nerodo problemų, naudotojai nebepasitiki.
• Be laiko žymų ar laiko juostos. Visada rodykite laiką su juosta.
• Administravimo puslapio prisijungimas per pagrindinės programos prisijungimą.
• Tyla tarp atnaujinimų. „Pokyčių nėra, vis dar dirbame“ yra pilnavertis atnaujinimas.
• Šokinėjančios automatinės būsenos. Prieš keičiant būseną reikalaukite pakartotinių nesėkmių.

Kada geresnis pasirinkimas – paslaugos statuso puslapis

Paslaugos statuso puslapiams skirtos nepriklausomybės problemai spręsti: jos veikia atskirose infrastruktūrose, tvarko prenumeratorių pranešimus el. paštu ir SMS, dažnai apima stebėjimą ir integracijas su incidentų įrankiais. Jei veikimo laikas yra tai, ką klientai moka, arba turite sutartinių įsipareigojimų pranešti apie incidentus, specializuota paslauga paprastai yra verta. Daugelis jų turi nemokamus ar pigius planus mažoms komandoms, todėl prieš kurdami patikrinkite.

Kurkite savo, kai norite visiško dizaino ir formuluočių kontrolės, kai jūsų poreikiai paprasti (keletas komponentų, rankiniai atnaujinimai) arba kai statuso puslapis yra kitiems kuriamo produkto dalis.

Kaip tai padaryti su Mythex

Mythex platformoje statuso puslapį galite sukurti kaip atskirą projektą, nepriklausomą nuo pagrindinės programos, todėl jis turi atskirą hostingą ir savo duomenų bazę. Aprašykite jį pokalbyje, patikrinkite gyvame peržiūros lange, tada paskelbkite ir prijunkite poddomeną, pavyzdžiui status.jusudomenas.lt (pasirinktiniai domenai yra Pro plane). Atminkite, kad paskelbtos Mythex programos ir jų duomenų bazės kai nenaudojamos, užmiega ir atsibunda kitą kartą atsidarius, todėl pirmas įkėlimas po ilgesnės tylos gali būti lėtesnis; paprastas, lengvas puslapis tai sušvelnina.

Mythex nedokumentuoja suplanuotų užduočių, todėl automatinėms patikroms naudokite išorinį veikimo stebėjimo įrankį, kuris kviečia webhook galinį tašką jūsų statuso puslapyje (žr. webhook receptą). Laiškus prenumeratoriams siunčia jūsų pačių tiekėjas, o raktas laikomas kaip projekto paslaptis (siuntimo el. paštu receptas).

Klausimai