Django生产环境日志配置指南:从文件记录到错误报警
本文详解Django在生产环境(DEBUG=False)下的日志配置方案。通过合理设置Logger、Handler及Formatter,实现将INFO及以上级别日志写入文件,同时将ERROR及以上级别的严重错误通过邮件自动通知管理员。内容涵盖logging模块核心组件解析及settings.py中的完整配置代码示例,帮助开发者建立完善的错误监控机制。
当Django项目正式部署上线后,通常需要将DEBUG设置为False以关闭调试模式。此时,开发者如何有效监控程序在生产环境中的异常或错误?答案是使用日志系统(logging)。在默认配置下,Django在生产环境中不会自动生成日志文件,即使发生error级别的故障也不会主动通知管理员。本文将指导您如何在Django项目中正确配置日志系统,生成日志文件,并在程序出现error级别故障时自动通知管理员。
日志基础知识
日志与软件程序运行紧密相关,它记录了程序的执行状态,为调试程序和故障排查提供关键信息。每一条日志记录都对应一个特定事件,具体包含以下要素:
- 事件发生的具体时间
- 事件发生的代码位置
- 事件的严重程度,即日志级别
- 事件的具体内容描述
日志级别通常划分为以下几类:
- DEBUG:用于调试目的的低级系统信息
- INFO:一般性的系统运行信息
- WARNING:描述已发生的小问题或潜在风险的信息
- ERROR:描述已发生的主要问题的信息
- CRITICAL:描述已发生的严重问题,可能导致系统崩溃的信息
在Django项目中,我们可以针对不同日志级别设置不同的处理策略。例如,将INFO级别及以上的日志写入日志文件进行持久化保存,而将Error级别及以上的日志直接通过邮件发送给系统管理员,以便及时响应。
Django的日志模块
Django的日志模块基于Python标准的logging模块,主要由以下四个部分组成:
- Logger(记录仪):负责生成和记录每条日志信息及对应的级别
- Handler(处理程序):根据日志信息的级别,将其交由相应的处理程序处理(如生成文件或发送邮件)
- Filters(过滤器):在日志交由处理程序处理前,需满足的过滤条件(例如判断Debug=True或False)
- Formatter(格式化程序):决定每条日志的打印输出格式,可以定义完整版或简单版格式
以下是一个Logger记录仪的示例。当程序运行出现错误时,它会生成一条级别为error的日志信息。该记录生成后,将被交由Handler进行处理。
# import the logging library
import logging
# 获得logger实例
logger = logging.getLogger(__name__)
def my_view(request, arg1, arg):
...
if error_happens:
# Log an error message
logger.error('Something went wrong!')
当Debug=True时,日志信息默认会在控制台(console)输出。现在,我们需要在Django配置文件中配置日志(logging)相关内容,使得当Debug=False时,日志信息能够输出到日志文件中,或者在发生严重错误时发送给系统管理员。
settings.py推荐日志配置信息
以下基本配置信息在django cookiecutter推荐使用的logging配置基础上进行了修改,可适用于大部分项目。如果希望实现邮件发送和接收功能,还需在settings.py中正确配置电子邮箱(Email)相关设置。
# 给ADMINS发送邮件需要配置
ADMINS = (
('admin_name','your@gmail.com'),
)
MANAGERS = ADMINS
# 创建log文件的文件夹
LOG_DIR = os.path.join(BASE_DIR, "logs")
# 基本配置,可以复用的
LOGGING = {
"version": 1,
"disable_existing_loggers": False,
"filters": {"require_debug_false": {"()": "django.utils.log.RequireDebugFalse"}},
"formatters": { # 定义了两种日志格式
"verbose": { # 标准
"format": "%(levelname)s %(asctime)s %(module)s "
"%(process)d %(thread)d %(message)s"
},
'simple': { # 简单
'format': '[%(levelname)s][%(asctime)s][%(filename)s:%(lineno)d]%(message)s'
},
},
"handlers": { # 定义了三种日志处理方式
"mail_admins": { # 只有debug=False且Error级别以上发邮件给admin
"level": "ERROR",
"filters": ["require_debug_false"],
"class": "django.utils.log.AdminEmailHandler",
},
'file': { # Info级别以上保存到日志文件
'level': 'INFO',
'class': 'logging.handlers.RotatingFileHandler', # 保存到文件,根据文件大小自动切
'filename': os.path.join(LOG_DIR,"info.log"), # 日志文件
'maxBytes': 1024 * 1024 * 10, # 日志大小 10M
'backupCount': 2, # 备份数为 2
'formatter': 'simple', # 简单格式
'encoding': 'utf-8',
},
"console": { # 打印到终端console
"level": "DEBUG",
"class": "logging.StreamHandler",
"formatter": "verbose",
},
},
"root": {"level": "INFO", "handlers": ["console"]},
"loggers": {
"django.request": { # Django的request发生error会自动记录
"handlers": ["mail_admins"],
"level": "ERROR",
"propagate": True, # 向不向更高级别的logger传递
},
"django.security.DisallowedHost": { # 对于不在 ALLOWED_HOSTS 中的请求不发送报错邮件
"level": "ERROR",
"handlers": ["console", "mail_admins"],
"propagate": True,
},
},
}
以上就是Django项目如何正确配置日志(logging)的详细内容,更多关于Django正确配置日志的资料请关注本站其它相关文章!
本站声明
本文内容仅供参考,不代表本站观点。转载或引用请注明出处。如发现内容问题,请通过联系我们页面反馈。













