Logging框架主要作用是Python里面处理日志
一.logging模块的组成
- loggers :提供应用程序直接使用的接口
- handlers:发送日志记录到哪里
- filters: 限制只有满足过滤规则的日志才会输出。
- formatters:日志记录的格式
loggers
Logger为日志系统的入口。暴露给代码使用,每个logger的命名都是bucket,你可以向这个bucke输入需要处理的消息。
每个Logger都有一个日志级别,日志级别表示将要处理这个消息的严重性。Python定义了一下集中日志级别:
- DEBUG: 用于调试目的代码信息
- INFO: 普通的日志信息
- WARNING: 警告信息,一个问题严重比较小的信息。
- ERROR:错误信息,一个问题严重比较大的信息。
-
CRITICAL: 危险致命的信息。超级严重
写入logger 的每条消息都是一个日志记录。每个日志记录也具有一个日志级别,它表示对应的消息的严重性。每个日志记录还可以包含描述正在打印的事件的有用元信息。这些元信息可以包含很多代码细节,例如回溯栈或错误码。
当输入一条消息给logger 时,会将消息的日志级别与logger 的日志级别进行比较。如果消息的日志级别大于等于logger 的日志级别,该消息将会往下继续处理。如果小于,该消息将被忽略。
Logger 一旦决定消息需要被处理,它将传递该消息给一个Handler,由它来决定如何处理这个消息,打印到console,文件流的方式写入文件,或者网络流的方式发送一个网络socket.
handlers
Handlers决定如何处理Logger里面的每条日志消息。它表示一个特定的日志处理行为,例如:讲日志消息打印在console屏幕上,写到文件中,或者写入网络socket里。
与logger一样,Handler也有一个日志级别。如果消息的日志级别小于handler的级别,handler讲忽略这条消息。
logger可以有多个handler,而每个hander可以有不同的日志级别。利用这种方式,可以根据消息的重要性,提供不同的handler处理方法。例如:我们可以利用一个handler将ERROR和CRITICAL消息发送给一个页面,而用另一个handler将所有的信息记录到一个文件中用于以后的分析。
Filters
Filter 用于对从logger 传递给handler 的日志记录
进行额外的控制。默认情况下,满足日志级别的任何消息都将被处理。通过安装一个filter,你可以对日志处理添加额外的条件。例如,你可以安装一个filter对其日志消息作拦截处理,只允许处理来自特定源的ERROR消息。
Filters 还可以用于修改将要处理的日志记录的优先级。例如,如果日志记录满足特定的条件,你可以编写一个filter 将日志记录从ERROR降为WARNING。
Filters 可以安装在logger 上或者handler 上;多个filter 可以串联起来实现多层filter 行为。
Formatters
最后,日志记录需要转换成文本。Formatter 表示文本的格式。Fomatter 通常由包含日志记录属性的Python 格式字符串组成;
你也可以编写自定义的fomatter 来实现自己的格式。
二.使用logging
配置好logger、handler、filter 和formatter 之后,你需要在代码中放入logging 调用。使用logging 框架非常简单。下面是个例子:
# import the logging library
import logging
# Get an instance of a logger
logger = logging.getLogger(__name__)
def my_view(request, arg1, arg):
...
if bad_mojo:
# Log an error message
logger.error('Something went wrong!')
就是这样!每次满足bad_mojo条件,将写入一条错误日志记录。
命名Logger
注意:永远不要直接初始化Logger。而应该通过模块级别函数logging.getLogger()调用获取一个Logger的实例来得到它。Logger实例通过名字标示,Logger使用名称目的是用于标示其配置。
Logger 的名称习惯上通常使用__name__
,即包含该logger 的Python 模块的名字。这允许你基于模块filter 和handle 日志调用。如果你想使用其它方式组织日志消息,可以提供点号分隔的名称来标识你的logger:
# Get an instance of a specific named
loggerlogger = logging.getLogger('project.interesting.stuff')
点号分隔的logger 名称定义一个层级。它们在概念上组织成一个层级式的命名空间,用 dots(periods) 作为分割符,例如 'project' 是 'project.interesting' , 的父Logger,"project.interestin"是"project.interestin.stuff"的父logger,Logger 的名称可以任意命名,用以表示记录的信息是在应用程序的哪个部分产生。
层级(module-level logger)为何如此重要?因为可以设置logger 传播它们的logging 调用给它们的上一级。利用这种方式,你可以在根logger 上定义一系列的handler,并捕获子logger 中的所有logging 调用。
在project命名空间中定义的handler 将捕获project.interesting和project.interesting.stuff logger 上的所有日志消息。这种传播行为可以基于每个logger 进行控制。如果你不想让某个logger 传播消息给它的上一级,你也可以关闭这个行为。
logging的调用
Logger 实例为每个默认的日志级别提供一个入口方法:
-
logger.debug()
-
logger.info()
-
logger.warning()
-
logger.error()
-
logger.critical()
还有另外两个调用: -
logger.log()
:打印消息时手工指定日志级别。 -
logger.exception()
:创建一个ERROR级别日志消息,它封装当前异常栈的帧。
配置logging
当然,只是将logging 调用放入你的代码中还是不够的。你还需要配置logger、handler、filter 和formatter 来确保日志的输出是有意义的。
Python 的logging 库提供几种配置logging 的技术,从程序接口到配置文件。
默认情况下,Django 使用dictConfig 格式
为了配置logging,你需要使用LOGGING 来定义字典形式的logging 设置。
这些设置描述你的logging 设置的logger、handler、filter 和formatter,以及它们的日志等级和其它属性。
待续
网友评论