Ujasnite si úlohu a rozhodnutie
Táto príručka premení webhooky a dávkové spracovanie na prehľadný operačný pracovný postup. Spája rozhodnutia o doméne, vlastníctvo, dôkazy a akceptovanie, takže výsledok naďalej funguje vo výrobe.
Vyberte synchrónne, webhook alebo dávkové doručenie z objemu, latencie, opakovaného pokusu a prevádzkového vlastníctva.
Praktický postup
- 1
Typy zdrojov inventára, identifikátory, polia, miestne nastavenia, vlastníci a stavy publikácie.
- 2
Vyberte si vzor doručenia z objemu, latencie, redakčnej kontroly a tolerancie zlyhania.
- 3
Mapujte zdrojový záznam do samostatného záznamu jazykovej verzie s trvalým prepojením.
- 4
Pridajte autentifikáciu, idempotenciu, opakovanie, zrušenie platnosti vyrovnávacej pamäte, protokolovanie a riadenie prístupu.
- 5
Testovacia publikácia, zmeny zdroja, nedostupné výsledky, vrátenie späť, ovládanie klávesnice a monitorovanie pred vydaním.
Príklad alebo nástroj
Diagram životného cyklu sa stáva implementačnou zmluvou pre opakované pokusy, idempotenciu, monitorovanie a prehrávanie. V nástroji tiež zaznamenajte základnú líniu, vlastníka, rozhodnutie, dôkazy, otvorený problém a dátum schválenia. Použite skutočnú stránku alebo transakciu, aby tím videl závislosti, výnimky a údržbu, ktorá nasleduje po vydaní.
| Rozhodovací bod | Záznam | Akceptačné kritérium |
|---|---|---|
| Základná línia | Pozorovaný aktuálny stav | Zdroj a dátum zaznamenania |
| rozhodnutie | Vybraná možnosť a zdôvodnenie | Zvážte riziko a publikum |
| Dôkazy | Testujte, dokumentujte alebo merajte | Kontrolovateľné a špecifické pre verziu |
| Schválenie | Meno, rola a dátum | Splnené všetky povinné kritériá |
Vyberte si doručenie z latencie, objemu a vlastníctva
Synchrónne doručovanie používajte pre malé interaktívne požiadavky, ktoré sa normálne dokončia v rámci časového limitu rozhrania a môžu okamžite hlásiť výsledok. Webhooky používajte, keď je práca asynchrónna, ale každý výsledok by mal vstúpiť do CMS hneď, ako bude pripravený. Použite dávkové spracovanie pre veľké plánované zbery, kontrolované importy alebo migrácie, kde na priepustnosti a reprodukovateľnosti záleží viac ako na okamžitom doručení. Vzory môžu existovať súčasne, ale každá trieda obsahu by mala mať zdokumentovanú predvolenú hodnotu.
Odhadnite denný a špičkový objem, veľkosť položky, prijateľný čas dokončenia, interval opakovania, požiadavku na objednávku, kapacitu kontrolóra a prevádzkového vlastníka. Rýchly výsledok nemá žiadnu hodnotu, ak ho redakčný rad nedokáže spracovať. Zahrňte upstream a downstream limity: export CMS, rýchlosť API, pracovníci vo fronte, koncový bod spätného volania, zápisy do databázy, zrušenie platnosti vyrovnávacej pamäte a pracovné zaťaženie kontroly. Vyberte najjednoduchší vzor, ktorý spĺňa celý cieľ služby.
| Vzor | Použite, keď | Nevyhnutná kontrola |
|---|---|---|
| Synchrónne | Malá požiadavka a krátka ohraničená latencia | Časový limit s bezpečným opakovaním klienta |
| Webhook | Nezávislé úlohy by mali prísť okamžite | Overenie podpisu a idempotentné spracovanie udalostí |
| Dávka | Veľká riadená sada a plánované dokončenie | Manifest, kontrolný bod, zmierenie a prehrávanie |
Implementujte overiteľný životný cyklus webhooku
Prijmite iba HTTPS POST, overte podpis oproti nespracovanému telu, skontrolujte toleranciu časovej pečiatky a odmietnite nepodporované verzie udalostí. Pred použitím obchodných zmien uložte ID udalosti pod jedinečným obmedzením. Úspešné vrátenie po trvalom prijatí, potom spracovanie asynchrónne. Opakovaná udalosť vráti úspech bez opakovania vedľajšieho účinku. Otočte tajné kľúče podpisu s prekrytím a obmedzte diagnostický výstup tak, aby neodhalil podpisy ani obsah.
Stavy modelu, ako sú prijaté, overené, spárované, aplikované, ignorované, opakovaný pokus a neúspešné. Priraďte výsledok k ID úlohy, ID zdroja, revízii zdroja, miestnemu nastaveniu a režimu. Ak je aktuálny zdroj novší, uložte výsledok na audit, ale neotvárajte ani nenahrádzajte aktuálny koncept. Udalosti mimo poradia riešite skôr podľa pravidiel prechodu stavu než podľa poradia príchodu. Majte nástroj na prehrávanie, ktorý vyžaduje dôvod, identitu operátora a rozsah.
- 1
Overte transport, nespracovaný podpis tela, časovú pečiatku, typ udalosti a verziu zmluvy.
- 2
Pokračujte v jedinečnej udalosti a potvrďte trvalý príjem.
- 3
Pred výmenou CMS vyriešte úlohu a presnú revíziu zdroja.
- 4
Použiť idempotentný prechod stavu a vytvoriť skontrolovateľný koncept.
- 5
Zaznamenajte dokončenie alebo nasmerujte udalosť na kontrolované opakovanie a prehrávanie.
Urobte šarže reprodukovateľné a zosúladiteľné
Vytvorte nemenný manifest s ID dávky, časom vytvorenia, pravidlom dotazu alebo výberu, ID jednotlivej položky, revíziou zdroja, miestnym nastavením, režimom, prioritou a kontrolným súčtom. Pred odoslaním manifest zmrazte, aby neskorší dotaz CMS nemohol zmeniť význam dávky. Rozdeľte ho na ohraničené časti a použite stabilné kľúče idempotencie pre každú položku. Dokončenie kontrolného bodu po trvalých zápisoch, takže pracovníci môžu pokračovať bez toho, aby začali odznova.
Na konci zosúladenie odovzdaných, prijatých, dokončených, odmietnutých, zastaraných, neúspešných a zámerne vynechaných položiek. Počty musia zodpovedať pôvodnému manifestu a každá nedokončená položka potrebuje dôvod a ďalšiu akciu. Opakovaným prehratím podmnožiny sa vytvorí nový manifest prehratia prepojený s originálom. Nemeňte pôvodné počty ani nemažte neúspešné dôkazy. Zverejňujte dávkové výsledky iba do stavov kontroly s limitmi pracovného zaťaženia, ktoré chránia redakčný tím.
Manifest opravuje identitu položky, revíziu zdroja, nastavenia a kontrolný súčet.
Každá operácia položky je idempotentná a nezávisle opakovaná.
Kontrolné body sa obnovia po prerušení bez duplikovania konceptov.
Konečné počty stavov sa presne zhodujú s manifestom.
Opakované prehrávanie je obmedzené, autorizované, prepojené a auditovateľné.
Monitorujte fronty a skúšajte obnovu
Monitorujte mieru prijatia, mieru dokončenia, chybovosť podľa kategórie, hĺbku frontu, vek najstaršej položky, percentily trvania spracovania, zlyhania overenia webhooku, počet opakovaní, objem mŕtvych listov, mieru zastaraných výsledkov a čas od výsledku po redakčné schválenie. Upozorňujte skôr na vplyv na používateľov a narastajúce nevybavené položky než na ojedinelé prechodné zlyhania. Dashboardy oddeľujú spracovanie poskytovateľa, spätné volanie, aplikáciu CMS a redakčnú čakaciu dobu.
Runbook identifikuje vlastníkov, bezpečnú pauzu, limity škálovania, rotáciu poverení, schválenie opätovného prehrávania, spracovanie mŕtvej správy, komunikáciu s poskytovateľom a overenie obnovy. Cvičenie strateného spätného volania, opakovanej udalosti, udalosti mimo poradia, výpadku poskytovateľa, výpadku CMS, nesúladu schémy, tajomstva s vypršanou platnosťou a čiastočného dokončenia dávky. Prijatie vyžaduje obnovenie bez duplicitnej publikácie, tichej straty, manuálnej úpravy databázy alebo odstránenia posledného schváleného obsahu.
Úlohy, dôkazy a schválenie
Generovanie uchovávajte oddelene od publikácie. Úspešná odpoveď je návrh, nie schválenie. Uložte identifikátor a verziu zdroja, nastavenia transformácie, identifikátor výsledku, stav recenzie, schvaľovateľa a čas zverejnenia. Keď sa zdroj zmení, namiesto tichého nahradenia schváleného obsahu označte jazykovú verziu na kontrolu. To umožňuje rollback a audit naprieč platformami.
Prevádzka a údržba
Publikovaním práca nekončí. Prepojte jazykovú verziu alebo konfiguráciu s jej zdrojom, monitorujte opatrenia na kvalitu a služby a definujte konkrétne spúšťače kontroly. Spúšťače zahŕňajú zmeny zdroja, právne zmeny, nové potreby publika, opakujúce sa otázky podpory, technické zmeny a incidenty. Pomenovaný vlastník vyhodnotí spúšťač, v prípade potreby otvorí novú revíziu a zaznamená obnovené schválenie.
Kontrolný zoznam na zverejnenie
Integrácia využíva trvalé identifikátory zdroja.
Poverenia sú uložené na strane servera a rotujú sa.
Časový limit, opakovanie a správanie pri obmedzení rýchlosti sú definované.
Opakované žiadosti sú idempotentné.
Vygenerovaný obsah prejde do stavu kontroly.
Zmeny zdroja znehodnotia alebo znova otvoria verziu.
Jazyková navigácia funguje pomocou klávesnice a asistenčnej technológie.
Monitorovanie pokrýva zlyhania, fronty, latenciu a zastaraný obsah.