详解python中的日志模块logging

许多应用程序中都会有日志模块,用于记录系统在运行过程中的一些关键信息,以便于对系统的运行状况进行跟踪。在.net平台中,有非常著名的第三方开源日志组件log4net,c++中,有人们熟悉的log4cpp,而在python中,我们不需要第三方的日志组件,因为它已经为我们提供了简单易用、且功能强大的日志模块:logging。logging模块支持将日志信息保存到不同的目标域中,如:保存到日志文件中;以邮件的形式发送日志信息;以http get或post的方式提交日志到web服务器;以windows事件的形式记录等等。这些日志保存方式可以组合使用,每种方式可以设置自己的日志级别以及日志格式。日志模块的内容比较多,今天先学习logging模块的基本使用,下次具体学习日志的处理。

先看一个比较简单的例子,让我们对logging模块有个感性的认识:

import logging
logging.basicconfig(filename = os.path.join(os.getcwd(), ‘log.txt’), level = logging.debug)
logging.debug(‘this is a message’)

运行上面例子的代码,将会在程序的根目录下创建一个log.txt文件,打开该文件,里面有一条日志记录:”debug:root:this is a message”。
4个主要的组件

logger: 日志类,应用程序往往通过调用它提供的api来记录日志;
handler: 对日志信息处理,可以将日志发送(保存)到不同的目标域中;
filter: 对日志信息进行过滤;
formatter:日志的格式化;

日志级别

在记录日志时, 日志消息都会关联一个级别(“级别”本质上是一个非负整数)。系统默认提供了6个级别,它们分别是:

201561991541515.jpg (636×253)

可以给日志对象(logger instance)设置日志级别,低于该级别的日志消息将会被忽略,也可以给hanlder设置日志级别,对于低于该级别的日志消息, handler也会忽略。

logging模块中的常用函数:
logging.basicconfig([**kwargs]):

为日志模块配置基本信息。kwargs 支持如下几个关键字参数:

filename :日志文件的保存路径。如果配置了些参数,将自动创建一个filehandler作为handler;
filemode :日志文件的打开模式。 默认值为’a’,表示日志消息以追加的形式添加到日志文件中。如果设为’w’, 那么每次程序启动的时候都会创建一个新的日志文件;
format :设置日志输出格式;
datefmt :定义日期格式;
level :设置日志的级别.对低于该级别的日志消息将被忽略;
stream :设置特定的流用于初始化streamhandler;

下面是一个简单的例子:

#coding=gbk
import logging
logging.basicconfig(filename = os.path.join(os.getcwd(), ‘log.txt’), /
level = logging.warn, filemode = ‘w’, format = ‘%(asctime)s – %(levelname)s: %(message)s’)
logging.debug(‘debug’)
#被忽略
logging.info(‘info’)
#被忽略
logging.warning(‘warn’)
logging.error(‘error’)
#—– 结果
#2009-07-13 21:42:15,592 – warning: warn
#2009-07-13 21:42:15,640 – error: error
logging.getlogger([name])

  创建logger对象。日志记录的工作主要由logger对象来完成。在调用getlogger时要提供logger的名称(注:多次使用相同名称来调用getlogger,返回的是同一个对象的引用。),logger实例之间有层次关系,这些关系通过logger名称来体现,如:

p = logging.getlogger(“root”)
c1 = logging.getlogger(“root.c1″)
c2 = logging.getlogger(“root.c2″)

例子中,p是父logger, c1,c2分别是p的子logger。c1, c2将继承p的设置。如果省略了name参数, getlogger将返回日志对象层次关系中的根logger。
logging.setloggerclass(klass)
logging.getloggerclass()

获取/设置日志类型。用户可以自定义日志类来代替系统提供的logging.logger类。
logging.getlevelname(lvl)

获取日志级别对应的名称。例如:

print logging.getlevelname(logging.notset)
print logging.getlevelname(10)
#logging.debug
print logging.getlevelname(logging.debug)
print logging.getlevelname(30)
#logging.warn
print logging.getlevelname(logging.error)
print logging.getlevelname(50)
#logging.critical
logging.shutdown()

  当不再使用日志系统的时候,调用该方法,它会将日志flush到对应的目标域上。一般在系统退出的时候调用。

logger对象 通过调用logging.getlogger(name)来创建,它有如下常用的方法和属性:
logger.setlevel(lvl):

设置日志的级别。对于低于该级别的日志消息将被忽略。下面一个例子演示setlevel方法:

#coding=gbk
import logging
logging.basicconfig(filename = os.path.join(os.getcwd(), ‘log.txt’), level = logging.debug)
log = logging.getlogger(‘root.test’)
log.setlevel(logging.warn) #日志记录级别为warnning
log.info(‘info’) #不会被记录
log.debug(‘debug’) #不会被记录
log.warning(‘warnning’)
log.error(‘error’)
logger.debug(msg [ ,*args [, **kwargs]])

记录debug级别的日志信息。参数msg是信息的格式,args与kwargs分别是格式参数。

import logging
logging.basicconfig(filename = os.path.join(os.getcwd(), ‘log.txt’), level = logging.debug)
log = logging.getlogger(‘root’)
log.debug(‘%s, %s, %s’, *(‘error’, ‘debug’, ‘info’))
log.debug(‘%(module)s, %(info)s’, {‘module’: ‘log’, ‘info’: ‘error’})
logger.info(msg[ , *args[ , **kwargs] ] )
logger.warnning(msg[ , *args[ , **kwargs] ] )
logger.error(msg[ , *args[ , **kwargs] ] )
logger.critical(msg[ , *args[ , **kwargs] ] )

记录相应级别的日志信息。参数的含义与logger.debug一样。
logger.log(lvl, msg[ , *args[ , **kwargs] ] )

记录日志,参数lvl用户设置日志信息的级别。参数msg, *args, **kwargs的含义与logger.debug一样。
logger.exception(msg[, *args])

以error级别记录日志消息,异常跟踪信息将被自动添加到日志消息里。logger.exception通过用在异常处理块中,如:

import logging
logging.basicconfig(filename = os.path.join(os.getcwd(), ‘log.txt’), level = logging.debug)
log = logging.getlogger(‘root’)
try:
raise exception, ‘this is a exception’
except:
log.exception(‘exception’)
#异常信息被自动添加到日志消息中

logger.addfilter(filt)
logger.removefilter(filt)

添加/移除日志消息过滤器。在讲述filter时具体介绍。
logger.addhandler(hdlr)
logger.removehandler(hdlr)

添加/移除日志消息处理器。在讲述handler时具体介绍。
logger.makerecord(name, lvl, fn, lno, msg, args, exc_info[, func, extra])

创建logrecord对象。日志消息被实例为一个logrecord对象,并在日志类内处理。

Posted in 未分类