很多程序都有记录日志的需求,并且日志包含的信息有正常的程序访问日志还可能有错误,警告等信息输出,python的logging模块提供了标准的日志接口,可以通过它存储各种格式的日志,日志级别等级:critical > error > warning > info > debug
看下各个日志级别代表什么意思:
import logging logging.basicConfig(filename='app.log',level=logging.DEBUG,format='%(asctime)s %(filename)s[line:%(lineno)d] %(message)s',datefmt='%Y-%m-%d') logging.info('test info') logging.debug('test debug') logging.warning('test warning') logging.error('test error') logging.critical('test critical')
查看输出:
2017-07-17 logging模块.py[line:7] test info 2017-07-17 logging模块.py[line:8] test debug 2017-07-17 logging模块.py[line:9] test warning 2017-07-17 logging模块.py[line:10] test error 2017-07-17 logging模块.py[line:11] test critical
在logging.basicConfig()函数中可通过具体参数来更改logging模块默认行为,可用参数有 filename:用指定的文件名创建FiledHandler(后边会具体讲解handler的概念),这样日志会被存储在指定的文件中。filemode:文件打开方式,在指定了filename时使用这个参数,默认值为“a”还可指定为“w”。format:指定handler使用的日志显示格式。 datefmt:指定日期时间格式。 level:设置rootlogger(后边会讲解具体概念)的日志级别 stream:用指定的stream创建StreamHandler。可以指定输出到sys.stderr,sys.stdout或者文件,默认为sys.stderr。若同时列出了filename和stream两个参数,则stream参数会被忽略。 format参数中可能用到的格式化串: %(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用户输出的消息
若要对logging进行更多灵活的控制,必须了解Logger,Handler,Formatter,Filter的概念:
组件名称 | 对应类名 | 功能描述 |
---|---|---|
日志器 | Logger | 提供了应用程序使用的结构的接口 |
处理器 | Handler | 将logger创建的日志记录发送发合适的目的输出 |
过滤器 | Filter | 提供了更细粒度的控制工具来决定输出哪条日志记录,丢弃哪条日志记录 |
格式器 | Formatter | 决定日志记录的最终输出格式 |
logger
每个程序在输出信息之前都要获得一个Logger。Logger通常对应了程序的模块名,比如聊天工具的图形界面模块可以这样获得它的Logger:
LOG=logging.getLogger(”chat.gui”)
而核心模块可以这样:
LOG=logging.getLogger(”chat.kernel”)
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对象负责发送相关的信息到指定目的地。Python的日志系统有多种Handler可以使用。有些Handler可以把信息输出到控制台,有些Logger可以把信息输出到文件,还有些 Handler可以把信息发送到网络上。如果觉得不够用,还可以编写自己的Handler。可以通过addHandler()方法添加多个多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)输出信息。它的构造函数是:
StreamHandler([strm])
其中strm参数是一个文件对象。默认是sys.stderr
2) logging.FileHandler
和StreamHandler类似,用于向一个文件输出日志信息。不过FileHandler会帮你打开这个文件。它的构造函数是:
FileHandler(filename[,mode])
filename是文件名,必须指定一个文件名。
mode是文件的打开方式。参见Python内置函数open()的用法。默认是’a',即添加到文件末尾。
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 每天凌晨
常见方法
名称 | 描述 |
---|---|
Logger.setLevel() | 设置日志器处理级别 |
Logger.addHandler()、Logger.removeHandler() | 为该logger对象添加和移除一个handler对象 |
Logger.addFilter()、Logger.removeFilter() | 为该logger对象添加和移除一个filter对象 |
Handler.setLevel() | 设置handler将会处理的日志级别 |
Handler.setFormatter() | 为handler设置一个格式器对象 |
Handler.addFilter()、Handler.removeFilter() | 为handler添加和删除一个过滤对象 |
logging.StreamHandler | 将日志消息发送到输出到Stream,如std.out,std.err |
logging.FileHandler | 将日志消息发送到磁盘文件,默认文件大小会无限增长 |
logging.hanlders.TimeRotatingFileHandler | 将日志消息发送到磁盘文件,并支持日志文件按时间切割 |
一条日志消息想被最终输出,需要经过以下几次过滤:
日志器等级过滤
日志器的过滤器过滤
日志器的处理器等级过滤
日志器的处理器的过滤器过滤
最后我们上一个同时输出文件和控制台例子
#!/usr/bin/python3 #coding: utf-8 import os import sys import logging def log(): log_dir = os.path.join(os.getcwd(), "logs") if not os.path.exists(log_dir): os.makedirs(log_dir, mode=0o777) logger = logging.getLogger() #获得一个logger对象,默认是root logger.setLevel(logging.INFO) #设置最低等级debug fm = logging.Formatter("%(asctime)s - %(levelname)s - %(filename)s[:%(lineno)d] - %(message)s") #设置日志格式 fh = logging.FileHandler(filename="app.log",encoding='utf-8') #创建一个文件流并设置编码utf8 ch = logging.StreamHandler(sys.stderr) #日志输出流 fh.setLevel(logging.ERROR) ch.setLevel(logging.INFO) fh.setFormatter(fm) #把文件流添加写入格式 ch.setFormatter(fm) logger.addHandler(fh) #把文件流添加进来,流向写入到文件 logger.addHandler(ch) return logger
按天生成日志
#!/usr/bin/python3 #coding: utf-8 import os import sys import logging from logging.handlers import TimedRotatingFileHandler def log(): log_dir = os.path.join(os.getcwd(), "logs") if not os.path.exists(log_dir): os.makedirs(log_dir, mode=0o777) logger = logging.getLogger() #获得一个logger对象,默认是root logger.setLevel(logging.INFO) #设置最低等级debug fm = logging.Formatter("%(asctime)s - %(levelname)s - %(filename)s[:%(lineno)d] - %(message)s") #设置日志格式 #fh = logging.FileHandler(os.path.join(log_dir, "app.log"),encoding='utf-8') #创建一个文件流并设置编码utf8 fh = TimedRotatingFileHandler(filename=os.path.join(log_dir, "app.log"), encoding="utf-8", when="D", interval=1, backupCount=7) fh.suffix = "%Y-%m-%d.log" ch = logging.StreamHandler(sys.stderr) #日志输出流 fh.setLevel(logging.ERROR) ch.setLevel(logging.INFO) fh.setFormatter(fm) #把文件流添加写入格式 ch.setFormatter(fm) logger.addHandler(fh) #把文件流添加进来,流向写入到文件 logger.addHandler(ch) return logger