Django集成logging模块
django日志记录
使用python内置的logging模块打印日志，python的logging模块分为四部分组成：
- 记录器（loggers）
- 处理程序（handlers）
- 过滤器（Filter）
- 格式化（formatters）
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中集成logging模块
在项目setting.py 文件中，配置logginger 日志, 核心代码如下：
# 日志配置
LOGGING = {
'version': 1, # 日志记录器的版本号，默认为1
'disable_existing_loggers': False, # 是否禁用已经存在的日志记录器，False表示不禁用
'loggers': { # 定义日志记录器
'mylogger': { # 应用中自定义的日志记录器
'level': 'INFO', # 日志级别设置为DEBUG及以上
'handlers': ['console', 'file'], # 使用控制台和文件两个处理器
'propagate': True, # 允许日志向上传播
},
"django": { # Django框架的日志记录器
"level": "DEBUG", # 日志级别设置为DEBUG及以上
"handlers": ["console", "file"], # 使用控制台和文件两个处理器
'propagate': False, # 不允许日志向上传播
},
"django.request": { # Django请求相关的日志记录器
"level": "INFO", # 日志级别设置为DEBUG及以上
"handlers": ["request"], # 使用请求日志处理器
'propagate': False, # 不允许日志向上传播
},
"django.server": { # Django服务器相关的日志记录器
"level": "DEBUG", # 日志级别设置为DEBUG及以上
"handlers": ["server"], # 使用服务器日志处理器
'propagate': False, # 不允许日志向上传播
},
"django.db.backends": { # Django数据库后端相关的日志记录器
"level": "DEBUG", # 日志级别设置为DEBUG及以上
"handlers": ["db_backends"], # 使用数据库后端日志处理器
'propagate': False, # 不允许日志向上传播
},
"django.utils.autoreload": { # Django自动重载相关的日志记录器
"level": "INFO", # 日志级别设置为INFO及以上
"handlers": ["autoreload"], # 使用自动重载日志处理器
'propagate': False, # 不允许日志向上传播
}
},
'handlers': { # 定义处理器
'console': { # 控制台输出处理器
'level': 'INFO', # 日志级别设置为DEBUG及以上
'class': 'logging.StreamHandler', # 处理器类型为流处理器（控制台）
'formatter': 'default' # 使用默认格式
},
'file': { # 文件输出处理器（按天分割）
'level': 'DEBUG', # 日志级别设置为DEBUG及以上
'class': 'logging.handlers.TimedRotatingFileHandler', # 处理器类型为按时间轮转的文件处理器
'filename': os.path.join(BASE_DIR, 'logs/debug.log'), # 日志文件路径
'when': "D", # 按天分割
'interval': 1, # 每日一个日志文件
'formatter': 'default' # 使用默认格式
},
"request": { # HTTP请求日志处理器
'level': 'INFO', # 日志级别设置为DEBUG及以上
'class': 'logging.FileHandler', # 处理器类型为文件处理器
'filename': os.path.join(BASE_DIR, 'logs/request.log'), # 日志文件路径
'formatter': 'default' # 使用默认格式
},
"server": { # HTTP服务器日志处理器
'level': 'DEBUG', # 日志级别设置为DEBUG及以上
'class': 'logging.FileHandler', # 处理器类型为文件处理器
'filename': os.path.join(BASE_DIR, 'logs/server.log'), # 日志文件路径
'formatter': 'default' # 使用默认格式
},
"root": { # 根日志处理器
'level': 'DEBUG', # 日志级别设置为DEBUG及以上
'class': 'logging.FileHandler', # 处理器类型为文件处理器
'filename': os.path.join(BASE_DIR, 'logs/root.log'), # 日志文件路径
'formatter': 'default' # 使用默认格式
},
"db_backends": { # Django数据库后端日志处理器
'level': 'DEBUG', # 日志级别设置为DEBUG及以上
'class': 'logging.FileHandler', # 处理器类型为文件处理器
'filename': os.path.join(BASE_DIR, 'logs/db_backends.log'), # 日志文件路径
'formatter': 'default' # 使用默认格式
},
"autoreload": { # Django自动重载日志处理器
'level': 'INFO', # 日志级别设置为INFO及以上
'class': 'logging.FileHandler', # 处理器类型为文件处理器
'filename': os.path.join(BASE_DIR, 'logs/autoreload.log'), # 日志文件路径
'formatter': 'default' # 使用默认格式
}
},
'formatters': { # 定义日志格式
'verbose': { # 详细日志格式
'format': '{levelname} {asctime} {module} {process:d} {thread:d} {message}', # 日志信息包含等级、时间、模块、进程ID、线程ID和消息
'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" # 时间格式
},
},
'root': { # 根日志记录器配置
"level": "DEBUG", # 日志级别设置为DEBUG及以上
"handlers": ["root"], # 使用根日志处理器
}
}
程序中添加logginger 日志记录
import logging
# 日志输出常量定义
logger = logging.getLogger('mylogger')
注意：在logginer 配置文件中，定义自定义记录器mylogger 对应实例化对象就是views.py 文件中实例的logging对象。
浙公网安备 33010602011771号