Ujasněte si úkol a rozhodnutí
Tato příručka mění webhooky a dávkové zpracování na přehledný provozní pracovní postup. Propojuje rozhodování o doméně, vlastnictví, důkazy a přijímání, takže výsledek nadále funguje v produkci.
Vyberte synchronní, webhook nebo dávkové doručení z objemu, latence, opakování a provozního vlastnictví.
Praktický postup
- 1
Typy zdrojů inventáře, identifikátory, pole, národní prostředí, vlastníci a stavy publikace.
- 2
Vyberte vzor doručení z objemu, latence, redakční kontroly a odolnosti proti selhání.
- 3
Mapujte zdrojový záznam na samostatný záznam jazykové verze s trvalým propojením.
- 4
Přidejte ověřování, idempotency, opakování, zneplatnění mezipaměti, protokolování a řízení přístupu.
- 5
Testovací publikace, změny zdroje, nedostupné výsledky, vrácení zpět, ovládání klávesnice a monitorování před vydáním.
Příklad nebo nástroj
Diagram životního cyklu se stává implementační smlouvou pro opakování, idempotenci, monitorování a přehrávání. V nástroji také zaznamenejte výchozí stav, vlastníka, rozhodnutí, důkazy, otevřený problém a datum schválení. Použijte skutečnou stránku nebo transakci, aby tým viděl závislosti, výjimky a údržbu, která následuje po vydání.
| Rozhodovací bod | Záznam | Kritérium přijetí |
|---|---|---|
| Základní linie | Pozorovaný aktuální stav | Zdroj a datum zaznamenány |
| Rozhodnutí | Vybraná možnost a zdůvodnění | Zváženo riziko a publikum |
| Důkaz | Testujte, dokumentujte nebo měřte | Kontrolovatelné a specifické pro verzi |
| Schválení | Jméno, role a datum | Splněna všechna povinná kritéria |
Vyberte si doručení z latence, objemu a vlastnictví
Používejte synchronní doručování pro malé interaktivní požadavky, které se normálně dokončí během časového limitu rozhraní a mohou okamžitě hlásit výsledek. Webhooky používejte, když je práce asynchronní, ale každý výsledek by měl vstoupit do CMS, jakmile bude připraven. Používejte dávkové zpracování pro velké plánované kolekce, řízené importy nebo migrace, kde na propustnosti a reprodukovatelnosti záleží více než na okamžitém doručení. Vzory mohou koexistovat, ale každá třída obsahu by měla mít zdokumentované výchozí nastavení.
Odhadněte denní a špičkový objem, velikost položky, přijatelný čas dokončení, dobu opakování, požadavek na objednávku, kapacitu kontrolora a provozního vlastníka. Rychlý výsledek nemá žádnou hodnotu, pokud jej redakční fronta nedokáže zpracovat. Zahrňte limity pro upstream a downstream: export CMS, rychlost API, pracovníci ve frontě, koncový bod zpětného volání, zápisy do databáze, zneplatnění mezipaměti a pracovní zátěž kontroly. Vyberte nejjednodušší vzor, který splňuje kompletní cíl služby.
| Vzor | Použijte, když | Nezbytná kontrola |
|---|---|---|
| Synchronní | Malý požadavek a krátká omezená latence | Vypršel časový limit s bezpečným klientem znovu |
| Webhook | Nezávislé zakázky by měly přijít okamžitě | Ověření podpisu a idempotentní zpracování událostí |
| Dávka | Velká kontrolovaná sada a plánované dokončení | Manifest, kontrolní bod, usmíření a přehrávání |
Implementujte ověřitelný životní cyklus webhooku
Přijměte pouze HTTPS POST, ověřte podpis proti nezpracovanému tělu, zkontrolujte toleranci časového razítka a odmítněte nepodporované verze událostí. Před použitím obchodních změn uložte ID události pod jedinečným omezením. Vrácení bylo úspěšné po trvalém přijetí, poté zpracujte asynchronně. Opakovaná událost vrací úspěch bez opakování vedlejšího účinku. Otočte tajné klíče podpisu s dobou překrytí a omezte diagnostický výstup tak, aby neodhalil podpisy ani obsah.
Stavy modelu jako přijaté, ověřené, spárované, aplikované, ignorované, opakování a neúspěšné. Přiřaďte výsledek ID úlohy, ID zdroje, revizi zdroje, národnímu prostředí a režimu. Pokud je aktuální zdroj novější, uložte výsledek pro audit, ale neotevírejte ani nenahrazujte aktuální koncept. Ošetřete události mimo pořadí podle pravidel přechodu stavu spíše než podle pořadí příchodu. Udržujte nástroj pro přehrávání, který vyžaduje důvod, identitu operátora a rozsah.
- 1
Ověřte transport, podpis nezpracovaného těla, časové razítko, typ události a verzi smlouvy.
- 2
Trvejte na jedinečné události a potvrďte trvanlivý příjem.
- 3
Před změnou CMS vyřešte úlohu a přesnou revizi zdroje.
- 4
Použijte idempotentní přechod stavu a vytvořte zkontrolovatelný koncept.
- 5
Zaznamenejte dokončení nebo nasměrujte událost k řízenému opakování a přehrání.
Zajistěte, aby byly šarže reprodukovatelné a slučitelné
Vytvořte neměnný manifest s ID dávky, časem vytvoření, pravidlem dotazu nebo výběru, ID jednotlivé položky, revizí zdroje, národním prostředím, režimem, prioritou a kontrolním součtem. Před odesláním manifest zmrazte, aby pozdější dotaz CMS nemohl změnit význam dávky. Rozdělte jej na ohraničené části a pro každou položku použijte stabilní klíče idempotence. Dokončení kontrolního bodu po trvalých zápisech, takže pracovníci mohou pokračovat, aniž by začínali znovu.
Na konci sladit položky předložené, přijaté, dokončené, zamítnuté, zastaralé, neúspěšné a záměrně přeskočené. Počty musí odpovídat původnímu manifestu a každá nedokončená položka potřebuje důvod a další akci. Přehráním podmnožiny se vytvoří nový manifest přehrání propojený s originálem. Neměňte původní počty ani nemažte neúspěšné důkazy. Publikovat dávkové výsledky pouze do stavů kontroly s limity pracovní zátěže, které chrání redakční tým.
Manifest opravuje identitu položky, revizi zdroje, nastavení a kontrolní součet.
Každá operace položky je idempotentní a nezávisle opakovatelná.
Kontrolní body se obnoví po přerušení bez duplikace konceptů.
Počty konečného stavu se přesně shodují s manifestem.
Přehrávání má rozsah, je autorizováno, propojeno a auditovatelné.
Monitorujte fronty a zkoušejte obnovu
Monitorujte míru akceptace, míru dokončení, chybovost podle kategorie, hloubku fronty, stáří nejstarší položky, percentily trvání zpracování, selhání ověření webhooku, počet opakování, objem nedoručených zpráv, míru zastaralých výsledků a dobu od výsledku do redakčního schválení. Spíše než ojedinělá přechodná selhání upozorněte na dopad na uživatele a rostoucí nevyřízené položky. Řídicí panely oddělují zpracování poskytovatele, doručování zpětného volání, aplikaci CMS a čekací dobu redakce.
Runbook identifikuje vlastníky, bezpečnou pauzu, limity škálování, rotaci pověření, schválení opětovného přehrání, zpracování nedoručených zpráv, komunikaci s poskytovatelem a ověření obnovení. Cvičení ztracené zpětné volání, opakovaná událost, událost mimo pořadí, výpadek poskytovatele, výpadek CMS, nesoulad schématu, vypršel tajný klíč a částečné dokončení dávky. Přijetí vyžaduje obnovení bez duplicitní publikace, tiché ztráty, ruční úpravy databáze nebo odstranění posledního schváleného obsahu.
Role, důkazy a schválení
Generování uchovávejte odděleně od publikace. Úspěšná odpověď je návrh, nikoli schválení. Uložte identifikátor zdroje a verzi, nastavení transformace, identifikátor výsledku, stav recenze, schvalovatele a čas publikace. Když se zdroj změní, místo tichého nahrazování schváleného obsahu označte jazykovou verzi ke kontrole. To umožňuje rollback a audit napříč platformami.
Provoz a údržba
Publikací práce nekončí. Propojte jazykovou verzi nebo konfiguraci s jejím zdrojem, sledujte měření kvality a služeb a definujte konkrétní spouštěče kontroly. Spouštěče zahrnují změny zdroje, právní změny, nové potřeby publika, opakující se otázky podpory, technické změny a incidenty. Jmenovaný vlastník vyhodnotí spouštěč, v případě potřeby otevře novou revizi a zaznamená obnovené schválení.
Kontrolní seznam pro zveřejnění
Integrace využívá trvalé identifikátory zdroje.
Pověření se ukládají na straně serveru a střídají se.
Je definován časový limit, opakování a chování při omezení rychlosti.
Opakované žádosti jsou idempotentní.
Vygenerovaný obsah přejde do stavu recenze.
Změny zdroje zruší platnost nebo znovu otevřou verzi.
Jazyková navigace funguje pomocí klávesnice a asistenční technologie.
Monitorování pokrývá selhání, fronty, latenci a zastaralý obsah.