Amalan terbaik untuk log masuk dalam aplikasi python

Dalam aplikasi Python, modul pembalakan harus digunakan dan bukannya cetak () untuk membina sistem log dengan struktur yang jelas, maklumat lengkap dan mudah menyelesaikan masalah. Pertama, gunakan pembalakan perpustakaan standard dan bukannya cetak () kerana ia menyokong pembalakan pelbagai peringkat (debug, info, amaran, ralat, kritikal) dan boleh mengawal format dan lokasi output secara fleksibel; kedua, maklumat konteks, seperti nama modul, nama fungsi, nombor baris dan nilai pembolehubah utama, harus ditambah ke log untuk meningkatkan kebolehbacaan dan keupayaan diagnostik log; Ketiga, log proses mengikut alam sekitar, membolehkan tahap debug semasa pembangunan, dan persekitaran pengeluaran terhad kepada I. NFO atau amaran atau di atas, dan log boleh diuruskan secara terpusat dalam kombinasi dengan fail atau perkhidmatan pihak ketiga; Akhirnya, perangkap biasa perlu dielakkan, seperti menggunakan pembalakan.exception () bukannya cetak (e), dan tidak memanggil BasicConfig () di peringkat atas modul. Adalah disyorkan untuk menggunakan __Name__ untuk membuat pembalak, dan menggunakan RotatingFileHandler untuk melaksanakan putaran log, dengan itu memastikan kecekapan dan kepraktisan sistem log.

Pembalakan dalam aplikasi Python nampaknya mudah, tetapi jika anda benar -benar melakukannya dengan baik, anda masih perlu memberi perhatian kepada kaedah tersebut. Hanya menulis print() tidak mencukupi. Apa yang benar -benar berguna ialah sistem log dengan struktur yang jelas, maklumat lengkap dan mudah menyelesaikan masalah. Mata berikut adalah amalan praktikal yang saya diringkaskan dalam projek sebenar.

Gunakan pembalakan perpustakaan standard dan bukannya cetakan

Banyak pemula suka menggunakan print() untuk mengeluarkan maklumat debugging pada mulanya, tetapi dalam projek formal, ini jauh dari cukup. Modul logging terbina dalam Python bukan sahaja menyokong tahap pembalakan yang berlainan (seperti debug, maklumat, amaran, kesilapan, kritikal), tetapi juga menyediakan kawalan fleksibel lokasi dan format output.

Contohnya:

 import pembalakan

Logging.BasicConfig (level = logging.info)
logger = logging.getLogger (__ name__)

logger.info ("Ini adalah mesej maklumat")
logger.error ("Ini adalah mesej ralat")

Dengan cara ini, anda hanya boleh memaparkan log pada tahap ralat atau di atas seperti yang diperlukan tanpa maklumat mengganggu penglihatan anda. Dan ia menyokong output ke fail, mel, dan juga pelayan jauh.

Tambahkan maklumat konteks ke log

Ia tidak membantu banyak melihat "salah". Kuncinya adalah untuk mengetahui di mana dan mengapa ia salah. Jadi cadangan:

• Setiap log mengandungi maklumat seperti nama modul, nama fungsi, nombor baris, dll.
• Rekod nilai pembolehubah utama atau parameter input
• Jika ia berada dalam aplikasi web, anda boleh menambah laluan permintaan, ID pengguna, dll.

Kaedah konfigurasi juga sangat mudah. Tambahkan parameter format ke BasicConfig:

 Logging.BasicConfig (
    format = " %(asctime) s [ %(levelName) s] %(nama) s - %(funcName) s: %(lineno) d - %(mesej) s",
    tahap = logging.debug
)

Dengan cara ini log output lebih jelas.

Log Pemprosesan yang dinilai: Pembangunan vs Pengeluaran

Semasa pembangunan tempatan, kami boleh membuka log peringkat debug untuk memudahkan butiran tontonan; Tetapi dalam persekitaran pengeluaran, hanya maklumat atau amaran atau log atas biasanya dikekalkan untuk mengelakkan kehilangan prestasi dan letupan log.

Anda boleh menetapkan tahap log secara dinamik mengikut persekitaran yang berbeza, seperti:

 Jika Env == "Pengeluaran":
    logger.setLevel (Logging.Warning)
lain:
    logger.setLevel (logging.debug)

Anda juga boleh menulis log ke fail yang berbeza, atau diuruskan secara berpusat melalui perkhidmatan pihak ketiga (seperti Sentry, Elk Stack).

Elakkan perangkap biasa

Apabila menggunakan pembalakan, terdapat beberapa masalah kecil yang mudah diabaikan:

• ❌ Jangan gunakan except Exception as e: print(e) , logging.exception() harus digunakan untuk mencetak timbunan ralat lengkap
• ❌ Jangan panggil basicConfig() secara langsung di bahagian atas modul, jika tidak, ia boleh menjejaskan konfigurasi log modul lain.
• ✅ Adalah disyorkan untuk menggunakan __name__ untuk membuat logger untuk memastikan bahawa setiap modul mempunyai ruang nama bebas
• ✅ Adalah lebih baik untuk memutar fail log dengan kerap, anda boleh menggunakan RotatingFileHandler atau TimedRotatingFileHandler

Pada dasarnya itu sahaja. Sistem log tidak rumit, tetapi butirannya tidak dilakukan dengan betul, dan ia dapat dengan mudah menjadi hiasan atau beban. Hanya dengan konfigurasi rasional dan penggunaan piawai dapat kita bantu pada saat -saat kritikal.

Atas ialah kandungan terperinci Amalan terbaik untuk log masuk dalam aplikasi python. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!