Django基础教程（166）Django日志之Django日志简介：别让Bug溜走！Django日志：你的代码“行车记录仪”与“刑侦手册”

嘿，伙计们！想象一下这个场景：你的Django网站在本地跑得那叫一个丝滑，你信心满满地部署上线。结果，用户反馈说：“页面白屏了！”“我提交的表单没反应！” 而你，对着服务器一脸茫然，只能靠猜：“到底哪出问题了？”

这时候，如果你还在用最原始的 print(“Here!!!!”) 大法来调试，那就好比在信息时代用飞鸽传书——不是不行，是效率太低且容易丢“鸽”啊！

要想成为一名优雅的、不秃顶的（划重点）程序员，你必须学会使用Django的终极神器——日志系统。它不是你想象中那个枯燥的配置文件，而是你项目的 “全天候行车记录仪” 和 “资深刑侦探长”。

第一章：日志？不就是个“高级版的print”吗？

你可以这么理解，但它比print强大了N个维度。

• print是临时工：它只在开发时出现，部署时你得一个个删掉（或者忘了删，闹出笑话）。它输出到控制台，程序一关，记录全无。
• 日志是正规军：它有组织、有纪律、有战略。你可以决定：

• • 记什么：是鸡毛蒜皮的小事（DEBUG），还是普通操作（INFO），或是严重的错误（ERROR）？
  • 记到哪里：是输出到控制台，还是写入文件，甚至发送邮件或Slack消息？
  • 什么时候记：开发环境可以事无巨细，生产环境只记关键错误，避免日志文件爆满。

所以，日志的核心价值在于：事后复盘，有据可查。当线上发生问题时，它就是你的“刑侦手册”，帮你还原案发现场。

第二章：拆解Django日志“四大家族”

想把日志玩得转，你得先认识它的四个核心概念，它们像一条生产流水线：

1. 日志记录器 - The Boss：
   它是你代码中直接调用的对象，比如 logger = logging.getLogger(‘django’)。
   它的主要工作是：

• • 接收日志消息：你告诉它：“老板，这有个错误（logger.error(“Something went wrong!”)）。”
  • 决定要不要处理：Boss有个最低级别门槛（比如INFO）。如果消息级别低于这个门槛（比如DEBUG），Boss直接无视，提高效率。

1. 处理器 - The Doer：
   Boss接到消息后，得派小弟去执行。这些小弟就是处理器，它们决定消息的去向。

• • StreamHandler：输出到控制台。
  • FileHandler：写入到指定的文件。
  • SMTPHandler：发送邮件报警。
  • （你可以想象，还可以有DatabaseHandler， SlackHandler等等）

1. 过滤器 - The Gatekeeper：
   一个可选的“看门人”，提供比Boss更精细的过滤。比如，只允许来自特定IP的错误消息被记录。
2. 格式化器 - The Designer：
   它决定了日志消息最终长什么样。原始消息可能就是个字符串，经过设计师的打扮，可以变成：
   2023-10-27 14:35:21 [ERROR] myapp.views: Something went wrong! User ID: 42
   看，时间、级别、模块、具体错误、甚至用户ID，一目了然！

它们如何协同工作？
你调用 logger.info(“A user logged in”) -> Boss（Logger）觉得INFO级别够格 -> 交给看门人（Filter，可选）审核 -> 然后派给所有小弟（Handlers）-> 每个小弟找来自己的设计师（Formatter）把消息打扮漂亮 -> 最后，小弟把打扮好的消息送到各自的目的地（控制台、文件等）。

第三章：手把手配置你的“侦探事务所”

理论说再多，不如动手配。Django的日志在 settings.py 中配置。下面我们一步步搭建一个实用且健壮的日志系统。

场景设定：

• 开发环境：所有日志（包括DEBUG）都输出到控制台，方便调试。
• 生产环境：将ERROR及以上级别的错误单独记录到一个文件中，并长期保存；将INFO及以上级别的常规操作记录到另一个文件，定期轮换，避免过大。

以下是 settings.py 中的完整配置示例：

# settings.py

LOGGING = {
    'version': 1, # 这是必须的，表示使用dictConfig格式版本1
    'disable_existing_loggers': False, # 很重要！保持其他库（如Django自身）的日志器可用

    # 第一站：请来我们的设计师们（格式化器）
    'formatters': {
        'verbose': {
            'format': '{levelname} {asctime} {module} {process:d} {thread:d} {message}',
            'style': '{', # 使用str.format()风格
        },
        'simple': {
            'format': '{levelname} {message}',
            'style': '{',
        },
        'custom_file': {
            'format': '[{asctime}] | {levelname} | IN {module} | MESSAGE: {message}',
            'style': '{',
        }
    },

    # 第二站：雇佣我们的小弟们（处理器），并给他们分配设计师
    'handlers': {
        # 开发环境的好伙伴：控制台输出
        'console': {
            'level': 'DEBUG', # 捕获所有级别
            'class': 'logging.StreamHandler',
            'formatter': 'simple'
        },
        # 专门抓ERROR及以上级别错误的“哨兵”，写入文件
        'file_errors': {
            'level': 'ERROR',
            'class': 'logging.handlers.RotatingFileHandler', # 使用轮替文件处理器，防止单个文件过大
            'filename': '/var/log/django/myapp_errors.log', # 请确保该路径有写入权限！
            'maxBytes': 1024 * 1024 * 5, # 5MB
            'backupCount': 5, # 最多保留5个备份文件
            'formatter': 'custom_file',
        },
        # 记录所有INFO及以上常规操作的“书记官”
        'file_general': {
            'level': 'INFO',
            'class': 'logging.handlers.TimedRotatingFileHandler', # 按时间轮替
            'filename': '/var/log/django/myapp_general.log',
            'when': 'midnight', # 每天午夜轮替
            'backupCount': 30, # 保留30天的日志
            'formatter': 'verbose',
        },
    },

    # 第三站：配置我们的Boss们（日志记录器），并给他们分配小弟
    'loggers': {
        # 捕获Django自身产生的所有日志
        'django': {
            'handlers': ['console', 'file_general', 'file_errors'],
            'level': 'INFO', # 捕获INFO及以上级别
            'propagate': False, # 防止向上（到root logger）传递，避免重复记录
        },
        # 为你自己的应用创建一个专门的Boss
        'myapp': { # 请将'myapp'替换成你的应用名
            'handlers': ['console', 'file_general', 'file_errors'],
            'level': 'DEBUG', # 在开发时，你可以设为DEBUG看更详细的信息
            'propagate': False,
        },
        # 如果你发现数据库查询很慢，可以启用这个记录器来查看所有SQL查询
        # 'django.db.backends': {
        #     'handlers': ['console'],
        #     'level': 'DEBUG',
        #     'propagate': False,
        # },
    },
}

配置解析与避坑指南：

• disable_existing_loggers: 一定要设为 False！否则你会把Django内置的或其他第三方库的日志器全部禁用，导致很多重要的日志消失。
• RotatingFileHandler 和 TimedRotatingFileHandler：这是生产环境的必备，防止日志文件无限膨胀，吃光你的磁盘空间。
• 文件路径权限：这是最常见的坑！确保Django运行的用户（如 www-data, nginx等）对 /var/log/django/ 目录有读写权限。在Linux上，通常需要 sudo mkdir /var/log/django 和 sudo chown -R $USER:www-data /var/log/django 之类的命令。

第四章：在代码中召唤你的“侦探助手”

配置好了“事务所”，现在该在代码里派活啦！

在你的Django应用（比如 views.py, models.py）中，这样使用：

# myapp/views.py
import logging

# 获取我们为‘myapp’配置的专属Boss（Logger）
logger = logging.getLogger('myapp')

def my_sensitive_view(request):
    user = request.user

    # 1. 记录普通操作信息
    logger.info(f"用户 {user.username} 正在访问敏感页面。")

    try:
        # 一些可能会出错的业务逻辑
        result = some_risky_operation()
        logger.debug(f"风险操作执行成功，结果是：{result}") # DEBUG信息，生产环境可能看不到

    except Exception as e:
        # 2. 记录异常！这是最重要的用法！
        # 使用exc_info=True，它会自动记录完整的异常堆栈跟踪（Traceback）
        logger.error(
            f"用户 {user.id} 在执行风险操作时发生错误：{e}",
            exc_info=True # <--- 关键！
        )
        # 返回错误信息给用户
        return HttpResponse("Oops, something went wrong!", status=500)

    # 3. 记录一些警告
    if result == "unexpected_value":
        logger.warning(f"用户 {user.username} 得到了一个非预期的结果。")

    return HttpResponse("All good!")

关键技巧：

• exc_info=True：这是记录错误的灵魂！有了它，日志里就会有完整的错误堆栈，告诉你错误发生在哪一行，就像在案发现场拍了张高清照片。
• 使用不同的级别：不要什么都用 error。操作记录用 info，可疑情况用 warning，真正的崩溃再用 error。

第五章：实战演练 & 高级玩法

现在，启动你的服务器。当你访问这个视图时：

• 开发环境：控制台会刷刷地打印出所有INFO， DEBUG， ERROR信息。
• 生产环境：

• • 用户的登录、访问等普通信息会按天被记录到 myapp_general.log。
  • 一旦发生异常，详细的错误堆栈会被记录到 myapp_errors.log，方便你每天巡检。

高级玩法：

• 邮件报警：配置一个 SMTPHandler，当发生 ERROR 或 CRITICAL 错误时，自动发邮件到你的邮箱，让你第一时间感知线上事故。
• 日志集中管理：在大型架构中，可以使用像 Sentry， Logstash 这样的服务。它们有对应的日志处理器，可以将所有服务器的日志收集到一个地方，进行可视化分析和报警，这才是真正的“现代化作战指挥中心”。

结语

看，Django日志并不神秘，对吧？它只是一个需要你耐心配置一次的、极其强大的工具。从今天起，告别 print 游击队，拥抱日志正规军。

配置好你的“代码行车记录仪”，让你的项目从此运行在可观测、可追溯的阳光下。当你的同事还在为线上Bug焦头烂额时，你只需轻点鼠标，打开日志文件，微微一笑：“凶手就是你！”

祝你 logging 愉快！