Naplókra van szükség a dokumentumhibák hibaelhárításához, de nincs szükség a teljes szöveg naplózására.
A fordítási hibák felderítéséhez naplókra van szükség, de nem kell a teljes szerződést, azonosítószámot vagy letöltési tokent kinyomtatni. A naplónak válaszolnia kell arra, hogy „melyik feladat, melyik lépésnél és miért nem sikerült”, ahelyett, hogy egy második, engedélykezelés nélküli dokumentumkönyvtárrá váljon.
A naplók szükségesek a dokumentumfordítási hibák hibaelhárításához, de a naplóknak nem kell tartalmazniuk a szerződés teljes szövegét, az azonosítószámot vagy a letöltési tokent. Ez a cikk elmagyarázza, hogyan lehet a naplóban megválaszolni, hogy "melyik feladat melyik lépésnél és miért nem sikerült" anélkül, hogy az ügyféldokumentumokat a naplóba másolná.
Megfelelő olvasók a fejlesztők, valamint az üzemeltető és karbantartó személyzet, akik a dokumentumfordítási szolgáltatásokért, a fordítási interfészek dokkolásáért vagy a háttérnaplók karbantartásáért felelősek. Az olvasás után megtervezheti az engedélyezési lista mezőit, ellenőrizheti, hogy a napló nem hozza ki az eredeti szöveget, és beállíthatja a megőrzési időszakot és a hozzáférési hatókört a hibaelhárításhoz.
A példák szintetikus mintákat használnak a feldolgozási módszerek bemutatására, és a kódot izolált környezetben ellenőrizték, de ez nem jelent garanciát az összes valós fájlra vagy a termék teljesítményére. A fontos dokumentumok feldolgozása előtt kérjük, őrizze meg az eredeti példányokat és tekintse át az alábbi határok és átvételi tételek szerint.
Mit kell rögzíteni a hibaelhárítási naplóban? Egy mondatos következtetés
A napló csak az engedélyezett mezőket rögzíti, például a feladatazonosítót, a szakaszt, a hibakategóriát és az időfelhasználást, de nem rögzíti a dokumentum tartalmát és hitelesítő adatait.
| a helyzeted | Ajánlott gyakorlatok | ok |
|---|---|---|
| Tudni kell, melyik feladat nem sikerült | Véletlenszerű belső feladatazonosító naplózása | Képes megtalálni a problémákat a felhasználói fájlnevek vagy elérési utak felfedése nélkül |
| Meg kell határozni, hogy a kártya melyik szakaszban van | Jegyezze fel a színpadi nevet és a felhasznált időt | Nincs szükség minden forrásszövegre és fordításra |
| A kérést az upstream elutasította | Normalizált hibakategóriák naplózása | Hitelesítés első osztályú teljes kérés tartalma nem kerülhet be a naplóba |
| A hibaelhárításhoz vissza kell térnie az eredetihez | Referenciák használata ellenőrzött rendszeren belül | Az állandóan nyilvánosan letölthető linkek kiszivárogtatásának veszélye áll fenn |
Kezdje a rögzítésre engedélyezett mezőkkel
A feketelista könnyen kihagyhat új érzékeny mezőket. Megfontoltabb megközelítés, ha csak a tervezett mezőket adjuk ki, például:
- Belső feladatazonosító
- Feldolgozási szakasz
- hibakategória
- időigényes
Az alábbi szintézispélda fehérlistás vetítést használ, így a bemenet teljes szövege és tokenek nem kerülnek be a naplóba.
Az ellenőrző napló nem hozta ki az eredeti szöveget.
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)
A példa csak a saját elnevezésű demónaplózót módosítja. Nem javasolt az alkalmazás globális kezelőjének törlése az üzleti könyvtárban. A mezőértékeket még ellenőrizni kell a hossz és a típus tekintetében. A nevek engedélyezési listája önmagában nem menti meg, ha a felhasználó teljes szövegét betömi a error_code-be.
Társulási azonosító a kényes tartalom helyett
Az alábbi táblázat felsorolja a hibaelhárítás általános követelményeit, valamint az ajánlott és nem javasolt rekordokat.
| Vizsgálandó problémák | Ajánlott rekordok | A felvétel nem ajánlott |
|---|---|---|
| Melyik feladat nem sikerült | Véletlenszerű belső feladatazonosító | Teljes felhasználói fájlnév és elérési út |
| Melyik szakasz vesz igénybe időt? | Szakaszos és időigényes | Minden forrásszöveg és fordítás |
| Miért utasította el az upstream? | Normalizált hibakategóriák | Töltse ki a kérést hitelesítési fejléccel |
| Hogyan keressünk eredetiket | Referenciák a vezérelt rendszereken belül | Véglegesen nyilvános letöltési link |
A megőrzési időszak ugyanolyan fontos, mint a hozzáférési hatókör
Még ha nincs is szöveg a naplóban, a feladatidő, a nyelv és a fájlméret kombinációja üzleti információkat tárhat fel. A naplókhoz hozzáférés-szabályozást, megőrzési időszakokat és törlési eljárásokat kell kísérni.
A hibaelhárítás során ideiglenesen növelje a naplózási szintet, és világosan jelezze, mikor kell visszaállítani, hogy elkerülje a hibakeresési mód hosszú időre való elhagyását az éles környezetben.
A fordítási integrációnak világos és visszafogott naplói is lehetnek
Amikor csatlakozik a OmniDoc (termékportál)-hoz, csak a helyi feladatok és a távoli feladatok közötti társítást kell rögzítenie. A felhasználók által feltöltött fájlokat a hibaelhárítás kényelme érdekében nem szabad a naplóba másolni.
A jó hibajelentés leírja a meghibásodási szakaszt és az ismétlődés feltételeit, miközben az ügyféldokumentumok csak az engedélyezett feldolgozási útvonalakon haladnak.
Források: Python logging.
📊 Alapvető összehasonlítás
| Út | előny | kockázat |
|---|---|---|
| feketelista | Az írásmód egyszerű és könnyen használható. | Könnyen lemaradhatunk az új érzékeny mezőkről |
| fehérlista | Csak a tervezett mezőket adja ki világos határokkal | A mezőket előre meg kell tervezni, és ellenőrizni kell a mezőértékek hosszát és típusát |
🎯 Melyik módszer illik hozzád?
Ha meg kell találnia egy fordítási feladatot
Véletlenszerű belső feladatazonosítók és meghibásodási szakaszok naplózása, a teljes felhasználói fájlnevek vagy elérési utak naplózása.
Ha az upstream interfész által jelentett hibákat szeretné kezelni
Normalizált hibaosztályok naplózása, a teljes kérések nem naplózása hitelesítési fejlécekkel.
Ha online problémákat keres
Ideiglenesen növelje meg a naplózási szintet, és azonnal állítsa vissza a hibaelhárítás befejezése után.
Ha naplómezőket szeretne tervezni
Részesítse az engedélyezőlistát, és ellenőrizze a mezőértékek hosszát és típusát.
❓ Gyakran Ismételt Kérdések (GYIK)
1. Rögzíthető a felhasználó teljes fájlneve a naplóban?
Nem ajánlott. A teljes fájlnév és elérési út rögzítése nem javasolt, helyette véletlenszerű belső feladatazonosító korreláció használható.
2. Miért nem ajánlott feketelistát használni az érzékeny mezők szűrésére?
A feketelista könnyen kihagyhatja az új érzékeny mezőket, míg a fehérlista csak a tervezett mezőket jeleníti meg, ami biztonságosabb.
3. Csak a feladatidőt és a fájlméretet kell kezelni?
igény. Ezen információk kombinációja üzleti információkat is felfedhet, és a naplókat hozzáférés-szabályozásnak, megőrzési időszakoknak és törlési eljárásoknak kell kísérniük.
4. A hibakeresési naplók hosszú ideig bekapcsolhatók a hibaelhárítás során?
Nem ajánlott. A naplózási szint ideiglenes növelése után tudnia kell, hogy mikor kell visszaállítani, hogy elkerülje a hibakeresési mód hosszú időre való elhagyását az éles környezetben.
5. Törölhető a globális kezelő az üzleti könyvtárban?
Nem ajánlott. A példa csak a saját elnevezésű demónaplózót módosítja, és az alkalmazás globális kezelőjét nem szabad törölni az üzleti könyvtárból.
📝 Összefoglaló
A fordítási hibák hibaelhárítása során a naplóknak a dokumentumok tartalmának mentése helyett a feladatokra, szakaszokra és okokra kell válaszolniuk. Használjon engedélyezőlistás mezőket, ellenőrzött hivatkozásokat és egyértelmű megőrzési időszakokat a hibaelhárítás hatékonyságának és a dokumentumok biztonságának egyensúlyba hozása érdekében.


