1. settings.py文件

做開發離不開必定離不開日誌, 以下是我在工作中寫Django項目常用的logging配置.

# 日誌配置
BASE_LOG_DIR = os.path.join(BASE_DIR, "log")

LOGGING = {
    'version': 1,  # 保留字
    'disable_existing_loggers': False,  # 是否禁用已經存在的日誌實例
    'formatters': {  # 定義日誌的格式
        'standard': {
            'format': '[%(asctime)s][%(threadName)s:%(thread)d][task_id:%(name)s][%(filename)s:%(lineno)d]'
                      '[%(levelname)s][%(message)s]'
        },
        'simple': {
            'format': '[%(levelname)s][%(asctime)s][%(filename)s:%(lineno)d]%(message)s'
        },
        'collect': {
            'format': '%(message)s'
        }
    },
    'filters': {  # 定義日誌的過濾器
        'require_debug_true': {
            '()': 'django.utils.log.RequireDebugTrue',
        },
    },
    'handlers': {  # 日誌處理程序
        'console': {
            'level': 'DEBUG',
            'filters': ['require_debug_true'],  # 只有在Django debug為True時才在屏幕打印日誌
            'class': 'logging.StreamHandler',
            'formatter': 'simple'
        },
        'SF': {
            'level': 'INFO',
            'class': 'logging.handlers.RotatingFileHandler',  # 保存到文件，根據文件大小自動切
            'filename': os.path.join(BASE_LOG_DIR, "xxx_info.log"),  # 日誌文件
            'maxBytes': 1024 * 1024 * 500,  # 日誌大小 50M（最好不要超過1G）
            'backupCount': 3,  # 備份數為3  xx.log --> xx.log.1 --> xx.log.2 --> xx.log.3
            'formatter': 'standard',
            'encoding': 'utf-8',  # 文件記錄的編碼格式
        },
        'TF': {
            'level': 'INFO',
            'class': 'logging.handlers.TimedRotatingFileHandler',  # 保存到文件，根據時間自動切
            'filename': os.path.join(BASE_LOG_DIR, "xxx_info.log"),  # 日誌文件
            'backupCount': 3,  # 備份數為3  xx.log --> xx.log.2018-08-23_00-00-00 --> xx.log.2018-08-24_00-00-00 --> ...
            'when': 'D',  # 每天一切， 可選值有S/秒 M/分 H/小時 D/天 W0-W6/周(0=周一) midnight/如果沒指定時間就默認在午夜
            'formatter': 'standard',
            'encoding': 'utf-8',
        },
        'error': {
            'level': 'ERROR',
            'class': 'logging.handlers.RotatingFileHandler',  # 保存到文件，自動切
            'filename': os.path.join(BASE_LOG_DIR, "xxx_err.log"),  # 日誌文件
            'maxBytes': 1024 * 1024 * 5,  # 日誌大小 50M
            'backupCount': 5,
            'formatter': 'standard',
            'encoding': 'utf-8',
        },
        'collect': {
            'level': 'INFO',
            'class': 'logging.handlers.RotatingFileHandler',  # 保存到文件，自動切
            'filename': os.path.join(BASE_LOG_DIR, "xxx_collect.log"),
            'maxBytes': 1024 * 1024 * 50,  # 日誌大小 50M
            'backupCount': 5,
            'formatter': 'collect',
            'encoding': "utf-8"
        }
    },
    'loggers': {  # 日誌實例
        '': {  # 默認的logger應用如下配置
            'handlers': ['SF', 'console', 'error'],  # 上線之後可以把'console'移除
            'level': 'DEBUG',
            'propagate': True,  # 是否向上一級logger實例傳遞日誌信息
        },
        'collect': {  # 名為 'collect' 的logger還單獨處理
            'handlers': ['console', 'collect'],
            'level': 'INFO',
        }
    },
}
 

2. 在Django根目錄下創建log文件夾

3. logging的使用

有了logging配置之後, 我們在今後的項目中, 就盡量不再使用print語句來打印信息, 進行BUG調試. 更專業的我們將使用logger對象來保存並打印錯誤信息.

例如:

import logging

# 實例化logging對象,並以當前文件的名字作為logger實例的名字
logger = logging.getLogger(__name__)
# 生成一個名字叫做 collect 的日誌實例
logger_c = logging.getLogger('collect')

class Foo(object):
    def test(self, data):
        logger.debug(data)  # 打印data
        try:
            ...
        except Exception as e:
            logger.error(str(e))    # 保存並打印錯誤信息
 

Django之logging配置