Απαιτούνται αρχεία καταγραφής για την αντιμετώπιση αστοχιών εγγράφων, αλλά δεν χρειάζεται να καταγραφεί το πλήρες κείμενο.
Απαιτούνται αρχεία καταγραφής για τον εντοπισμό αποτυχιών μετάφρασης, αλλά δεν χρειάζεται να εκτυπώσετε ολόκληρο το συμβόλαιο, τον αριθμό ταυτότητας ή το διακριτικό λήψης. Το αρχείο καταγραφής θα πρέπει να απαντά "ποια εργασία, σε ποιο βήμα και γιατί απέτυχε" αντί να γίνει μια δεύτερη βιβλιοθήκη εγγράφων χωρίς διαχείριση αδειών.
Απαιτούνται αρχεία καταγραφής για την αντιμετώπιση προβλημάτων αποτυχιών μετάφρασης εγγράφων, αλλά τα αρχεία καταγραφής δεν χρειάζεται να περιέχουν το πλήρες κείμενο της σύμβασης, τον αριθμό ταυτότητας ή το διακριτικό λήψης. Αυτό το άρθρο εξηγεί πώς μπορείτε να κάνετε το αρχείο καταγραφής να απαντά "ποια εργασία απέτυχε σε ποιο βήμα και γιατί" χωρίς να αντιγράψετε έγγραφα πελάτη στο αρχείο καταγραφής.
Κατάλληλοι αναγνώστες είναι οι προγραμματιστές και το προσωπικό λειτουργίας και συντήρησης που είναι υπεύθυνο για τις υπηρεσίες μετάφρασης εγγράφων, τη σύνδεση διεπαφών μετάφρασης ή τη διατήρηση αρχείων καταγραφής παρασκηνίου. Μετά την ανάγνωση, μπορείτε να σχεδιάσετε ένα σύνολο πεδίων λίστας επιτρεπόμενων, να επαληθεύσετε ότι το αρχείο καταγραφής δεν εμφανίζει το αρχικό κείμενο και να ορίσετε την περίοδο διατήρησης και το εύρος πρόσβασης για την αντιμετώπιση προβλημάτων.
Τα παραδείγματα χρησιμοποιούν συνθετικά δείγματα για να επιδείξουν μεθόδους επεξεργασίας και ο κώδικας έχει ελεγχθεί σε απομονωμένο περιβάλλον, αλλά αυτό δεν αποτελεί εγγύηση για όλα τα πραγματικά αρχεία ή την απόδοση του προϊόντος. Πριν επεξεργαστείτε σημαντικά έγγραφα, διατηρήστε τα πρωτότυπα και ελέγξτε τα σύμφωνα με τα όρια και τα στοιχεία αποδοχής παρακάτω.
Τι πρέπει να καταγράφεται στο αρχείο καταγραφής αντιμετώπισης προβλημάτων; Μια φράση συμπέρασμα
Το αρχείο καταγραφής καταγράφει μόνο επιτρεπόμενα πεδία όπως το αναγνωριστικό εργασίας, το στάδιο, την κατηγορία σφάλματος και την κατανάλωση χρόνου, αλλά δεν καταγράφει το περιεχόμενο και τα διαπιστευτήρια του εγγράφου.
| την κατάστασή σας | Συνιστώμενες πρακτικές | λόγος |
|---|---|---|
| Πρέπει να μάθετε ποια εργασία απέτυχε | Καταγραφή ενός τυχαίου εσωτερικού αναγνωριστικού εργασίας | Δυνατότητα εντοπισμού προβλημάτων χωρίς να εκτίθενται ονόματα αρχείων χρήστη ή διαδρομές |
| Πρέπει να καθοριστεί σε ποιο στάδιο βρίσκεται η κάρτα | Καταγράψτε το σκηνικό όνομα και τον χρόνο που χρειάστηκε | Δεν χρειάζεται για κάθε κείμενο πηγής και μετάφραση |
| Το αίτημα απορρίφθηκε από το ανάντη | Καταγραφή κανονικοποιημένων κατηγοριών σφαλμάτων | Το πλήρες περιεχόμενο αιτήματος πρώτης κατηγορίας ελέγχου ταυτότητας δεν πρέπει να εισαχθεί στο αρχείο καταγραφής |
| Πρέπει να επιστρέψετε στο πρωτότυπο για αντιμετώπιση προβλημάτων | Χρήση αναφορών σε ένα ελεγχόμενο σύστημα | Οι σύνδεσμοι που μπορούν να ληφθούν μόνιμα δημόσια κινδυνεύουν να διαρρεύσουν |
Ξεκινήστε με πεδία που επιτρέπεται η εγγραφή
Η μαύρη λίστα μπορεί εύκολα να χάσει νέα ευαίσθητα πεδία. Μια πιο συνετή προσέγγιση είναι η έξοδος μόνο των σχεδιασμένων πεδίων, για παράδειγμα:
- Εσωτερικό αναγνωριστικό εργασίας
- Στάδιο επεξεργασίας
- κατηγορία σφάλματος
- χρονοβόρα
Το παρακάτω παράδειγμα σύνθεσης χρησιμοποιεί μια προβολή λίστας επιτρεπόμενων έτσι ώστε το πλήρες κείμενο και τα διακριτικά στην είσοδο να μην εισάγονται στο αρχείο καταγραφής.
Το αρχείο καταγραφής επαλήθευσης δεν έβγαλε το αρχικό κείμενο.
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)
Το παράδειγμα τροποποιεί μόνο το αυτο-ονομαζόμενο demo logger. Δεν συνιστάται η εκκαθάριση του καθολικού χειριστή εφαρμογής στην επιχειρηματική βιβλιοθήκη. Οι τιμές πεδίου πρέπει να επαληθευτούν για το μήκος και τον τύπο. Η προσθήκη ονομάτων στη λίστα επιτρεπόμενων από μόνη της δεν θα σας σώσει εάν στριμώξετε το πλήρες κείμενο του χρήστη στο error_code.
Αναγνωριστικό συσχέτισης στη θέση του ευαίσθητου περιεχομένου
Ο παρακάτω πίνακας παραθέτει τις συνήθεις απαιτήσεις κατά την αντιμετώπιση προβλημάτων, καθώς και τις προτεινόμενες και μη συνιστώμενες εγγραφές.
| Προβλήματα προς διερεύνηση | Προτεινόμενες εγγραφές | Η εγγραφή δεν συνιστάται |
|---|---|---|
| Ποια εργασία απέτυχε | Τυχαίο εσωτερικό αναγνωριστικό εργασίας | Πλήρες όνομα αρχείου χρήστη και διαδρομή |
| Ποιο στάδιο απαιτεί χρόνο; | Στάδια και χρονοβόρα | Κάθε παράγραφος του αρχικού κειμένου και της μετάφρασης |
| Γιατί η Upstream αρνείται; | Τυποποίηση κατηγοριών σφαλμάτων | Μια πλήρης αίτηση με κεφαλίδα ελέγχου ταυτότητας |
| Πώς να βρείτε το πρωτότυπο | Αναφορές εντός του ελεγχόμενου συστήματος | Ένας μόνιμα διαθέσιμος σύνδεσμος για δημόσια λήψη |
Η περίοδος διατήρησης είναι εξίσου σημαντική με το εύρος της πρόσβασης
Ακόμα κι αν το αρχείο καταγραφής δεν περιέχει σώμα κειμένου, ο συνδυασμός του χρόνου εργασίας, της γλώσσας και του μεγέθους του αρχείου μπορεί να αποκαλύψει επιχειρηματικές πληροφορίες. Τα αρχεία καταγραφής θα πρέπει να συνοδεύονται από έλεγχο πρόσβασης, περιόδους διατήρησης και διαδικασίες διαγραφής.
Κατά την αντιμετώπιση προβλημάτων, αυξήστε προσωρινά το επίπεδο καταγραφής, διευκρινίστε πότε πρέπει να συνεχίσετε τις λειτουργίες και αποφύγετε την παραμονή της λειτουργίας εντοπισμού σφαλμάτων στο περιβάλλον παραγωγής για πολύ μεγάλο χρονικό διάστημα.
Η ενσωμάτωση μετάφρασης παρέχει επίσης σαφή και συγκρατημένα αρχεία καταγραφής
Κατά την ενσωμάτωση με το OmniDoc (Καταχώρηση προϊόντος), καταγράφεται μόνο η συσχέτιση μεταξύ τοπικών και απομακρυσμένων εργασιών. Τα αρχεία που μεταφορτώνονται από τους χρήστες δεν πρέπει να αντιγράφονται σε αρχεία καταγραφής για ευκολότερη αντιμετώπιση προβλημάτων.
Μια καλή αναφορά προβλήματος μπορεί να εξηγήσει το στάδιο αποτυχίας και τις συνθήκες επανάληψης, διασφαλίζοντας παράλληλα ότι τα έγγραφα του πελάτη ρέουν μόνο εντός εξουσιοδοτημένων διαδρομών επεξεργασίας.
Αναφορές: Python logging.
📊 Σύγκριση πυρήνων
| Μέθοδος | Πλεονεκτήματα | Κίνδυνος |
|---|---|---|
| Μαύρη λίστα | Η μέθοδος γραφής είναι απλή και εύκολη στην εκμάθηση | Τα ευαίσθητα πεδία που εμφανίζονται εύκολα παραλείπονται |
| Λευκή λίστα | Εξάγονται μόνο τα σχεδιασμένα πεδία, με σαφή όρια | Είναι απαραίτητο να προγραμματίσετε τα πεδία εκ των προτέρων και να επαληθεύσετε το μήκος και τον τύπο των τιμών πεδίου |
🎯 Ποια μέθοδος σας ταιριάζει;
Εάν πρέπει να εντοπίσετε μια εργασία μετάφρασης
Καταγράφει τυχαία εσωτερικά αναγνωριστικά εργασιών και στάδια αποτυχίας, χωρίς να καταγράφει το πλήρες όνομα αρχείου ή τη διαδρομή του χρήστη.
Εάν θέλετε να χειριστείτε σφάλματα διεπαφής ανάντη
Καταγράψτε τυποποιημένες κατηγορίες σφαλμάτων, αλλά μην καταγράφετε πλήρεις αιτήσεις με κεφαλίδες ελέγχου ταυτότητας.
Εάν αντιμετωπίζετε προβλήματα στο διαδίκτυο
Αυξήστε προσωρινά τα επίπεδα καταγραφής και επαναφέρετε αμέσως μετά την επιθεώρηση.
Εάν θέλετε να σχεδιάσετε πεδία καταγραφής
Δώστε προτεραιότητα στη λίστα επιτρεπόμενων και επαληθεύστε το μήκος και τον τύπο των τιμών πεδίου.
❓ Συχνές Ερωτήσεις (FAQ)
1. Μπορεί το αρχείο καταγραφής να καταγράψει το πλήρες όνομα αρχείου του χρήστη;
Δεν συνιστάται. Το πλήρες όνομα αρχείου και η διαδρομή δεν συνιστώνται για εγγραφή. Μπορείτε να χρησιμοποιήσετε τυχαία εσωτερικά αναγνωριστικά εργασιών για να τα συσχετίσετε.
2. Γιατί δεν συνιστάται η χρήση μαύρης λίστας για το φιλτράρισμα ευαίσθητων πεδίων;
Οι μαύρες λίστες τείνουν να χάνουν ευαίσθητα πεδία που εμφανίστηκαν πρόσφατα, ενώ οι λευκές λίστες εξάγουν μόνο σχεδιασμένα πεδία, καθιστώντας τα πιο αξιόπιστα.
3. Χρειάζεται μόνο να διαχειριστείτε τον χρόνο εργασίας και το μέγεθος του αρχείου;
Ναί. Μαζί, αυτές οι πληροφορίες μπορεί επίσης να αποκαλύψουν επιχειρηματικές λεπτομέρειες και τα αρχεία καταγραφής θα πρέπει να συνοδεύονται από έλεγχο πρόσβασης, περιόδους διατήρησης και διαδικασίες διαγραφής.
4. Μπορούν τα αρχεία καταγραφής εντοπισμού σφαλμάτων να παραμείνουν ανοιχτά για μεγάλο χρονικό διάστημα κατά την αντιμετώπιση προβλημάτων;
Δεν συνιστάται. Μετά την προσωρινή αναβάθμιση του επιπέδου καταγραφής, είναι σημαντικό να καθορίσετε πότε θα συνεχιστεί η λειτουργία εντοπισμού σφαλμάτων για να αποφύγετε την παραμονή της λειτουργίας εντοπισμού σφαλμάτων στο περιβάλλον παραγωγής για πολύ μεγάλο χρονικό διάστημα.
5. Μπορείτε να διαγράψετε τον καθολικό χειριστή από τη βάση δεδομένων της επιχείρησης;
Δεν συνιστάται. Το παράδειγμα τροποποιεί μόνο το καταγραφικό επίδειξης που ονομάσατε εσείς οι ίδιοι. Η εταιρική βιβλιοθήκη δεν πρέπει να αδειάσει από την εφαρμογή καθολικού δείκτη χειρισμού.
📝 Περίληψη
Κατά την αντιμετώπιση προβλημάτων αποτυχιών μετάφρασης, το αρχείο καταγραφής θα πρέπει να απαντά στην εργασία, τη φάση και την αιτία, αντί να αποθηκεύει το περιεχόμενο του εγγράφου. Η χρήση πεδίων λευκής λίστας, ελεγχόμενων αναφορών και σαφών περιόδων διατήρησης είναι απαραίτητη για την εξισορρόπηση της αποτελεσματικότητας της αντιμετώπισης προβλημάτων με την ασφάλεια των εγγράφων.


