Python logging 模块
例子
-
代码
-
输出结果
详解
- logging.basicConfig()函数中可通过具体参数来更改logging模块默认行为,可用参数
- filename:用于指定文件名创建FileHandler,存储日志到指定文件中。
- filemode:文件打开方式,在指定了filename时使用这个参数,默认值为"a"(只读),还可指定为"w"(只写)。
- format:指定handler使用的日志显示格式。
- datefmt:指定日期时间格式。
- level:设置rootlog的日志级别。
- stream:用指定的stream创建StreamHandler。可以指定输出到sys.stderr,sys.stdout或者文件,默认为sys.stderr。若同时列出了fliename和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 字符串形式的当前时间。默认格式"2016-07-19 16:06:46,292"
- %(thread)d 线程名。可能没有
- %(process)d 进程ID。可能没有
- %(message)s 用户输出的信息。
logging
- logging 库提供了多个组件:Logger、Handler、Filter、Formatter。Logger对象提供应用程序可直接使用的接口,Handler发生日志到适当的目的地,Filter提供了过滤日志信息的方法,Formatter指定日志显示格式。
Logger
Logger 是一个树形层级结构,输出信息之前都要获得一个Logger(如果没有显示的获取则自动创建并使用root Logger)。logger=logging.getLogger()返回一个默认的Logger也即root Logger,并应用默认日志级别、Handler和Formatter设置。当然也可以通过Logger.setLevel(lel)指定最低的日志级别,可用的日志级别有logging.DEBUG、logging.INFO、logging.WARNING、logging.ERROR、logging.CRITICAL。
Logger.debug()、Logger.info()、Logger.warning()、Logger.error()、Logger.critical()输出不同级别的日志,只有日志等级大于或等于设置的日志级别的日志才会被输出。
-
创建一个logger
日志级别等级
- 默认的日志级别设置为WARNING,日志级别等级CRITICAL > ERROR > WARNING > INFO > DEBUG > NOTSET
Handler
- 定义Handler
fh = logging.FileHandler('test.log')
ch = logging.StreamHandler() - Handler 对象负责发送相关信息到指定目的地,有几个常用的Handler方法:
Handler.setLevel(lev):指定日志级别,低于级别的日志将被忽略
Handler.setFormatter():给这个handler选择一个Formatter
Handler.addFilter(filt):新增一个filter对象
Handler.removeFilter(filt):删除一个filter对象 - 为 Logger 添加多个Handler:
logger.addHandler(fh)
logger.addHandler(ch) - 有多种可用的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 日志输出到sysloglogging.handlers.NTEventLogHandler 远程输出日志到Windows NT/2000/XP的事件日志
logging.handlers.SMTPHandler 远程输出日志到邮件地址logging.handlers.MemoryHandler 日志输出到内存中的制定bufferlogging.handlers.HTTPHandler 通过"GET"或"POST"远程输出到HTTP服务器
https://docs.python.org/2/library/logging.handlers.html#module-logging.handlers
Formatter
- Formatter 对象设置日志信息最后的规则、结构、和内容,默认时间格式为 %Y-%m-%d %H:%M:%S
- 定义 Formatter
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levename)s - %(message)s') - 为Handler添加Formatter
fh.setFormatter(formatter)
ch.setFormatter(formatter)
Filter
- 限制只有满足过滤规则的日志才会输出
- 比如我们定义了filter = logging.Filter('a.b.c'),并将这个Filter添加到了一个Handler上,则使用该Handler的Logger中只有名字带a.b.c前缀的Logger才能输出其日志
filter = logging.Filter('mylogger.child1.child2')
fh.addFilter(filter) - 若为Handler添加Filter则所有使用了该Handler的logger都会受到影响。而为Logger添加Filer只会影响到自身。、