Django项目如何正确配置日志(logging)


Posted in Python onApril 29, 2021

当Django项目正式部署上线后,我们需要设置DEBUG = False。这时开发者应怎样检查Django程序在生产环境运行时有什么异常或错误呢?答案就是日志(logging)。在生产环境中,Django默认是不会在服务器上自动生成log文件的,即使程序出现error级别的故障也不会通知管理员。本文将教你如何在Django项目中正确配置日志(logging),让Django生成log日志文件,并在程序运行发生error级别故障时通知管理员。

日志基础知识

日志与我们的软件程序密不可分。它记录了程序的运行情况,可以给我们调试程序和故障排查提供非常有用的信息。每一条日志信息记录了一个事件的发生。具体而言,它包括了:

  • 事件发生时间
  • 事件发生位置
  • 事件的严重程度--日志级别
  • 事件内容

日志的级别又分为:

  • DEBUG:用于调试目的的低级系统信息
  • INFO:一般系统信息
  • WARNING:描述已发生的小问题的信息。
  • ERROR:描述已发生的主要问题的信息。
  • CRITICAL:描述已发生的严重问题的信息。

在Django项目中,我们可以针对日志的不同级别设置不同的处理方式。比如INFO级别及以上的日志我们写入到log文件里保存,Error级别及以上的日志我们直接通过邮件发送给系统管理员。

Django的日志模块

Django的日志模块其实就是python的logging模块。它由4部分组成:

  • Logger 记录仪:生成和记录每条日志信息及级别
  • Handler处理程序: 根据日志信息级别交由相应处理程序处理(比如生成文件或发送邮件)
  • Filters 过滤器:日志交由处理程序处理前需要满足的过滤条件(比如Debug=True或False)
  • Formaters 格式化程序:决定每条日志的打印输出格式,可以有完整版的,也有简单版的

一个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 正确配置日志的资料请关注三水点靠木其它相关文章!

Python 相关文章推荐
Python语言的12个基础知识点小结
Jul 10 Python
Python脚本文件打包成可执行文件的方法
Jun 02 Python
在Python中移动目录结构的方法
Jan 31 Python
Python实现简单的多任务mysql转xml的方法
Feb 08 Python
Python爬取qq music中的音乐url及批量下载
Mar 23 Python
Python2.7 实现引入自己写的类方法
Apr 29 Python
Python2包含中文报错的解决方法
Jul 09 Python
python多行字符串拼接使用小括号的方法
Mar 19 Python
python中map的基本用法示例
Sep 10 Python
Python3从零开始搭建一个语音对话机器人的实现
Aug 23 Python
numpy.transpose()实现数组的转置例子
Dec 02 Python
Python爬虫与反爬虫大战
Jul 30 Python
django上传文件的三种方式
Apr 29 #Python
详解Django的MVT设计模式
Django如何与Ajax交互
Apr 29 #Python
Python爬虫进阶之Beautiful Soup库详解
Apr 29 #Python
win10+anaconda安装yolov5的方法及问题解决方案
Python图像处理之图像拼接
4种非常实用的python内置数据结构
Apr 28 #Python
You might like
SESSION信息保存在哪个文件目录下以及能够用来保存什么类型的数据
2012/06/17 PHP
php解析html类库simple_html_dom(详细介绍)
2013/07/05 PHP
php中静态类与静态变量用法的区别分析
2015/01/15 PHP
ExtJS4 动态生成的grid导出为excel示例
2014/05/02 Javascript
js操作iframe父子窗体示例
2014/05/22 Javascript
jquery delay()介绍及使用指南
2014/09/02 Javascript
Nodejs中的this详解
2016/03/26 NodeJs
jquery validate表单验证插件
2016/09/06 Javascript
微信小程序 wxapp地图 map详解
2016/10/31 Javascript
微信小程序开发(二)图片上传+服务端接收详解
2017/01/11 Javascript
为什么我们要做三份 Webpack 配置文件
2017/09/18 Javascript
vue中实现在外部调用methods的方法(推荐)
2018/02/08 Javascript
vue判断input输入内容全是空格的方法
2018/03/02 Javascript
Vue服务端渲染实践之Web应用首屏耗时最优化方案
2019/03/22 Javascript
[48:32]2018DOTA2亚洲邀请赛 3.31 小组赛 A组 LGD vs VG
2018/04/01 DOTA
在Python上基于Markov链生成伪随机文本的教程
2015/04/17 Python
Python实现的彩票机选器实例
2015/06/17 Python
Python IDE PyCharm的基本快捷键和配置简介
2015/11/04 Python
浅谈Python单向链表的实现
2015/12/24 Python
python 2.6.6升级到python 2.7.x版本的方法
2016/10/09 Python
Python基于OpenCV实现视频的人脸检测
2018/01/23 Python
Python 爬虫之Beautiful Soup模块使用指南
2018/07/05 Python
Python3实现的回文数判断及罗马数字转整数算法示例
2019/03/27 Python
python将print输出的信息保留到日志文件中
2019/09/27 Python
Python 模拟动态产生字母验证码图片功能
2019/12/24 Python
python给指定csv表格中的联系人群发邮件(带附件的邮件)
2019/12/31 Python
django-利用session机制实现唯一登录的例子
2020/03/16 Python
python压包的概念及实例详解
2021/02/17 Python
Skyscanner澳大利亚:全球领先的旅游搜索网站
2018/03/24 全球购物
毕业生就业推荐信范文
2013/12/01 职场文书
酒店管理毕业生自荐信
2014/05/25 职场文书
民主评议党员总结
2014/10/20 职场文书
初中毕业感言300字
2015/07/31 职场文书
企业年会祝酒词
2015/08/11 职场文书
2016年圣诞节寄语(一句话)
2015/12/07 职场文书
2019年汽车租赁合同范本!
2019/08/12 职场文书