logging模块

Posted 2020-11-07 游走在边缘的人

logging模块

logging最简单的用法

import logging

logging.critical(\'服务器当机！\')
logging.error(\'出现严重错误！\')

#输出结果
CRITICAL:root:服务器当机！
ERROR:root:出现严重错误！

日常级别介绍

日志级别（level)	含义
DEBUG	调试过程中使用DEBUG等级，如算法中每个循环的中间状态
INFO	处理请求或者状态变化等日常事务
WARNING	处理请求或者状态变化等日常事务
ERROR	发生错误时，如IO操作失败或者连接问题
CRITICAL	特别糟糕的事情，如内存耗尽、磁盘空间为空，一般很少使用

将日志写入到文件

import logging
# level代表日志的输出的级别，高于INFO的才会被输出到文件
logging.basicConfig(format=\'%(asctime)s %(message)s\',datefmt=\'%Y-%m-%d %I:%M:%S %p\',
                    filename=\'example.log\',
                    level=logging.INFO)
logging.debug(\'This message should go to the log file\')
logging.info(\'So should this\')
logging.warning(\'And this, too\')

日志的各种格式

%(name)s	Logger的名字
%(levelno)s	数字形式的日志级别
%(levelname)s	文本形式的日志级别
%(pathname)s	调用日志输出函数的模块的完整路径名，可能没有
%(filename)s	调用日志输出函数的模块的文件名
%(module)s	调用日志输出函数的模块名
%(funcName)s	调用日志输出函数的函数名
%(lineno)d	调用日志输出函数的语句所在的代码行
%(created)f	当前时间，用UNIX标准的表示时间的浮 点数表示
%(relativeCreated)d	输出日志信息时的，自Logger创建以 来的毫秒数
%(asctime)s	字符串形式的当前时间。默认格式是 “2003-07-08 16:49:45,896”。逗号后面的是毫秒
%(thread)d	线程ID。可能没有
%(threadName)s	线程名。可能没有
%(process)d	进程ID。可能没有
%(message)s	用户输出的消息

日志同时输出到文件与屏幕

Python 使用logging模块记录日志涉及四个主要类，使用官方文档中的概括最为合适：

• logger提供了应用程序可以直接使用的接口；
• handler将(logger创建的)日志记录发送到合适的目的输出；
• filter提供了细度设备来决定输出哪条日志记录；
• formatter决定日志记录的最终输出格式。

关系图

每个组件的功能

logger

每个程序在输出信息之前都要获得一个Logger。Logger通常对应了程序的模块名，比如聊天工具的图形界面模块可以这样获得它的Logger：

LOG=logging.getLogger(”chat.gui”)

而核心模块可以这样：

LOG=logging.getLogger(”chat.kernel”)

还可以绑定handler和filters

Logger.setLevel(lel):指定最低的日志级别，低于lel的级别将被忽略。debug是最低的内置级别，critical为最高
Logger.addFilter(filt)、Logger.removeFilter(filt):添加或删除指定的filter
Logger.addHandler(hdlr)、Logger.removeHandler(hdlr)：增加或删除指定的handler

Logger.debug()、Logger.info()、Logger.warning()、Logger.error()、Logger.critical()：可以设置的日志级别

handler

handler对象负责发送相关的信息到指定目的地

Handler.setLevel(lel):指定被处理的信息级别，低于lel级别的信息将被忽略
Handler.setFormatter()：给这个handler选择一个格式
Handler.addFilter(filt)、Handler.removeFilter(filt)：新增或删除一个filter对象

每个Logger可以附加多个Handler。接下来我们就来介绍一些常用的Handler：

1. logging.StreamHandler 使用这个Handler可以向类似与sys.stdout或者sys.stderr的任何文件对象(file object)输出信息。
2. logging.FileHandler 和StreamHandler 类似，用于向一个文件输出日志信息。不过FileHandler会帮你打开这个文件

3. logging.handlers.RotatingFileHandler

   这个Handler类似于上面的FileHandler，但是它可以管理文件大小。当文件达到一定大小之后，它会自动将当前日志文件改名，然后创建 一个新的同名日志文件继续输出。比如日志文件是chat.log。当chat.log达到指定的大小之后，RotatingFileHandler自动把 文件改名为chat.log.1。不过，如果chat.log.1已经存在，会先把chat.log.1重命名为chat.log.2。。。最后重新创建 chat.log，继续输出日志信息。它的函数是：

    RotatingFileHandler( filename[, mode[, maxBytes[, backupCount]]])
   

   其中filename和mode两个参数和FileHandler一样。

   • maxBytes用于指定日志文件的最大文件大小。如果maxBytes为0，意味着日志文件可以无限大，这时上面描述的重命名过程就不会发生。
   • backupCount用于指定保留的备份文件的个数。比如，如果指定为2，当上面描述的重命名过程发生时，原有的chat.log.2并不会被更名，而是被删除。

4. logging.handlers.TimedRotatingFileHandler

   这个Handler和RotatingFileHandler类似，不过，它没有通过判断文件大小来决定何时重新创建日志文件，而是间隔一定时间就 自动创建新的日志文件。重命名的过程与RotatingFileHandler类似，不过新的文件不是附加数字，而是当前时间。它的函数是：

   TimedRotatingFileHandler( filename [,when [,interval [,backupCount]]])
   

   其中filename参数和backupCount参数和RotatingFileHandler具有相同的意义。

   interval是时间间隔。

   when参数是一个字符串。表示时间间隔的单位，不区分大小写。它有以下取值：

   • S 秒
   • M 分
   • H 小时
   • D 天
   • W 每星期（interval==0时代表星期一）
   • midnight 每天凌晨

formatter 组件

日志的formatter是个独立的组件，可以跟handler组合

fh = logging.FileHandler("access.log")
formatter = logging.Formatter(\'%(asctime)s - %(name)s - %(levelname)s - %(message)s\')

fh.setFormatter(formatter) #把formmater绑定到fh上

filter 组件

如果你想对日志内容进行过滤，就可自定义一个filter

class IgnoreBackupLogFilter(logging.Filter):
    """忽略带db backup 的日志"""
    def filter(self, record): #固定写法
        return   "db backup" not in record.getMessage()

注意filter函数会返加True or False，logger根据此值决定是否输出此日志

然后把这个filter添加到logger中

logger.addFilter(IgnoreBackupLogFilter())

下面的日志就会把符合filter条件的过滤掉

logger.debug("test ....")
logger.info("test info ....")
logger.warning("start to run db backup job ....")
logger.error("test error ....")

一个同时输出到屏幕、文件、带filter和自动截断的完成例子

#!/usr/bin/env python3
#-*- coding:utf-8 -*-
\'\'\'
Time:2018/5/22 16:50
File:logging模块
\'\'\'
import logging
from logging import handlers  # 文件自动截取模块

#添加filter
class IgnoreBackupLogFilter(logging.Filter):
    """忽略带db backup 的日志"""
    def filter(self, record): #固定写法
        return   "db backup" not in record.getMessage()

#生成logger对象
logger = logging.getLogger(\'web\')
logger.setLevel(logging.DEBUG) # 设置全局的日志级别
#添加filter到logger
logger.addFilter(IgnoreBackupLogFilter())

#生成handler对象
th = logging.StreamHandler()
fh = logging.FileHandler(\'web.log\')
# fh = handlers.RotatingFileHandler(\'web.log\',maxBytes=10,backupCount=3) #以文件名后缀加来进行更改，backupCount代表只保留3个文件
fh = handlers.TimedRotatingFileHandler(\'web.log\',when=\'S\',interval=5,backupCount=3) #以时间来代表一个文件
th.setLevel(logging.DEBUG) # 向屏幕过滤的日志输出
fh.setLevel(logging.INFO)  # 向文件过滤的日志输出

#把handler绑定到logger
logger.addHandler(th)
logger.addHandler(fh)
#生成format对象
file_log =logging.Formatter(\'%(asctime)s - %(name)s - %(levelname)s - %(message)s\')
console_log = logging.Formatter(\'%(asctime)s - %(name)s - %(levelno)s - %(message)s\')
#把format绑定到handler
th.setFormatter(console_log)
fh.setFormatter(file_log)

logger.debug(\'This message should go to the log file\')
logger.info(\'So should this\')
logger.warning(\'And this, too,db backup\') #带有BACKUP的日志不会出现