关于使用python logging模块的几点总结
使用python的标准日志模块logging可以非常方便地记录日志。Python日志系统非常丰富。添加结构化或非结构化日志输出到python代码,写到文件,输出到控制台,发送到系统日志,或者自定义输出格式都很容易。

下面是我实践过程中遇到的一些经验和教训的总结。

1.

一个简单的日志系统示例


业务场景如下:


开发一个日志系统, 既要把日志输出到控制台, 还要写入日志文件

#!/usr/bin/env python
#encoding: utf-8

import logging

#创建一个logger实例
logger = logging.getLogger('mylogger')
logger.setLevel(logging.DEBUG)

#创建一个handler,用于写入日志文件
fh = logging.FileHandler('simple_log.log')
fh.setLevel(logging.DEBUG)

#创建一个handler,用于输出到控制台
ch = logging.StreamHandler()
ch.setLevel(logging.DEBUG)

#定义handler的输出格式
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
fh.setFormatter(formatter)
ch.setFormatter(formatter)

#给logger添加handler
logger.addHandler(fh)
logger.addHandler(ch)

#记录一条日志
logger.info('foobar')

运行后, 在控制台和日志文件都有一条日志:

python logging 如何保存输出至多个文件中 python logging模块输出到文件_输出格式



2.

logging模块的API


结合上面的例子,我们说下几个最常使用的API


logging.getLogger([name])


返回一个logger实例,如果没有指定name,返回root logger。


只要name相同,返回的logger实例都是同一个而且只有一个,即name和logger实例是一一对应的。这意味着,无需把logger实例在各个模块中传递。只要知道name,就能得到同一个logger实例



Logger.setLevel(lvl)


设置logger的level, level有以下几个级别:


python logging 如何保存输出至多个文件中 python logging模块输出到文件_python_02

NOTSET < DEBUG < INFO < WARNING < ERROR < CRITICAL

如果把looger的级别设置为INFO, 那么小于INFO级别的日志都不输出, 大于等于INFO级


别的日志都输出


logger.debug("foobar")    # 不输出   


logger.info("foobar")        # 输出  


logger.warning("foobar") # 输出  


logger.error("foobar")      # 输出  


logger.critical("foobar")    # 输出  


 


Logger.addHandler(hdlr)


logger可以雇佣handler来帮它处理日志, handler主要有以下几种:


StreamHandler: 输出到控制台


FileHandler:   输出到文件


handler还可以设置自己的level以及输出格式。



logging.basicConfig([**kwargs])


* 这个函数用来配置root logger, 为root logger创建一个StreamHandler,


   设置默认的格式。


* 这些函数: logging.debug()、logging.info()、logging.warning()、


   logging.error()、logging.critical() 如果调用的时候发现root logger没有任何


   handler, 会自动调用basicConfig添加一个handler


* 如果root logger已有handler, 这个函数不做任何事情



使用basicConfig来配置root logger的输出格式和level:


import logging  
logging.basicConfig(format='%(levelname)s:%(message)s', level=logging.DEBUG)  
logging.debug('This message should appear on the console')




3.

日志对象间的层级结构


除了root logger, 实际上logger实例之间还有父子关系, root logger就是处于最顶层的logger, 它是所有logger的祖先。如下图:


python logging 如何保存输出至多个文件中 python logging模块输出到文件_python_03


root logger是默认的logger


如果不创建logger实例, 直接调用logging.debug()、logging.info()logging.warning()、logging.error()、logging.critical()这些函数,


那么使用的logger就是 root logger, 它可以自动创建,也是单实例的。



如何得到root logger


通过logging.getLogger()或者logging.getLogger("")得到root logger实例。



默认的level


root logger默认的level是logging.WARNING



如何表示父子关系


logger的name的命名方式可以表示logger之间的父子关系. 比如:


parent_logger = logging.getLogger('foo')


child_logger = logging.getLogger('foo.bar')

什么是effective level

logger有一个概念,叫effective level。 如果一个logger没有显示地设置level,那么它就


用父亲的level。如果父亲也没有显示地设置level, 就用父亲的父亲的level,以此推....


最后到达root logger,一定设置过level。默认为logging.WARNING


child loggers得到消息后,既把消息分发给它的handler处理,也会传递给所有祖先logger处理,



来看一个例子


#!/usr/bin/env python
#encoding: utf-8

import logging

logging.basicConfig(format='%(levelname)s:%(message)s', level=logging.DEBUG)
logging.debug('This message should appear on the console')

r = logging.getLogger()

ch = logging.StreamHandler()
ch.setLevel(logging.DEBUG)
formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
ch.setFormatter(formatter)
r.addHandler(ch)

p = logging.getLogger('foo')
p.setLevel(logging.DEBUG)
ch = logging.StreamHandler()
ch.setLevel(logging.DEBUG)
formatter = logging.Formatter('%(asctime)s - %(message)s')
ch.setFormatter(formatter)
p.addHandler(ch)

c = logging.getLogger('foo.bar')
c.debug('foo')

输出如下:



python logging 如何保存输出至多个文件中 python logging模块输出到文件_日志系统_04



可见,孩子logger没有任何handler,所以对消息不做处理。但是它把消息转发给了它的父亲以及root logger。最后输出四条日志。



参考文献


[1].http://kenby.iteye.com/blog/1162698