【Django】如何在Django中配置logging

📝 技术文档：如何在Django中配置logging

背景

在Django应用程序中，logging是一个非常重要的模块，它可以帮助我们记录应用程序的运行状态，以便在出现问题时进行排查。logging模块可以将日志输出到控制台、文件、邮件等地方，还可以设置日志级别、日志格式等。

需求

本文将介绍如何在Django中配置logging，以便记录应用程序的运行状态。具体来说，我们将实现以下需求：

• 将日志输出到控制台和文件中；
• 按天分割日志文件，保存7天的日志文件；
• 将日志文件存放在名为’log’的文件夹中。

代码实现

我们可以在Django的settings.py文件中配置logging。具体来说，我们需要进行以下步骤：

1. 导入logging模块和os模块；
2. 配置logging，包括设置日志级别、日志格式、日志输出方式等；
3. 在代码中使用logging模块的方法记录日志。

以下是完整的代码实现：

import logging
import os
from logging.handlers import TimedRotatingFileHandler

# 日志配置
LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'verbose': {
            'format': '%(asctime)s %(levelname)s [%(threadName)s] [%(filename)s:%(lineno)d in %(funcName)s] %(message)s'
        },
        'simple': {
            'format': '%(levelname)s %(message)s'
        },
    },
    'handlers': {
        'console': {
            'class': 'logging.StreamHandler',
            'formatter': 'verbose'
        },
        'file': {
            'class': 'logging.handlers.TimedRotatingFileHandler',
            'filename': os.path.join('log', 'django.log'),
            'when': 'D',
            'interval': 1,
            'backupCount': 7,  # 保存7天的日志文件
            'encoding': 'utf-8',
            'formatter': 'verbose'
        },
    },
    'loggers': {
        'django': {
            'handlers': ['console', 'file'],
            'level': 'DEBUG',
        },
    },
}

# 记录日志
logger = logging.getLogger(__name__)
logger.info('hello')

在上面的代码中，我们首先导入了logging模块和os模块。然后，我们配置了logging，包括设置日志级别为DEBUG，日志格式为"[时间] [级别] [线程名] [文件名:行号 in 函数名] [消息]"，并将日志输出到控制台和文件中。其中，文件名为’log/django.log’，表示将日志文件存放在名为’log’的文件夹中，并命名为’django.log’。我们还设置了按天分割日志文件，保存7天的日志文件。

最后，我们使用logging模块的方法记录了一条日志，级别为INFO，消息为’彤彤’。

代码解释

• logging.getLogger(__name__)：获取logger对象，__name__表示当前模块的名称；
• logger.info('hello')：使用logger对象记录一条日志，级别为INFO，消息为’hello’；
• os.path.join('log', 'django.log')：使用os模块的join方法将’log’和’django.log’拼接成完整的路径；
• TimedRotatingFileHandler：按时间分割日志文件的handler，可以设置when、interval、backupCount等参数；
• '%(asctime)s %(levelname)s [%(threadName)s] [%(filename)s:%(lineno)d in %(funcName)s] %(message)s'：日志格式，包括时间、级别、线程名、文件名、行号、函数名和消息等信息。

总结

本文介绍了如何在Django中配置logging，包括将日志输出到控制台和文件中，按天分割日志文件，保存7天的日志文件，将日志文件存放在名为’log’的文件夹中等。通过配置logging，我们可以方便地记录应用程序的运行状态，以便在出现问题时进行排查。