Logging HOWTO
本期将会介绍logging模块的进阶内容,也是将logging模块应用于实际生产环境的成熟用法。
Advanced Logging
- logging库采用模块化的方法,并提供了不同类型的组件:loggers,handlers,filters,and formatters.
- logger为我们提供了程序可以直接调用的接口
- handler将日志记录发送到合适的目的地
- filters提供更为细致的粒度的日志输出
- formatters顾名思义指定了我们想要的日志输出格式
Logger
Logger对象肩负三重任务,首先,logger暴露出很多方法供应用的代码在运行时调用。其次,logger对象会根据日志等级确定哪些日志消息需要进行处理。第三logger对象可以将日志消息发送给handler去做进一步处理。
logger对象最广泛的两种使用场景就是,配置和分发
以下是最常见的几种方法
- Logger.setLevel()指定了logger需要处理的最低日志等级的消息,其中DEBUG是最低的内置日志等级,CRITICAL是最高级别。举个例子,如果将日志等级设置为INFO,logger将只会处理INFO,WARNING,ERROR,CRITICAL,DEBUG将会被忽略。
- Logger.addHandler()和Logger.removeHandler()从logger对象上添加和移除handler,handler将会在下文详细介绍
- Logger.addFilter()和Logger.removeFilter() 从logger对象上添加和移除filter对象,filter也会再下文详细介绍
在logger对象配置完成后,使用以下方法创建日志消息
Logger.debug(),Logger.info(),Logger.warning(),Logger.error(),Logger.critical()他们都用于创建日志记录,并且使用和自身一样的名字日志级别,消息实际上是一个字符串,可以包含标准的字符串替换语法%s,%d,%f等。对于**kwargs,日志记录方法只关注exc_info关键字,并且使用它来决定是否记录异常信息
Logger.exception()会创建一个类似与Logger.error()的日志消息,不同之处在于Logger.exception同时转存了一个堆栈跟踪,只能通过exception handler调用此方法
Logger.log()将日志等级作为显示的参数,对于记录消息来说,这比上述使用Logger.debug()的办法更加详细一些,但这是在自定义日志等级上记录日志的方法。
getLogger()如果提供了指定的名称,则会返回对logger实例的引用,如果没有提供,则返回root。
Logger有一个有效级别的概念,如果在logger上没有显示的设置级别,则会使用其父级别作为有效级别,如果还没有,则追溯到查到日志级别为止,logger的有效级别需要用于确定是否将时间传递给logger的handler
子logger将消息发送到与父辈logger想关联的handler中,因此没有必要为所有的logger去定义和配置handler,为顶级的logger创建子logger这就足够了。但是可以通过更改propagate属性来关闭传播
Handler
handler对象的责任是,将适当的消息(根据消息的日志等级)发送到handler指定的地点去,logger对象可以通过addHandler()方法添加零个或多个hander对象给他们自己。举一个简单的应用场景,我们的应用程序可能想将所有的log消息发送到log文件当中,将error以上等级的发送到标准输出去,如果出现了大的问题需要立刻将critical等级的log通过邮件发送到程序员手里,其中每一个handler需要将特定日志等级的log发送到指定的位置。
标准库中提供了许多有趣的handler,教程中只使用了StreamHandler和FileHandler。
对于开发人员来说,需要关注的handler方法不多,对于使用内置handler的开发者(即不是用自定义),只需要关注下面的几个方法
-
setLevel()方法,与logger对象中的方法一样,那为什么会有两个相同名称的方法呢,logger设置的日志等级决定了发送给哪一个handler,handler中的日志等级决定了handler要发送哪些消息。
-
setFormatter()顾名思义为其设置Foramtter对象
-
addFilter()和removeFilter()添加和移除Filter对象
应用程序的代码不应该直接使用handler来实例化,他只是作为不同功能handler的一个基类,他定义了所有handler应该具有的接口,或者子类可以重写某些功能。
网友评论