Django 日志配置详解

原创已于 2025-08-04 14:19:10 修改 · 955 阅读 ·

本内容遵循CC 4.0 BY-SA版权协议

GEO检测

Py玩家的栈与星辰

关注

标签

#django #数据库 #sqlite #后端 #python

分类后端开发

于 2025-08-02 12:00:00 首次发布

Django深度解析专栏收录该内容

11 篇文章

订阅专栏

在开发和维护 Web 应用时，日志记录是至关重要的。它不仅帮助开发者调试问题，还能监控应用的运行状态、分析性能瓶颈等。Django 提供了灵活的日志配置机制，允许你根据需求定制日志级别、输出格式、存储位置等。

本文将详细介绍如何在 Django 中进行日志配置，包括基本概念、配置方式、常用日志处理器（Handler）、过滤器（Filter）以及一些最佳实践。

一、日志的基本概念

1. 日志级别

日志级别定义了消息的重要性等级，从低到高依次为：

DEBUG：详细的调试信息，通常仅在诊断问题时使用。
INFO：确认程序按预期工作。
WARNING：表示发生了某些非致命的问题或异常情况。
ERROR：由于更严重的问题导致某些功能无法正常工作。
CRITICAL：严重的错误，可能导致应用程序无法继续运行。

2. 日志记录器（Logger）

日志记录器是日志系统的核心组件，负责捕获日志消息并将其传递给一个或多个处理器。

3. 处理器（Handler）

处理器决定日志消息应被发送到哪里，例如控制台、文件、电子邮件等。不同的处理器可以有不同的输出格式和过滤规则。

4. 格式化器（Formatter）

格式化器用于定义日志消息的输出格式。你可以自定义日志条目的外观，如时间戳、日志级别、消息内容等。

5. 过滤器（Filter）

过滤器允许对日志消息进行进一步筛选，只有符合条件的消息才会被处理。

二、配置日志

Django 使用 Python 的 logging 模块来实现日志记录功能。所有配置都在项目的 settings.py 文件中完成。

示例配置：

LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'verbose': {
            'format': '{levelname} {asctime} {module} {process:d} {thread:d} {message}',
            'style': '{',
        },
        'simple': {
            'format': '{levelname} {message}',
            'style': '{',
        },
    },
    'handlers': {
        'console': {
            'class': 'logging.StreamHandler',
            'formatter': 'simple',
        },
        'file': {
            'level': 'DEBUG',
            'class': 'logging.FileHandler',
            'filename': 'debug.log',
            'formatter': 'verbose',
        },
    },
    'loggers': {
        'django': {
            'handlers': ['console', 'file'],
            'level': 'DEBUG',
            'propagate': True,
        },
        'myapp': {
            'handlers': ['console'],
            'level': 'INFO',
            'propagate': False,
        },
    },
}

解释：

'version': 1 表示这是标准的 logging 配置版本。
'disable_existing_loggers': False 表示不禁止现有的记录器。
'formatters' 定义了两种日志格式：

- 'verbose'：详细格式，包含时间戳、模块名、进程 ID 等信息。
- 'simple'：简洁格式，只显示日志级别和消息。

'handlers' 定义了两种处理器：

- 'console'：输出到控制台。
- 'file'：输出到文件 debug.log，并采用详细格式。

'loggers' 定义了两个记录器：

- 'django'：捕获来自 Django 内部的所有日志，并通过控制台和文件处理器输出。
- 'myapp'：专用于你的应用，只通过控制台输出，并且设置了最低日志级别为 INFO。

三、常见处理器类型

1. StreamHandler

将日志输出到流（通常是标准输出或标准错误）。适用于开发环境中的快速调试。

'console': {
    'class': 'logging.StreamHandler',
    'formatter': 'simple',
}

2. FileHandler

将日志写入到指定的文件中。适合生产环境中持久化存储日志。

'file': {
    'level': 'DEBUG',
    'class': 'logging.FileHandler',
    'filename': 'debug.log',
    'formatter': 'verbose',
}

3. RotatingFileHandler

当文件达到一定大小时自动轮换日志文件，防止单个日志文件过大。

'rotating_file': {
    'class': 'logging.handlers.RotatingFileHandler',
    'filename': 'debug.log',
    'maxBytes': 1024*1024*5,  # 5 MB
    'backupCount': 5,
    'formatter': 'verbose',
}

4. TimedRotatingFileHandler

基于时间间隔轮换日志文件，比如每天生成一个新的日志文件。

'timed_rotating_file': {
    'class': 'logging.handlers.TimedRotatingFileHandler',
    'filename': 'debug.log',
    'when': 'midnight',
    'interval': 1,
    'backupCount': 7,
    'formatter': 'verbose',
}

5. SMTPHandler

将错误级别的日志通过电子邮件发送给指定的收件人。

'email': {
    'class': 'logging.handlers.SMTPHandler',
    'mailhost': 'smtp.example.com',
    'fromaddr': 'server@example.com',
    'toaddrs': ['admin@example.com'],
    'subject': 'Error Log',
    'credentials': ('user', 'password'),
    'secure': (),
    'level': 'ERROR',
    'formatter': 'verbose',
}

四、使用日志

一旦配置好日志，就可以在代码中使用它了。

示例：

import logging

logger = logging.getLogger(__name__)

def my_view(request):
    logger.info("This is an info message")
    try:
        # Some operations
        pass
    except Exception as e:
        logger.error("An error occurred: %s", e)