Django中logging的设置

1.日志基础知识

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

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

日志的级别又分为：

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

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

2.Django的日志模块

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

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

2.1 Loggers

1）Logger 即记录器，是日志系统的入口。它有三个重要的工作：

  • 向应用程序（也就是你的项目）公开几种方法，以便运行时记录消息
  • 根据传递给 Logger 的消息的严重性，确定消息是否需要处理
  • 将需要处理的消息传递给所有感兴趣的处理器 Handler

2） 每一条写入 Logger 的消息都是一条日志记录，每一条日志记录都包含级别，代表对应消息的严重程度。如下等级：

DEBUG：   排查故障时使用的低级别系统信息，通常开发时使用
INFO：    一般的系统信息，并不算问题
WARNING： 描述系统发生小问题的信息，但通常不影响功能
ERROR：   描述系统发生大问题的信息，可能会导致功能不正常
CRITICAL：描述系统发生严重问题的信息，应用程序有崩溃的风险

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

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

2.2 Handlers

Handler 即处理器，它的主要功能是决定如何处理 Logger 中的每一条消息，比如把消息输出到屏幕、文件或者 Email 中。

和 Logger 一样，Handler 也有级别的概念。如果一条日志记录的级别不匹配或者低于 Handler 的日志级别，则会被 Handler 忽略。

一个 Logger 可以有多个 Handler，每一个 Handler 可以有不同的日志级别。这样就可以根据消息的重要性不同，来提供不同类型的输出。例如，你可以添加一个 Handler 把 ERROR 和 CRITICAL 消息发到你的 Email，再添加另一个 Handler 把所有的消息（包括 ERROR 和 CRITICAL 消息）保存到文件里。

2.3 Filters

Filter 即过滤器。在日志记录从 Logger 传到 Handler 的过程中，使用 Filter 来做额外的控制。例如，只允许某个特定来源的 ERROR 消息输出。

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

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

2.4 Formaters

Formatter 即格式化器，主要功能是确定最终输出的形式和内容。

3.settings.py推荐日志配置信息

# 给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,
        },
    },
}

 

具体可参考：https://cloud.tencent.com/developer/article/2111858

 

posted on 2023-01-01 20:52  一先生94  阅读(415)  评论(0)  编辑  收藏  举报

导航