Django logging配置

Django项目常用的logging配置。

setting中配置

BASE_LOG_DIR = os.path.join(BASE_DIR, "log")    # 配置日志的存放路径(根目录log文件夹下)
LOGGING = {
    'version': 1,   # 保留字,未用到的
    'disable_existing_loggers': False,  # 是否禁用已经存在的日志实例(django自带的报错),一般不禁用.
    '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': {    # 搜集,自定义的debug字段
            'format': '%(message)s'
        }
    },
    'filters': {    # 定义日志的过滤器
        'require_debug_true': {      # 只有在setting中的 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 * 50,  # 日志大小 50M(最好不要超过1G)
            'backupCount': 3,  # 备份数为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'],     # 去掉 'console' 就不会在终端打印了
            'level': 'INFO',
        }
    },
}

 

使用:

import logging
# 实例化log对象 logger
# 通常用当前文件的名字作为logger实例的名字
logger = logging.getLogger(__name__)

    或者自定义:

import logging
# 实例化log对象 logger
logger = logging.getLogger('collect')

在平时打印的地方可以使用

try:
    ......
excpet Exception as e:
    logger.error(str(e)) 

     再例如:

from rest_framework.views import APIView
import logging
from rest_framework.response import Response
from utils.response import BaseResponse
from django.contrib.auth import authenticate

logger = logging.getLogger(__name__)


class LoginView(APIView):

    def post(self, request, *args, **kwargs):

        res_obj = BaseResponse()
        username = request.data.get('username')
        password = request.data.get('password')

        # 使用内置的auth模块提供的authenticate方法校验用户名密码是否正确
        user_obj = authenticate(username=username, password=password)
        logger.debug('username:{}'.format(username))    # 这里可以使用.一行只能写一个
        logger.debug('password:{}'.format(password))    # 这里可以使用.一行只能写一个

        if user_obj:
            logger.debug('用户名和密码正确')    # 这里可以使用
        else:
            logger.debug('用户名或密码错误')    # 这里可以使用
            res_obj.code = 1
            res_obj.msg = '用户名或密码错误'

        return Response(res_obj.dict)

 

就可以了

 

 

附：Python logger流示图