[关闭]
@StrGlee 2016-10-19T14:12:53.000000Z 字数 6044 阅读 1018

Python日志系统Logging

python logging
在Python中的logging模块中,有四个最重要的东西,即Logger、Handler、Filter、Formatter四个类。注:其中,Handler是个抽象类,不能直接使用,必须有其它的子Handler类来继承它,关于这点,请往下看。

1、总体介绍:

(1)Logger:一个界面,程序员在写应用程序时直接使用它来记录日志信息。该类无需自定义重载。

  1. 创建方法: logger = logging.getLogger(logger_name)

创建Logger实例后,可以使用以下方法进行日志级别设置,增加处理器Handler。

  1. logger.setLevel(logging.ERROR) # 设置日志级别为ERROR,即只有日志级别大于等于ERROR的日志才会输出
  2. logger.addHandler(handler_name) # 为Logger实例增加一个处理器
  3. logger.removeHandler(handler_name) # 为Logger实例删除一个处理器

(2)Handler:处理器,它用于将由Logger创建的日志信息发送到相应的目的地;不同的Handler种类(继承自Handler抽象类)发送到不同的目的地,比如:FileHandler将日志写入到文件中,StreamHandler将日志输出到控制台,SMTPHandler将日志以邮件的形式发送出去,SocketHandler将日志用TCP Socket发送出去,而DatagramHandler将日志用UDP数据报发送出去,等等。以上都是logging已经实现的Handler,另外,也可以自己定义自己的Handler,只要继承自Handler抽象类并重载emit方法即可。

  1. ch.setLevel(logging.WARN) # 指定日志级别,低于WARN级别的日志将被忽略
  2. ch.setFormatter(formatter_name) # 设置一个格式化器formatter
  3. ch.addFilter(filter_name) # 增加一个过滤器,可以增加多个
  4. ch.removeFilter(filter_name) # 删除一个过滤器

StreamHandler

  1. 创建方法: sh = logging.StreamHandler(stream=None)

FileHandler

  1. 创建方法: fh = logging.FileHandler(filename, mode='a', encoding=None, delay=False)

NullHandler
NullHandler类位于核心logging包,不做任何的格式化或者输出。
本质上它是个“什么都不做”的handler,由库开发者使用。

(3)Filter:过滤器,表明一个日志信息是否要被过滤掉而不记录;它提供了一个好的、细粒度的日志控制。可以重载Filter来自定义自己的Filter,此时要重载Filter类的filter方法。
Handlers和Loggers可以使用Filters来完成比级别更复杂的过滤。Filter基类只允许特定Logger层次以下的事件。例如用‘A.B’初始化的Filter允许Logger ‘A.B’, ‘A.B.C’, ‘A.B.C.D’, ‘A.B.D’等记录的事件,logger‘A.BB’, ‘B.A.B’ 等就不行。 如果用空字符串来初始化,所有的事件都接受。

  1. 创建方法: filter = logging.Filter(name='')

(4)Formatter:格式化工具,在Handler处理器把日志信息发送出去之后,会使用该类对象格式日志信息,即该类指定日志信息最终被输出的格式。该类无需自定义重载。
使用Formatter对象设置日志信息最后的规则、结构和内容,默认的时间格式为%Y-%m-%d %H:%M:%S。

  1. 创建方法: formatter = logging.Formatter(fmt=None, datefmt=None)

其中,fmt是消息的格式化字符串,datefmt是日期字符串。如果不指明fmt,将使用'%(message)s'。如果不指明datefmt,将使用ISO8601日期格式。

2、相互关系:

(1)Logger可以包含一个或多个Handler和Filter,即Logger与Handler或Fitler是一对多的关系;

(2)Handler可以包含一个或多个Filter,但只能包含一个Formatter,即Handler与Filter是一对多的关系,与Formatter是一对一的关系;

(3)Filter可以多次被包含在Logger和Handler中;

(4)Formatter只能被包含在Handler中,不能被包含在Logger中,并且只能有一个被包含在Handler中。

3、常用功能:

(1)Logger:可以设置Logger上的日志等级(Logger.setLevel方法)、添加或移除过滤器(Logger.addFilter和Logger.removeFilter方法)、添加或移除处理器(Logger.addHanlder和Logger.removeHandler方法)以及一些日志记录工具(Logger类的debug、info、error、warning、critical、log等方法)。

(2)Handler:可以设置Handler上的日志等级(Handler.setLevel方法)、设置Formatter(Handler.setFormatter方法)、添加或移除过滤器(Handler.addFilter和Handler.removeFilter方法)。

(3)Fitler:默认的Filter类,需要获取一个字符串类型的参数,该参数是用来判断日志信息是否允许被记录。Filter类中有一个filter方法,该方法返回真则表示日志信息被记录,否则将丢弃,不再处理。如果该参数为空字符串,则filter方法返回真;否则,该字符串参数表示着一个Logger(每个Logger对象都有一个用点分隔的字符串名字),只有当前处理日志信息的Logger对象是该字符串参数指定的Logger对象或子对象,filter方法才返回真,其它情况返回假。

(4)Formatter:Formatter在实例化时,需要传递至少一个参数、至多三个参数。第一个参数代表格式化字符串,第二个参数代表日期格式,第三个参数表示格式化字符串中将要使用哪种占符符(“%”表示旧的Python格式化方式,“{”表示新的Python格式化方式,“$”表示模板格式化方式)。

4、logging工作流程:

(1)第一次导入logging模块或使用reload函数重新导入logging模块,logging模块中的代码将被执行,这个过程中将产生logging日志系统的默认配置。

(2)自定义配置(可选)。logging标准模块支持三种配置方式:dictConfig、fileConfig、listen。其中,dictConfig是通过一个字典进行配置Logger、Handler、Filter、Formatter,fileConfig则是通过一个文件进行配置,而listen则监听一个网络端口,通过接收网络数据来进行配置。当然,除了以上集体化配置外,也可以直接调用Logger、Handler等对象中的方法在代码中来手工进行单独配置。关于字典配置和文件配置的格式,请参见Python logging官方文档。

(3)使用logging模块的全局作用域中的getLogger函数来得到一个Logger对象(其参数即是一个字符串,表示Logger对象的名字,即通过该名字来得到相应的Logger对象)。

(4)使用Logger对象中的debug、info、error、warning、critical、log等方法记录日志信息,其处理流程如下:

1> 判断日志的等级是否大于Logger对象的等级:如果大于,则往下执行;否则,流程结束。

2> 产生日志。第一步,判断是否有异常,如果有,则添加异常信息;第二步,处理日志记录方法(如debug、info等)中的占位符,即一般的字符串格式化处理。

3> 使用注册到Logger对象中的Filters进行过滤。如果有多个过滤器,则依次过滤;只要有一个过滤器返回假,则过滤结束,且该日志信息将丢弃,不再处理,而处理流程也至此结束。否则,处理流程往下执行。

4> 在当前Logger对象中查找Handlers,如果找不到任何Handler,则往上到该Logger对象的父Logger中查找;如果找到一个或多个Handler,则依次用Handler来处理日志信息。但在每个Handler处理日志信息过程中,会首先判断日志信息的等级是否大于该Handler的等级,如果大于,则往下执行(由Logger对象进入Handler对象中);否则,处理流程结束。

5> 执行Handler对象中的filter方法,该方法会依次执行注册到该Handler对象中的Filter。如果有一个Filter判断该日志信息为假,则此后的所有Filter都不再执行,而直接将该日志信息丢弃,处理流程结束。

6> 使用Formatter类格式化最终的输出结果。 注:Formatter同上述第2步(即2>)的字符串格式化不同,它会添加额外的信息,比如:日志产生的时间、产生日志的源代码所在的源文件的路径等等。

7> 真正地输出日志信息(到网络、文件、终端、邮件等)。至于输出到哪个目的地,由Handler的种类来决定。

再看日志配置

配置方式

显式创建记录器Logger、处理器Handler和格式化器Formatter,并进行相关设置;
通过简单方式进行配置,使用basicConfig()函数直接进行配置;
通过配置文件进行配置,使用fileConfig()函数读取配置文件;
通过配置字典进行配置,使用dictConfig()函数读取配置信息;
通过网络进行配置,使用listen()函数进行网络配置。

basicConfig关键字参数

关键字 描述
filename 创建一个FileHandler,使用指定的文件名,而不是使用StreamHandler。
filemode 如果指明了文件名,指明打开文件的模式(如果没有指明filemode,默认为'a')。
format handler使用指明的格式化字符串。
datefmt 使用指明的日期/时间格式。
level 指明根logger的级别。
stream 使用指明的流来初始化StreamHandler。该参数与'filename'不兼容,如果两个都有,'stream'被忽略。

有用的format格式

格式 描述
%(levelno)s 打印日志级别的数值
%(levelname)s 打印日志级别名称
%(pathname)s 打印当前执行程序的路径
%(filename)s 打印当前执行程序名称
%(funcName)s 打印日志的当前函数
%(lineno)d 打印日志的当前行号
%(asctime)s 打印日志的时间
%(thread)d 打印线程id
%(threadName)s 打印线程名称
%(process)d 打印进程ID
%(message)s 打印日志信息

有用的datefmt格式

参考time.strftime

配置示例

显式配置

使用程序logger.py如下:

  1. # -*- encoding:utf-8 -*-
  2. import logging
  3. # create logger
  4. logger_name = "example"
  5. logger = logging.getLogger(logger_name)
  6. logger.setLevel(logging.DEBUG)
  7. # create file handler
  8. log_path = "./log.log"
  9. fh = logging.FileHandler(log_path)
  10. fh.setLevel(logging.WARN)
  11. # create formatter
  12. fmt = "%(asctime)-15s %(levelname)s %(filename)s %(lineno)d %(process)d %(message)s"
  13. datefmt = "%a %d %b %Y %H:%M:%S"
  14. formatter = logging.Formatter(fmt, datefmt)
  15. # add handler and formatter to logger
  16. fh.setFormatter(formatter)
  17. logger.addHandler(fh)
  18. # print log info
  19. logger.debug('debug message')
  20. logger.info('info message')
  21. logger.warn('warn message')
  22. logger.error('error message')
  23. logger.critical('critical message')

文件配置

配置文件logging.conf如下:

  1. keys=root,example01
  2. [logger_root]
  3. level=DEBUG
  4. handlers=hand01,hand02
  5. [logger_example01]
  6. handlers=hand01,hand02
  7. qualname=example01
  8. propagate=0
  9. [handlers]
  10. keys=hand01,hand02
  11. [handler_hand01]
  12. class=StreamHandler
  13. level=INFO
  14. formatter=form02
  15. args=(sys.stderr,)
  16. [handler_hand02]
  17. class=FileHandler
  18. level=DEBUG
  19. formatter=form01
  20. args=('log.log', 'a')
  21. [formatters]
  22. keys=form01,form02
  23. [formatter_form01]
  24. format=%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s

使用程序logger.py如下:

  1. # -*- encoding:utf-8 -*-
  2. import logging
  3. import logging.config
  4. logging.config.fileConfig("./logging.conf")
  5. # create logger
  6. logger_name = "example"
  7. logger = logging.getLogger(logger_name)
  8. logger.debug('debug message')
  9. logger.info('info message')
  10. logger.warn('warn message')
  11. logger.error('error message')
  12. logger.critical('critical message')
添加新批注
在作者公开此批注前,只有你和作者可见。
回复批注