Django 日志配置按日期滾動

記錄下Django關於日期的配置，以及如何根據日期滾動切割日志的問題。

配置的源碼在githun上 https://github.com/blackmatrix7/django-examples/tree/master/django_logs

---

准備

環境

python 3.5.2

djang 2.0.5

創建項目

使用命令快速新建django項目，示例的項目名為proj。

開始

修改配置文件

日志部分配置，參考Django官方手冊

https://docs.djangoproject.com/en/2.0/topics/logging/#examples

LOGGING屬性實際上是一個dictConfig

關於dictConfig的配置，參考Python官方手冊

https://docs.python.org/3/library/logging.config.html#logging-config-dictschema

 

LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'verbose': {
            'format': '[%(asctime)s] [%(levelname)s] %(message)s'
        },
    },
    'handlers': {
        # 輸出日志的控制台
        'console': {
            'level': 'INFO',
            'class': 'logging.StreamHandler',
            'formatter': 'verbose'
        },
        # 輸出日志到文件，按日期滾動
        'file': {
            'level': 'DEBUG',
            'class': 'logging.handlers.TimedRotatingFileHandler',
            # TimedRotatingFileHandler的參數
            # 參照https://docs.python.org/3/library/logging.handlers.html#timedrotatingfilehandler
            # 目前設定每天一個日志文件
            'filename': 'logs/manage.log',
            'when': 'midnight',
            'interval': 1,
            'backupCount': 100,
            'formatter': 'verbose'
        },
        # 發送郵件，目前騰訊雲、阿里雲的服務器對外發送郵件都有限制，暫時不使用
        'email': {
            'level': 'ERROR',
            'class': 'django.utils.log.AdminEmailHandler',
            'include_html': True,
        }
    },
    'loggers': {
        # 不同的logger
        'django': {
            'handlers': ['console', 'file'],
            'level': 'INFO',
            'propagate': True,
        },
    },
}

創建logs目錄

cd django_logs/
mkdir logs

新增django_logs/logger.py

import logging
logger = logging.getLogger('django')

驗證

創建app

python manage.py startapp app

編寫視圖函數

編寫一個視圖函數，使用logger用於往日志文件寫入日志

django_logs/app/views.py

from logger import logger
from django.shortcuts import HttpResponse

def test_logger(request):
    logger.info('test log')
    return HttpResponse('test log')

配置Url

django_logs/proj/urls.py

from app import views
from django.contrib import admin
from django.urls import path

urlpatterns = [
    path('admin/', admin.site.urls),
    path('test_log/', views.test_logger),
]

調用

訪問 http://127.0.0.1:8000/test_log/ ，在logs/manage.log中成功寫入

[2018-05-18 08:35:44,317] [INFO] test log
[2018-05-18 08:35:44,318] [INFO] "GET /test_log/ HTTP/1.1" 200 8

最后，修改系統日期，可以看到日志文件會按天進行分割。

-----------------------------------------

日志寫入僅僅對於創建的logger對象有效，如果需要使用logging直接寫入，則需要再做一些修改：讓logging模塊使用django的dictConfig。

import logging.config
from django.conf import settings

logger = logging.getLogger('django')
logging.config.dictConfig(settings.LOGGING)

-----------------------------------------

另外，Django在多進程下運行時，此方法不可行，因為logging模塊不是進程安全的。