Django menyediakan kerja default logging configuration yang mudah diperpanjang.
\nUntuk mengirim pesan catatan dari dalam kode anda, anda dapat menempatkan panggilan pencatatan kedalamnya.
\n\nFirst, import the Python logging library, and then obtain a logger instance\nwith logging.getLogger(). Provide the getLogger() method with a\nname to identify it and the records it emits. A good option is to use\n__name__ (see Gunakan namespace pencatat below for more on this) which will\nprovide the name of the current Python module as a dotted path:
import logging\n\nlogger = logging.getLogger(__name__)\nMerupakan konvensi yang baik untuk melakukan deklarasi ini pada tingkat modul.
\nKemudian di dalam fungsi, sebagai contoh dalam tampilan, mengirimkan rekaman ke pencatat:
\ndef some_view(request):\n ...\n if some_risky_state:\n logger.warning("Platform is running at risk")\nKetika kode ini dijalankan, LogRecord mengandung pesan itu akan terkirim ke pencatat. Jika anda menggunakan konfigurasi pencatatan awalan Django, pesan akan muncul di konsol.
Tingkatan WARNING digunakan dalam contoh diatas adalah satu dari beberapa logging severity levels: DEBUG, INFO, WARNING, ERROR, CRITICAL. Jadi, contoh lain mungkin:
logger.critical("Payment system is not responding")\nAlthough Django's logging configuration works out of the box, you can control\nexactly how your logs are sent to various destinations - to log files, external\nservices, email and so on - with some additional configuration.
\nAnda dapat mengkonfigurasi
\npencatatan pemetaan, untuk menentukan rekaman mana yang dikirim ke penangan mana
penangan, untuk menentukan apa yang mereka lakukan dengan rekaman mereka terima
penyaring, untuk menyediakan kendali tambahan terhadap perpindahan rekaman, dan bahkan merubah rekaman di tempat
pembentuk, untuk merubah obyek LogRecord menjadi string atau bentuk lain untuk dikonsumsi oleh manusia atau sistem lain
Ada beragam cara dari mengkonfigurasi pencatatan. Di Django, pengaturan LOGGING adalah yang paling umum digunakan. Pengaturan menggunakan the dictConfig format, dan memperpanjang default logging configuration.
Lihat Mengkonfigurasi catatan untuk penjelasan bagaimana pengaturan penyesuaian anda digabungkan dengan awalan Django.
\nLihat Python logging documentation untuk rincian cara lain dari konfigurasi pencatatan. Demi kesederhanaan, dokumentasi ini hanya akan mempertimbangkan konfigurasi melalui pengaturan LOGGING.
Ketika mengkonfigurasi pencatatan, itu masuk akal untuk
\nDalam settings.py anda:
LOGGING = {\n "version": 1, # the dictConfig format version\n "disable_existing_loggers": False, # retain the default loggers\n}\nItu hampir selalu masuk akal untuk mempertahankan dan memperpanjang konfigurasi pencatatan awalan dengan mengatur disable_existing_loggers menjadi False.
Contoh ini mengkonfigurasikan penangan tunggal bernama file, yang menggunakan Python's FileHandler untuk menyimpan catatan tingkatan DEBUG dan tertinggi ke berkas general.log (di akar proyek):
LOGGING = {\n # ...\n "handlers": {\n "file": {\n "class": "logging.FileHandler",\n "filename": "general.log",\n },\n },\n}\nKelas-kelas penangan berbeda mengambil pilihan konfigurasi berbeda. Untuk informasi lebih pada ketersediaan kelas-kelas penangan, lihat AdminEmailHandler disediakan oleh Django dan beragam handler classes disediakan oleh Python.
Tingkat pencatatan dapat juga di setel pada penangan (secara awalan, mereka menerima catatan pesan pada semua tingkatan). Menggunakan contoh diatas, menambahkan:
\n{\n "class": "logging.FileHandler",\n "filename": "general.log",\n "level": "DEBUG",\n}\nakan menentukan sebuah konfigurasi penangan yang hanya menerima rekaman dari tingkatan DEBUG dan lebih tinggi.
Untuk mengirim rekaman ke penangan ini, konfigurasikan pemetaan pencatatan untuk menggunakannya sebagai contoh:
\nLOGGING = {\n # ...\n "loggers": {\n "": {\n "level": "DEBUG",\n "handlers": ["file"],\n },\n },\n}\nThe mapping's name determines which log records it will process. This\nconfiguration ('') is unnamed. That means that it will process records\nfrom all loggers (see Gunakan namespace pencatat below on how to use the mapping\nname to determine the loggers for which it will process records).
Itu akan meneruskan pesan dari tingkatan DEBUG dan lebih tinggi ke penangan bernama file.
Catat bahwa pencatat dapat meneruskan pesan ke banyan penangan, jadi hubungan diantara pencatat dan penangan adalah many-to-many.
\nJika anda menjalankan:
\nlogger.debug("Attempting to connect to API")\ndalam kode anda, anda akan menemukan bahwa pesan dalam berkas general.log di akar dari proyek.
Secara awalan, keluaran catatan akhir mengandung pesan bagian dari tiap log record. Gunakan pembentuk jika anda ingin menyertakan data tambahan. Nawa awal dan tentukan bentukan anda - contoh ini menentukan nama bentukan verbose dan simple:
LOGGING = {\n # ...\n "formatters": {\n "verbose": {\n "format": "{name} {levelname} {asctime} {module} {process:d} {thread:d} {message}",\n "style": "{",\n },\n "simple": {\n "format": "{levelname} {message}",\n "style": "{",\n },\n },\n}\nKatakunci style mengizinkan anda menentukan { for str.format() atau $ untuk bentukan string.Template ; awalan adalah $.
Lihat atribut LogRecord attributes for the LogRecord anda dapat sertakan.
Untuk memberlakukan pembentuk untuk penangan, tambah masukan formatter pada dictionary penangan mengacu pada pembentuk berdasarkan nama, sebagai contoh:
"handlers": {\n "file": {\n "class": "logging.FileHandler",\n "filename": "general.log",\n "formatter": "verbose",\n },\n}\nThe unnamed logging configuration '' captures logs from any Python\napplication. A named logging configuration will capture logs only from loggers\nwith matching names.
Namespace dari instance pencatat ditentukan menggunakan getLogger(). Sebagai contoh dalam views.py dari my_app:
logger = logging.getLogger(__name__)\nwill create a logger in the my_app.views namespace. __name__ allows you\nto organize log messages according to their provenance within your project's\napplications automatically. It also ensures that you will not experience name\ncollisions.
Sebuah pemetaan pencatatan bernama my_app.views akan mengambil rekaman dari pencatat ini:
LOGGING = {\n # ...\n "loggers": {\n "my_app.views": {...},\n },\n}\nA logger mapping named my_app will be more permissive, capturing records\nfrom loggers anywhere within the my_app namespace (including\nmy_app.views, my_app.utils, and so on):
LOGGING = {\n # ...\n "loggers": {\n "my_app": {...},\n },\n}\nAnda dapat juga menentukan namespace pencatat secara eksplisit:
\nlogger = logging.getLogger("project.payment")\ndan atur pemetaan pencatatan yang sesuai.
\nLogger naming is hierarchical. my_app is the parent of my_app.views,\nwhich is the parent of my_app.views.private. Unless specified otherwise,\nlogger mappings will propagate the records they process to their parents - a\nrecord from a logger in the my_app.views.private namespace will be handled\nby a mapping for both my_app and my_app.views.
Untuk mengelola perilaku ini, setel kunci propagasi pada pemetaan anda tentukan:
\nLOGGING = {\n # ...\n "loggers": {\n "my_app": {\n # ...\n },\n "my_app.views": {\n # ...\n },\n "my_app.views.private": {\n # ...\n "propagate": False,\n },\n },\n}\npropagate awalan adalah True. Di contoh ini, catatan dari my_app.views.private tidak akan ditangani oleh orang tua, tetapi catatan my_app.views akan.
Logging is most useful when it contains as much information as possible, but\nnot information that you don't need - and how much you need depends upon what\nyou're doing. When you're debugging, you need a level of information that would\nbe excessive and unhelpful if you had to deal with it in production.
\nYou can configure logging to provide you with the level of detail you need,\nwhen you need it. Rather than manually change configuration to achieve this, a\nbetter way is to apply configuration automatically according to the\nenvironment.
\nSebagai contoh, anda dapat mensetel variabel lingkungan DJANGO_LOG_LEVEL dengan tepat di lingkungan pengembangan dan pementasan, dan memanfaatkannya di pemetaan pencatatan:
"level": os.getenv("DJANGO_LOG_LEVEL", "WARNING")\n- sehingga kecuali lingkungan menentukan tingkat catatan yang lebih rendah, konfigurasi ini hanya akan meneruskan rekaman dari kerasnya``WARNING`` dan diatasnya untuk penangannya.
\nPilihan lain dalam konfigurasi (seperti pilihan level atau formatter dari penangan) dapat dikelola dengan cara yang sama.