首页 > 脚本专栏 > python > Django logging日志模块

Django logging日志模块实例详解(日志记录模板配置)

2022-08-21 09:43:13 作者：在奋斗的大道

Django使用python自带的logging作为日志打印工具,下面这篇文章主要给大家介绍了Django logging日志模块(日志记录模板配置)的相关资料,文中通过示例代码介绍的非常详细,需要的朋友可以参考下

一.Django日志

Django使用python内建的logging模块打印日志，Python的logging配置由四个部分组成：

1>.记录器（Logger）

2>.处理程序（Handler）

3>.过滤器（Filter）

4>.格式化（Formatter）

二、Logger 记录器

Logger 是日志系统的入口。每个 logger 都是命名了的 bucket，消息写入 bucket 以便进一步处理。

Logger 可以配置日志级别。日志级别描述了由该 logger 处理的消息的严重性。Python 定义了下面几种日志级别：

DEBUG：排查故障时使用的低级别系统信息
INFO：一般的系统信息
WARNING：描述系统发生了一些小问题的信息
ERROR：描述系统发生了大问题的信息
CRITICAL：描述系统发生严重问题的信息

每一条写入 logger 的消息都是一条日志记录。每一条日志记录也包含日志级别，代表对应消息的严重程度。日志记录还包含有用的元数据，来描述被记录的事件细节，例如堆栈跟踪或者错误码。

当 logger 处理一条消息时，会将自己的日志级别和这条消息的日志级别做对比。如果消息的日志级别匹配或者高于 logger 的日志级别，它就会被进一步处理。否则这条消息就会被忽略掉。

当 logger 确定了一条消息需要处理之后，会把它传给 Handler。

Django 内置记录器

类	类功能描述
django.request	请求处理相关的日志消息。5xx响应被提升为错误消息；4xx响应被提升为警告消息。
django.server	由RunServer命令调用的服务器所接收的请求的处理相关的日志消息。HTTP 5XX响应被记录为错误消息，4XX响应被记录为警告消息，其他一切都被记录为INFO。
django.template	与模板呈现相关的日志消息
django.db.backends	有关代码与数据库交互的消息。例如，请求执行的每个应用程序级SQL语句都在调试级别记录到此记录器。

三、Handler 处理程序

Handler 是决定如何处理 logger 中每一条消息的引擎。它描述特定的日志行为，比如把消息输出到屏幕、文件或网络 socket。

和 logger 一样，handler 也有日志级别的概念。如果一条日志记录的级别不匹配或者低于 handler 的日志级别，对应的消息会被 handler 忽略。

一个 logger 可以有多个 handler，每一个 handler 可以有不同的日志级别。这样就可以根据消息的重要性不同，来提供不同格式的输出。例如，你可以添加一个 handler 把 ERROR 和 CRITICAL 消息发到寻呼机，再添加另一个 handler 把所有的消息（包括 ERROR 和 CRITICAL 消息）保存到文件里以便日后分析。

Logging 自身携带Handler

logging模块提供了一些处理器，可以通过各种方式处理日志消息。

类名	功能描述
logging.StreamHandler	类似与sys.stdout或者sys.stderr的任何文件对象(file object)输出信息
logging.FileHandler	将日志消息写入文件filename。
logging.handlers.DatagramHandler(host，port)	发送日志消息给位于制定host和port上的UDP服务器。使用UDP协议，将日志信息发送到网络
logging.handlers.HTTPHandler(host, url)	使用HTTP的GET或POST方法将日志消息上传到一台HTTP 服务器。
logging.handlers.RotatingFileHandler(filename)	将日志消息写入文件filename。如果文件的大小超出maxBytes制定的值，那么它将被备份为filenamel。
logging.handlers.SocketHandler	使用TCP协议，将日志信息发送到网络。
logging.handlers.SysLogHandler	日志输出到syslog
logging.handlers.NTEventLogHandler	远程输出日志到Windows NT/2000/XP的事件日志
logging.handlers.SMTPHandler	远程输出日志到邮件地址
logging.handlers.MemoryHandler	日志输出到内存中的制定buffer

注意：由于内置处理器还有很多，如果想更深入了解。可以查看官方手册。

四、Filter过滤器

在日志从 logger 传到 handler 的过程中，使用 Filter 来做额外的控制。

默认情况下，只要级别匹配，任何日志消息都会被处理。不过，也可以通过添加 filter 来给日志处理的过程增加额外条件。例如，可以添加一个 filter 只允许某个特定来源的 ERROR 消息输出。

Filter 还被用来在日志输出之前对日志记录做修改。例如，可以写一个 filter，当满足一定条件时，把日志记录从 ERROR 降到 WARNING 级别。

Filter 在 logger 和 handler 中都可以添加；多个 filter 可以链接起来使用，来做多重过滤操作。

五、Formatters格式化器

日志记录最终是需要以文本来呈现的。Formatter 描述了文本的格式。一个 formatter 通常由包含 LogRecord attributes 的 Python 格式化字符串组成，不过你也可以为特定的格式来配置自定义的 formatter。

格式	描述
%(name)s	记录器 logger 的名字
%(levelno)s	数据形式的日志记录级别
%(levelname)s	文本形式的日志记录级别
%(filename)s	执行日志记录调用的源文件的文件名
%(pathname)s	执行日志记录调用的源文件的全路径+文件名
%(funcName)s	执行日志记录调用的函数名称
%(module)s	调用的模块名称，django是 app 的名称
%(lineno)d	记录调用的行号
%(created)s	执行日志记录的时间
%(asctime)s	日期时间
%(msecs)s	毫秒部分
%(thread)s	线程ID
%(threadName)s	线程名称
%(process)d	进程ID
%(message)s	记录的消息，自定义内容

时间格式参数:

格式	描述
'S'	Seconds
'M'	Minutes
'H'	Hours
'D'	Days
'W0' - 'W6'	Weekday (0=Monday)
'midnight'	Roll over at midnight

六：Django 集成日志logginger 模块

1、在项目setting.py 文件中，配置logginger 日志, 核心代码如下：

# 日志配置
LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'verbose': {
            'format': '{levelname} {asctime} {module} {process:d} {thread:d} {message}',
            'style': '{',
        },
        'simple': {
            'format': '{levelname} {message}',
            'style': '{',
        },
        "default": {
            "format": '%(asctime)s %(name)s  %(pathname)s:%(lineno)d %(module)s:%(funcName)s '
                      '%(levelname)s- %(message)s',
            "datefmt": "%Y-%m-%d %H:%M:%S"
        },
    },
    'handlers': {
        'console': {
            'level': 'DEBUG',
            'class': 'logging.StreamHandler',
            'formatter': 'default'
        },
        'file': {
            'level': 'DEBUG',
            'class': 'logging.handlers.TimedRotatingFileHandler',
            'filename': os.path.join(BASE_DIR, 'logs/debug.log'),
            'when': "D",
            'interval': 1,
            'formatter': 'default'
        },
        "request": {
            'level': 'DEBUG',
            'class': 'logging.FileHandler',
            'filename': os.path.join(BASE_DIR, 'logs/request.log'),
            'formatter': 'default'
        },
        "server": {
            'level': 'DEBUG',
            'class': 'logging.FileHandler',
            'filename': os.path.join(BASE_DIR, 'logs/server.log'),
            'formatter': 'default'
        },
        "root": {
            'level': 'DEBUG',
            'class': 'logging.FileHandler',
            'filename': os.path.join(BASE_DIR, 'logs/root.log'),
            'formatter': 'default'
        },
 
        "db_backends": {
            'level': 'DEBUG',
            'class': 'logging.FileHandler',
            'filename': os.path.join(BASE_DIR, 'logs/db_backends.log'),
            'formatter': 'default'
        },
        "autoreload": {
            'level': 'INFO',
            'class': 'logging.FileHandler',
            'filename': os.path.join(BASE_DIR, 'logs/autoreload.log'),
            'formatter': 'default'
        }
    },
    'loggers': {
        # 应用中自定义日志记录器
        'mylogger': {
            'level': 'DEBUG',
            'handlers': ['console', 'file'],
            'propagate': True,
        },
        "django": {
            "level": "DEBUG",
            "handlers": ["console", "file"],
            'propagate': False,
        },
        "django.request": {
            "level": "DEBUG",
            "handlers": ["request"],
            'propagate': False,
        },
        "django.server": {
            "level": "DEBUG",
            "handlers": ["server"],
            'propagate': False,
        },
        "django.db.backends": {
            "level": "DEBUG",
            "handlers": ["db_backends"],
            'propagate': False,
        },
        "django.utils.autoreload": {
            "level": "INFO",
            "handlers": ["autoreload"],
            'propagate': False,
        }
    },
    'root': {
        "level": "DEBUG",
        "handlers": ["root"],
    }
}

2、应用中添加logginger 日志记录

1、在应用的views.py 文件中添加logging 模块依赖，并在相关方法中输出相关日志记录

import logging
 
# 日志输出常量定义
logger = logging.getLogger('mylogger')

# json 数据提交,并转换为实体，执行入库操作
def insertJSON(request):
    logger.info("post request body 请求数据提交")
    json_str = request.body
    json_str = json_str.decode()  # python3.6及以上不用这一句代码
    dict_data = json.loads(json_str)  # loads把str转换为dict，dumps把dict转换为str
 
    item = Book()
    objDictTool.to_obj(item, **dict_data)
    print("名称: {}, 价格: {},  作者: {}".format(item.name, item.price, item.author))
    # 执行数据库插入
    item.save()
    return response_success(message="数据入库成功")

注意：在logginer 配置文件中，定义自定义记录器mylogger 对应实例化对象就是views.py 文件中实例的logging对象。

3、日志记录结果展示:

总结

到此这篇关于Django logging日志模块的文章就介绍到这了,更多相关Django logging日志模块内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！