Kuidas luua staatuselehte: komponendid, intsidendid ja ajakontrollid

Staatuselehel näevad teie kasutajad ühest kohast, kas teie teenus töötab. Selle loomiseks vajate komponentide loendit (veebileht, API, maksed, e-posti saatmine), iga komponendi praegust olekut, ajatemplitega intsidente ja uuendusi, varasemate intsidentide ajalugu ning valikuliselt tellimusi, et inimesed kuuleksid probleemidest ilma lehte vaatamata. Leht ise on lihtne. Oluline otsus on see, kus see töötab: staatuselehe peab jääma üles ka siis, kui teie rakendus on maas, seetõttu ei tohiks see jagada majutust, andmebaasi ega paigaldusprotsessi selle rakendusega, mida ta kajastab.

Milleks staatuselehte vaja on

Katkestuse korral tahavad kasutajad teada kolme asja: kas probleem on ainult minu, kas te olete sellest teadlik ja millal see parandatakse. Staatusleht vastab kõigile kolmele ilma tugipiletite lainena. Samuti loob see aja jooksul usaldust, sest nähtav intsidentide ajalugu aususe ja selgete kirjeldustega näitab, kuidas te probleemidega toimetate.

See ei ole muudatuste logi. Uued funktsioonid kuuluvad muudatuste logi lehele; katkestused ja hooldustööd kuuluvad siia.

Mida leht vajab

Andmed

Komponentide olekud on tavaliselt lühike fikseeritud loend: töötab, halvenenud jõudlus, osaline katkestus, suur katkestus, hoolduse all.

Lehed

• Avalik staatusleht: üldine banner („Kõik süsteemid töötavad“ või kõige halvem praegune olek), iga komponent oma olekuga, aktiivne intsident koos uuendustega, tulevased hooldustööd ning 90-päevane ajaloo riba, kui teil on kontrolliandmeid.
• Intsidendi leht: ühe intsidendi täielik uuenduste ajajoon oma aadressiga, et tugi saaks sellele viidata.
• Ajalugu: varasemad intsidendid kuude kaupa.
• Tellimine: e-posti registreerimine kinnitusega ja komponentide kaupa seadistustega.
• Admin: intsidendi loomine, uuenduste postitamine, komponentide olekute muutmine ja hooldustööde planeerimine.

Õigused

Avalik näeb kõike, mis on avaldatud. Postitada saab ainult teie meeskond. Hoidke administraatori sisselogimine eraldi oma peamise rakenduse sisselogimissüsteemist, kui see on võimalik, et autentimisteenuse tõrge ei lukustaks teid välja oma staatuselehelt.

Peamine otsus: hoidke see sõltumatuna

Siin ebaõnnestub enamik ise tehtud staatuselehti. Kui teie staatusleht:

• töötab samal serveril või majutuskontol kui teie rakendus,
• loeb samast andmebaasist,
• asub samas domeeniseadistuses või CDN-i konfiguratsioonis,
• või on paigaldatud sama torujuhtme kaudu,

siis võtavad paljud katkestused selle samuti maha, täpselt siis, kui inimesed seda vajavad. Praktilised sammud:

• Eraldi majutus. Muu projekt või pakkuja kui peamisel rakendusel.
• Oma alamdomeen, näiteks status.example.com, mis on DNS-is eraldi suunatud. Vt kuidas domeenid ja DNS töötavad.
• Oma andmed. Intsidendid elavad staatuselehe enda salvestuses, mitte teie rakenduse andmebaasis.
• Staatiline varuvariant. Mõned meeskonnad teevad avaliku lehe staatiliseks ja genereerivad selle iga uuenduse järel uuesti, nii et ei ole peaaegu midagi, mis võiks puruneda.

Käsitsi või automaatsed kontrollid

Käsitsi (alusta sellest)

Teie meeskond postitab intsidendid ja muudab komponentide olekuid käsitsi administraatori lehelt. Nii töötavad paljud staatuslehed praktikas, sest inimlik hinnang („maksed on mõne kaardi tüübi puhul aeglased“) on kasulikum kui automaatne punane täpp.

Probleemidest kiiresti teada saamiseks kasutage välist ajakontrolli, mis kontrollib teie rakendust umbes iga minut ja saadab teile hoiatuse e-posti, SMS-i või vestluskanali kaudu. Paljudel seireteenustel on tasuta paketid.

Automaatne

Automaatika tähendab, et miski kontrollib korrapäraselt iga komponenti ja uuendab selle olekut. Selleks on vaja koodi, mis töötab ajakava järgi väljaspool teie peamise rakenduse infrastruktuuri. Kaks levinud mustrit:

• Väline monitor kutsub teie staatuselehte veebihaagi kaudu, kui kontroll ebaõnnestub või taastub, ja staatusleht uuendab komponenti.
• Ajastatud töö staatuselehe enda majutuses pingib iga komponenti ja salvestab tulemuse. Enne selle lootmist kontrollige, kuidas teie majutus ajastatud ülesandeid käsitleb; meie juhend taustatööde käitamisest selgitab valikuid.

Automaatsed muudatused võivad aeglases võrgus kõikuda (üles, alla, üles). Nõudke olekumuudatuseks kahte või kolme ebaõnnestunud kontrolli ja laske inimesel kinnitada, enne kui suur katkestus välja kuulutatakse.

Intsidendi uuenduste kirjutamine

• Postitage varakult. „Uurime sisselogimisprobleeme“ mõne minutiga on parem kui täiuslik sõnum tund hiljem.
• Ütlege, mida kasutajad märkavad, mitte mis sisemiselt katkes.
• Lubage järgmise uuenduse aeg ja pidage sellest kinni.
• Lõpetage lühikese kokkuvõttega, kui probleem on lahendatud: mis juhtus, kui kaua see kestis ja mida te muudate.

Esimene töötav käsk

Ehita eraldiseisev staatusleht meie rakendusele Parcelio, mida majutatakse eraldi aadressil status.parcelio.com. Komponendid: Veebileht, Jälgimise API, Teavitused, Maksed, igaühel olek töötab, halvenenud jõudlus, osaline katkestus, suur katkestus või hoolduse all. Avalik leht näitab üldist bannerit kõige halvema praeguse oleku järgi, iga komponenti oma olekuga, aktiivseid intsidente ajatemplitega uuemad ees, tulevasi hooldustöid ja varasemate intsidentide loendit kuude kaupa. Igal intsidendil on oma leht. Lisa parooliga kaitstud admin-leht intsidentide loomiseks (pealkiri, mõju, mõjutatud komponendid), uuenduste postitamiseks (sõnum ja olek: uurimisel, tuvastatud, jälgimisel, lahendatud), komponentide olekute muutmiseks ja hooldustööde planeerimiseks. Lisa POST /api/check-result lõpp-punkt, mis võtab vastu komponendi nime ja üles/alla oleku välisest monitorist, kaitstud saladuse tokeniga, ja märgib komponendi halvenenuks alles pärast kolme järjestikust kukkumist. Salvesta kõik selle rakenduse enda andmebaasi. Lihtne, rahulik disain, mis laetakse mobiilis kiiresti.

Ehitamise sammud

1. Avalik leht ja admin käsitsi intsidentidega. Ainuüksi see on töötav staatusleht.
2. Majuta eraldi ja suuna alamdomeen sinna.
3. Intsidendi lehed ja ajalugu.
4. Hooldusaknad.
5. Tellimused. Topeltkinnitusega e-posti registreerimine ning teavitused uute intsidentide ja uuenduste kohta. E-kirjade saatmiseks on vaja teenusepakkujat; vt kuidas saata oma rakendusest e-kirju.
6. Monitori veebihaak, kui soovite automaatseid olekumuudatusi.
7. Tehke proovikatkestus. Looge võltsintsident, postitage uuendused, lahendage see, kontrollige e-kirju ja seejärel kustutage see.

Levinud vead

• Majutamine koos rakendusega. Kõige levinum ja tõsisem viga.
• Leht, mis ütleb alati „Kõik süsteemid töötavad“. Kui see ei näita kunagi probleeme, lakkavad kasutajad seda usaldamast.
• Ajatemplid ilma ajavööndita. Näidake alati aegu koos ajavööndiga.
• Administraatori lehe sõltuvus teie peamise rakenduse sisselogimisest.
• Vaikus uuenduste vahel. „Muutust pole, töötame endiselt selle kallal“ on täisväärtuslik uuendus.
• Automaatsete olekute kõikumine. Nõudke olekumuutuseks korduvaid tõrkeid.

Millal on hostitud staatuselehe teenus parem valik

Hostitud staatuselehe teenused on üles ehitatud sõltumatuse probleemi ümber: need töötavad eraldi infrastruktuuril, käsitlevad tellijate teavitusi e-posti ja SMS-i kaudu ning sisaldavad sageli seiret ja integratsioone intsidendihaldustööriistadega. Kui kättesaadavus on osa sellest, mida kliendid maksavad, või teil on lepingulised kohustused intsidentidest teatada, on spetsiaalne teenus tavaliselt väärt. Paljudel on tasuta või odav pakett väikestele meeskondadele, seega kontrollige enne ehitamist.

Ehitage oma, kui soovite täielikku kontrolli disaini ja sõnastuse üle, kui teie vajadused on lihtsad (mõned komponendid, käsitsi uuendused) või kui staatusleht on osa tootest, mida loote teistele.

Ehitamine Mythexis

Mythexis saate staatuselehe luua eraldi projektina, eraldi oma peamisest rakendusest, mis annab sellele eraldi majutuse ja oma andmebaasi. Kirjeldage seda vestluses, vaadake seda reaalajas eelvaates, avaldage ja ühendage alamdomeen nagu status.sinudomeen.ee (kohandatud domeenid on Pro paketis). Pidage meeles, et avaldatud Mythexi rakendused ja nende andmebaasid magavad, kui nad on tegevuseta, ja ärkavad järgmisel külastusel, seega võib esimene laadimine pärast vaikset perioodi olla aeglasem; lihtne ja kerge leht aitab.

Mythex ei dokumenteeri ajastatud töid, seega automaatsete kontrollide jaoks kasutage välist ajakontrolli, mis kutsub teie staatuslehe veebihaagi lõpp-punkti (vt veebihaakide juhendit). Tellijatele saadetavad e-kirjad lähevad teie enda teenusepakkuja kaudu, võti on salvestatud projekti saladusena (e-kirja saatmise juhend).

Küsimused