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 相关文章推荐
在CentOS6上安装Python2.7的解决方法
Jan 09 Python
Python cookbook(数据结构与算法)实现对不原生支持比较操作的对象排序算法示例
Mar 15 Python
在Python运行时动态查看进程内部信息的方法
Feb 22 Python
python实现远程控制电脑
May 23 Python
Python实现网页截图(PyQT5)过程解析
Aug 12 Python
python rsync服务器之间文件夹同步脚本
Aug 29 Python
python scipy卷积运算的实现方法
Sep 16 Python
Python函数参数类型及排序原理总结
Dec 19 Python
Django的ListView超详细用法(含分页paginate)
May 21 Python
Python三维绘图之Matplotlib库的使用方法
Sep 20 Python
python中pandas.read_csv()函数的深入讲解
Mar 29 Python
matplotlib之pyplot模块实现添加子图subplot的使用
Apr 25 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
PHP set_time_limit(0)长连接的实现分析
2010/03/02 PHP
利用PHP实现图片等比例放大和缩小的方法详解
2013/06/06 PHP
PHP实现批量生成App各种尺寸Logo
2015/03/19 PHP
详解php中反射的应用
2016/03/15 PHP
php tpl模板引擎定义与使用示例
2019/08/09 PHP
JavaScript中使用Substring删除字符串最后一个字符
2013/11/03 Javascript
基于jQuery实现Div窗口震动特效代码-代码简单
2015/08/28 Javascript
js实现继承的5种方式
2015/12/01 Javascript
JavaScript实现in-place思想的快速排序方法
2016/08/07 Javascript
jquery延迟对象解析
2016/10/26 Javascript
微信小程序自定义导航隐藏和显示功能
2017/06/13 Javascript
关于 angularJS的一些用法
2017/11/29 Javascript
jQuery层叠选择器用法实例分析
2019/06/28 jQuery
JS Thunk 函数的含义和用法实例总结
2020/04/08 Javascript
[52:37]完美世界DOTA2联赛循环赛 Forest vs DM BO2第一场 10.29
2020/10/29 DOTA
Python and、or以及and-or语法总结
2015/04/14 Python
python写入xml文件的方法
2015/05/08 Python
Python和Perl绘制中国北京跑步地图的方法
2016/03/03 Python
Python实现单词翻译功能
2017/06/06 Python
python opencv实现运动检测
2018/07/10 Python
python单例模式原理与创建方法实例分析
2019/10/26 Python
在pycharm中实现删除bookmark
2020/02/14 Python
在jupyter notebook中调用.ipynb文件方式
2020/04/14 Python
Django实现任意文件上传(最简单的方法)
2020/06/03 Python
基于Tensorflow的MNIST手写数字识别分类
2020/06/17 Python
Python Opencv轮廓常用操作代码实例解析
2020/09/01 Python
Python批量修改xml的坐标值全部转为整数的实例代码
2020/11/26 Python
python 解决函数返回return的问题
2020/12/05 Python
pandas按照列的值排序(某一列或者多列)
2020/12/13 Python
纯CSS实现设置半个字符的样式
2014/07/03 HTML / CSS
挪威手表购物网站:Klokker
2016/09/19 全球购物
Python是如何进行类型转换的
2013/06/09 面试题
管理科学大学生求职信
2013/11/13 职场文书
试用期自我评价怎么写
2015/03/10 职场文书
中学生国庆节演讲稿2015
2015/07/30 职场文书
原来实习报告是这样写的呀!
2019/07/03 职场文书