日志记录模块---logging

1、日志基本操作

import logging

# 第一步：获取日志操作句柄。其他诸如设置全局日志级别，指定输出目的地，输出msg等都基于该句柄操作完成
log = logging.getLogger()

# 第二步：设置全局日志级别(高于该级别的才会输出，默认为warnning)
log.setLevel(logging.INFO)

# 第三步：设置输出handler，就是日志输出到哪，如控制台，文件，远程服务器等
fh = logging.FileHandler('test.log')
ch = logging.StreamHandler()

# 第四步：指定日志格式，设置格式，并绑定到handler上
fmt = logging.Formatter('%(asctime)s [level: %(levelname)s ] %(message)s')
fh.setFormatter(fmt)
ch.setFormatter(fmt)

# 第五步：指定（局部）输出级别，这里设置一般要比全局高，类似于全局先进行级别过滤，这里再过滤，若是这里设置比全局低，则无意义
fh.setLevel(logging.ERROR)
ch.setLevel(logging.CRITICAL)

# 第六步：添加handler到日志操作句柄上
log.addHandler(fh)
log.addHandler(ch)

# 第七步：输出不同级别的msg
log.info('this is info msg')
log.warn('this is warn msg')
log.error('this is erro msg')
log.critical('this is critical msg')

2、各模块和参数详解

 1>Logger

提供日志接口，供应用代码使用；logger最长用的操作有两类：配置和发送日志消息。可以通过logging.getLogger(name)

获取logger对象，如果不指定name则返回root对象，多次使用相同的name调用getLogger方法返回同一个logger对象。初

始化 logger = logging.getLogger() ，设置级别 logger.setLevel(logging.DEBUG)

 1.1>日志级别（level）

  log 五个级别等级，输出规则是：输出大于或等于当前级别的日志（比如设置级别为INFO，则不会打印DEBUG信息，

 只打印INFO及以上级别的信息），建议不要设置等级为DEBUG，这样会默认输出脚本执行时所有的详细信息，一般

 在深入查找问题才需要查看这类信息。

 

2>Handler 

将日志记录（log record）发送到合适的目的地（destination），比如文件，socket等。一个logger对象可以通过addHandler

方法添加0到多个handler，每个handler又可以定义不同日志级别，以实现日志分级过滤显示。 常用的是StreamHandler和

FileHandler，windows下你可以简单理解为console和文件日志，一个打印在CMD窗口上，一个记录在一个文件上。

 3>输出格式（Format）

 format：指定日志输出和显示的具体格式（各字段解析如下）

 %(levelno)s: 打印日志级别的数值

 %(levelname)s: 打印日志级别名称

 %(pathname)s: 打印当前执行程序的路径，其实就是sys.argv[0]

 %(filename)s: 打印当前执行日志输出的模块名

 %(funcName)s:打印当前执行日志输出的函数名

 %(lineno)d: 打印当前执行日志输出的代码行

 %(asctime)s: 字符串形式的当前时间，默认格式是：年-月-日 时：分：秒，毫秒

 %(thread)d: 打印线程ID

 %(threadName)s: 打印线程名称

 %(process)d: 打印进程ID

 %(message)s: 打印日志信息

 4>addHandler

为logger添加多个handler

          logging.StreamHandler 可以向类似与sys.stdout或者sys.stderr的任何文件对象(file object)输出信息

logging.FileHandler 用于向一个文件输出日志信息

logging.handlers.RotatingFileHandler 类似于上面的FileHandler，但是它可以管理文件大小。当文件达

 到一定大小之后，它会自动将当前日志文件改名，然后创建一个新的同名日志文件继续输出

logging.handlers.TimedRotatingFileHandler 和RotatingFileHandler类似，不过，它没有通过判断文件

 大小来决定何时重新创建日志文件，而是间隔一定时间就自动创建新的日志文件

logging.handlers.SocketHandler 使用TCP协议，将日志信息发送到网络。

logging.handlers.DatagramHandler 使用UDP协议，将日志信息发送到网络。

logging.handlers.SysLogHandler 日志输出到syslog

logging.handlers.NTEventLogHandler 远程输出日志到Windows NT/2000/XP的事件日志 

logging.handlers.SMTPHandler 远程输出日志到邮件地址

logging.handlers.MemoryHandler 日志输出到内存中的制定buffer

logging.handlers.HTTPHandler 通过"GET"或"POST"远程输出到HTTP服务器

5>Filter

提供了过滤日志信息的方法，控制输出； 

 如下， 先定义过滤的格式

class log_filter(logging.Filter):
    def filter(self, record):   # 固定写法
        
        # 只显示/保存消息中包含aaaaaa的记录，not in就表示忽略包含xxx的日志
        return 'aaaaaa' in record.getMessage()

 再绑定要log操作句柄上

# 添加filter过滤
log.addFilter(log_filter())

实际效果

6>日志保存方式操作模块（基于之前的步骤，重新设置下handlers就可以）

 6.1> 按指定数量保存日志。比如下面，maxBytes设置文件存放大小为20字节，多的话会自动截取并保存到下一指定名称的份文件，

之前的文件会自动在后缀加1，若加1已存在则改成加2，同理递增，backupCount设置文件保存的数量，这里为3份，多余则删除

from logging import handlers
fh = handlers.RotatingFileHandler('test.log', maxBytes=20, backupCount=3)

 6.2>按时间保存日志。when参数填入时间格式如时（H）、分（M）、秒（S），interval设置对应的值，下面为每5秒生

成一个文件

fh = handlers.TimedRotatingFileHandler('test.log', when='S', interval=5)

 

7>其他

 import log

log.debug('xxx')

log.info('xxx')