Protokoly sú potrebné na riešenie zlyhaní dokumentu, ale nie je potrebné zapisovať celý text.
Protokoly sú potrebné na lokalizáciu zlyhaní prekladu, ale nie je potrebné vytlačiť celú zmluvu, IČO alebo token na stiahnutie. Protokol by mal odpovedať na otázku „ktorá úloha, v ktorom kroku a prečo zlyhal“ a nemal by sa stať druhou knižnicou dokumentov bez správy povolení.
Protokoly sú potrebné na odstraňovanie problémov s prekladom dokumentov, no protokoly nemusia obsahovať úplné znenie zmluvy, identifikačné číslo alebo token na stiahnutie. Tento článok vysvetľuje, ako vytvoriť odpoveď denníka „ktorá úloha zlyhala v ktorom kroku a prečo"bez skopírovania dokumentov zákazníka do denníka.
Vhodnými čitateľmi sú vývojári a pracovníci prevádzky a údržby, ktorí sú zodpovední za služby prekladu dokumentov, dokovanie prekladových rozhraní alebo udržiavanie protokolov na pozadí. Po prečítaní môžete navrhnúť množinu polí zoznamu povolených, overiť, či protokol nezobrazuje pôvodný text, a nastaviť dobu uchovávania a rozsah prístupu na riešenie problémov.
Príklady používajú syntetické vzorky na demonštráciu metód spracovania a kód bol skontrolovaný v izolovanom prostredí, čo však nepredstavuje záruku všetkých skutočných súborov alebo výkonu produktu. Pred spracovaním dôležitých dokumentov si uschovajte originály a skontrolujte ich podľa nižšie uvedených hraníc a akceptačných položiek.
Čo by sa malo zaznamenať do protokolu o riešení problémov? Záver jednou vetou
Protokol zaznamenáva iba povolené polia, ako je ID úlohy, fáza, kategória chýb a spotreba času, ale nezaznamenáva obsah dokumentu a poverenia.
| vaša situácia | Odporúčané postupy | dôvod |
|---|---|---|
| Potrebujete vedieť, ktorá úloha zlyhala | Zaznamenávanie náhodného interného ID úlohy | Schopnosť lokalizovať problémy bez odhalenia názvov používateľských súborov alebo ciest |
| Je potrebné určiť, v akom štádiu sa karta nachádza | Zaznamenajte si meno a čas | Nie je potrebný každý zdrojový text a preklad |
| Žiadosť bola zamietnutá zo strany dodávateľa | Log normalizované kategórie chýb | Obsah kompletnej požiadavky na overenie prvej triedy by sa nemal zadávať do denníka |
| Pri riešení problémov sa musíte vrátiť k originálu | Používanie referencií v rámci riadeného systému | Odkazy, ktoré je možné natrvalo verejne stiahnuť, sú vystavené riziku úniku |
Začnite s poľami, ktoré majú povolené zaznamenávať
Na čiernej listine môžu ľahko chýbať nové citlivé polia. Obozretnejším prístupom je vydávať len navrhnuté polia, napríklad:
- Interné ID úlohy
- Fáza spracovania
- kategória chýb
- časovo náročné
Príklad syntézy nižšie používa projekciu whitelistu, takže celý text a tokeny vo vstupe nie sú zapísané do protokolu.
Overovací protokol nezobrazil pôvodný text.
import io
import json
import logging
ALLOWED = ("job_id", "stage", "error_code", "elapsed_ms")
def log_record(data):
return {key: data[key] for key in ALLOWED if key in data}
stream = io.StringIO()
logger = logging.getLogger("synthetic-document-job")
logger.handlers.clear()
logger.propagate = False
logger.setLevel(logging.INFO)
handler = logging.StreamHandler(stream)
logger.addHandler(handler)
event = {"job_id": "demo-12", "stage": "parse", "error_code": "BAD_CONTAINER",
"elapsed_ms": 42, "document_text": "synthetic confidential clause",
"access_token": "synthetic-secret"}
logger.info(json.dumps(log_record(event), sort_keys=True))
logged = json.loads(stream.getvalue())
assert logged["error_code"] == "BAD_CONTAINER"
assert "document_text" not in logged
assert "synthetic-secret" not in stream.getvalue()
assert set(logged) <= set(ALLOWED)
logger.removeHandler(handler)
Príklad iba upravuje samomenný demo logger. Neodporúča sa vymazať globálny obslužný program aplikácie v obchodnej knižnici. Hodnoty polí je ešte potrebné overiť z hľadiska dĺžky a typu. Samotné uvedenie mien na bielu listinu vás nezachráni, ak do error_code vtlačíte celý text používateľa.
ID asociácie namiesto citlivého obsahu
Tabuľka nižšie uvádza bežné potreby počas inšpekcie, ako aj obsah záznamov o odporúčaniach a neodporúčaniach.
| Otázky, ktoré chcem preskúmať | Odporúčané nahrávky | Neodporúča sa to nahrávať |
|---|---|---|
| Ktorá misia zlyhala | Náhodné interné ID úlohy | Kompletný názov súboru a cesta používateľa |
| Ktorá fáza si vyžaduje čas | Fázy a časovo náročné | Každý odsek zdrojového textu a prekladu |
| Prečo Upstream odmieta? | Štandardizácia kategórií chýb | Kompletná požiadavka s autentifikačnou hlavičkou |
| Ako nájsť originál | Odkazy v riadenom systéme | Trvalo dostupný odkaz na verejné stiahnutie |
Doba uchovávania je rovnako dôležitá ako rozsah prístupu
Aj keď záznam neobsahuje obsah, kombinácia času úlohy, jazyka a veľkosti súboru môže odhaliť obchodné informácie. Záznamy by mali byť sprevádzané kontrolou prístupu, lehotami uchovávania a procesmi mazania.
Počas riešenia problémov dočasne zvýšte úroveň logu, objasnite, kedy pokračovať v prevádzke, a vyhnite sa, aby ladiaci režim zostával v produkčnom prostredí príliš dlho.
Integrácia prekladu tiež poskytuje jasné a obmedzené logy
Pri integrácii s OmniDoc (produktový záznam) sa zaznamenáva iba asociácia medzi lokálnymi a vzdialenými úlohami; súbory nahrané používateľmi by sa nemali kopírovať do logov pre jednoduchšie riešenie problémov.
Dobrá správa o probléme dokáže vysvetliť štádium zlyhania a podmienky opakovania, pričom zabezpečí, že klientské dokumenty budú prúdiť len v rámci autorizovaných spracovateľských ciest.
Zdroje: Python logging.
📊 Porovnanie jadra
| Metóda | Výhody | Riziko |
|---|---|---|
| Čierna listina | Spôsob písania je jednoduchý a ľahko pochopiteľný | Citlivé polia, ktoré sa ľahko objavia, sa prehliadajú |
| Whitelist | Výstupom sú len navrhnuté polia s jasnými hranicami | Je potrebné plánovať polia vopred a overiť dĺžku a typ hodnôt polí |
🎯 Ktorá metóda ti vyhovuje?
Ak potrebujete nájsť prekladateľskú úlohu
Zaznamenáva náhodné interné ID úloh a štádiá zlyhania bez zaznamenávania celého názvu súboru alebo cesty používateľa.
Ak chceš riešiť chyby rozhrania v upstream rozhraní
Zaznamenávajte štandardizované kategórie chýb, ale nezaznamenávajte úplné požiadavky s autentifikačnými hlavičkami.
Ak riešite online problémy
Dočasne zvýšte hladinu kmeňa a obnovte ihneď po kontrole.
Ak chceš navrhovať logaritmové polia
Uprednostnite whitelisting a overte dĺžku a typ hodnôt polí.
❓ Často kladené otázky (FAQ)
1. Môže log zaznamenať celé meno súboru používateľa?
Neodporúčam. Celé meno súboru a cesta sa neodporúčajú na nahrávanie; môžete použiť náhodné interné ID úloh na asociáciu.
2. Prečo sa neodporúča používať čiernu listinu na filtrovanie citlivých polí?
Čierne zoznamy zvyčajne prehliadajú novo vzniknuté citlivé polia, zatiaľ čo biele listy vypisujú len navrhnuté polia, čím sú spoľahlivejšie.
3. Potrebujete spravovať len čas úlohy a veľkosť súboru?
Áno. Tieto informácie môžu spolu odhaliť aj obchodné detaily a záznamy by mali byť sprevádzané kontrolou prístupu, lehotami uchovávania a procesmi mazania.
4. Môžu byť debug logy počas riešenia problémov dlhodobo otvorené?
Neodporúčam. Po dočasnom vylepšení úrovne logu je dôležité špecifikovať, kedy obnoviť ladiaci režim, aby sa predišlo dlhému ponechaniu ladiacho režimu v produkčnom prostredí.
5. Môžeš vymazať globálneho handlera z obchodnej databázy?
Neodporúčam. Príklad upravuje iba demo logger, ktorý ste si pomenovali; business knižnica by nemala byť vyprázdnená z globálnej aplikácie handlera.
📝 Zhrnutie
Pri riešení problémov s prekladom by mal log odpovedať na úlohu, fázu a dôvod, namiesto ukladania obsahu dokumentu. Používanie polí na whitelist, kontrolovaných citácií a jasných období uchovávania je nevyhnutné na vyváženie efektivity riešenia problémov s bezpečnosťou dokumentov.


