一、简介
logging模块是python内置的标准模块,主要用于输出运行日志,可以设置输出日志的等级、日志保存路径、日志文件和回滚等;
可以说,logging模块主要由4部分组成:
*Logger 记录器,提供了应用程序代码能直接使用的接口
*Handler 处理器,将记录器产生的日志记录发送至合适的目的地,或者说将Logger产生的日志传到指定位置
*Filters 过滤器,对输出的日志进行过滤,它可以决定输出哪些日志记录
*Formatter 格式化器,控制日志输出的格式,指明了最终输出中日志记录的布局
1.1 Logger 记录器
在记录日志之前,必须要先创建一个记录器,即创建Logger实例。如果没有显式的进行创建,则默认创建一个root logger,并应用默认的日志级别、处理器和格式化器;
(默认的日志级别为:WARN; 默认的处理器Handler[StreamHandler,即将日志信息打印输出在标准输出上]; 默认的格式化器Formatter[默认的格式即为第一个简单使用程序中输出的格式])
记录器创建方法:
1 logger = logging.getLogger(logger_name)
【注意】loggers对象是有父子关系的,当没有父logger对象时它的父对象是root,当拥有父对象时父子关系会被修正。举个例子logging.getLogger("abc.xyz")会创建两个logger对象,一个是abc父对象,一个是xyz子对象,同时abc没有父对象所以它的父对象是root。但是实际上abc是一个占位对象(虚的日志对象),可以没有handler来处理日志。但是root不是占位对象,如果某一个日志对象打日志时,它的父对象会同时收到日志,所以有些使用者发现创建了一个logger对象时会打两遍日志,就是因为他创建的logger打了一遍日志,同时root对象也打了一遍日志
1.2 Handler 处理器
创建Logger实例后,可以使用以下方法进行日志级别设置,增加处理器Handler
logger.setLevel(logging.ERROR) # 设置日志的级别为ERROR, 即只有日志大于等于ERROR的日志才会输出
日志级别:
NOTSET—— 0
DEBUG——10
INFO—— 20
WARNING——30
ERROR ——40
CRITICAL —— 50
当一个logger收到日志信息后先判断是否符合level,如果决定要处理就将信息传递给Handler进行处理
logger.addHandler(handler_name) # 为Logger实例增加一个处理器
logger.removeHandler(handler_name) # 为Logger实例删除一个处理器
一个logger可以拥有多个handler,每个handler同样有一个日志级别,就是说logger可以根据不同的日志级别将日志传递给不同的handler。当然也可以相同的级别传递给多个handlers这就根据需求来灵活的设置了。
Handler处理器类型有很多种,比较常用的有三个,StreamHandler,FileHandler,NullHandler
StreamHandler:
创建方法:
sh = logging.StreamHandler(stream=None)
当创建StreamHandler之后,可以通过使用以下方法设置日志级别,设置格式化器Formatter,增加或删除过滤器Filter。
sh.setLevel(logging.WARN) # 指定日志级别,低于WARN级别的日志将会被忽略
sh.setFormatter(formatter_name) # 设置一个格式化器formatter
sh.addFilter(filter_name) # 增加一个过滤器,可以增加多个
sh.removeFilter(filter_name) # 删除一个过滤器
FileHandler:
创建方法:
fh = logging.fileHandler(filename, mode=‘a‘,encoding=None,delay=False)
NullHandler:
NullHandler类位于核心logging包,不做任何的格式化或者输出。本质上它是个“什么都不做”的handler,由库开发者使用
1.3 Filter 过滤器
Filters 提供了更细粒度的判断,来决定日志是否需要打印。原则上handler获得一个日志就必定会根据级别被统一处理,但是如果handler拥有一个Filter可以对日志进行额外的处理和判断。例如Filter能够对来自特定源的日志进行拦截or修改甚至修改其日志级别(修改后再进行级别判断)。
logger和handler都可以安装filter甚至可以安装多个filter串联起来。
创建方法:
filter = logging.Filter(name=‘‘)
1.4 Formatter 格式化器
Formatter 指定了最终某条记录打印的格式布局。Formatter会将传递来的信息拼接成一条具体的字符串。使用Formatter对象设置日志信息最后的规则、结构和内容,默认的时间格式为%Y-%m-%d %H:%M:%S。
创建方法:
formatter = logging.Formatter(fmt=None, datefmt=None)
其中,fmt是消息的格式化字符串,datefmt是日期字符串。如果不指明fmt,将使用‘%(message)s‘。如果不指明datefmt,将使用ISO8601日期格式。
另外,Logger是一个树形层级结构,一个Logger可以包含一个或者多个Handler和Filter,一个Logger实例可以新增多个Handler,一个Handler可以新增多个格式化器或者多个过滤器,而且日志级别将会继承。
二、Logging工作流程
2.1 logging模块使用过程
*导入logging模块,logging模块中的代码将会被执行,这个过程中将产生logging日志系统的默认配置
*自定义配置,logging标准模块支持三种配置方式:dictConfig, fileConfig, listen。其中,dictConfig是通过一个字典进行配置Logger,Handler,FilterFormatter; fileConfig则是通过一个字典进行配置;而listen则是监听一个网络端口,通过接收网络数据来进行配置。当然除了以上的集团化配置外,也可以直接调用Logger,Handler等对象中的方法在代码中显式配置。
*使用logging模块的全局作用域中的getLogger函数来得到一个Logger对象实例
*使用Logger对象中的debug,info,error,warn,critical等方法记录日志信息。
2.2 logging模块处理流程
*判断日志的级别是否大于Logger对象的等级,如果大于,则往下执行,否则,流程结束
*产生日志。第一步,判断是否有异常,如果有,则添加异常信息。第二步,处理日志记录方法中的占位符,即一般的字符串格式化处理
*使用注册到Logger对象中的Filters进行过滤。如果有多个过滤器,则依次过滤。只要有一个过滤器返回假,则结束过滤,且该日志信息将丢弃,不再处理
,而处理流程也至此结束,否则,处理流程往下执行。
*在当前Logger对象中查找Handler,如果查找不到任何Handler,则往上到该Logger对象的父Logger中查找,如果找到一个或多个Handler,则依次用Handler来处理日志信息。但在每个Handler处理日志信息过程中,会首先判断日志信息的等级是否大于该Handler的等级,如果大于,则往下执行(由Logger对象进入Handler对象中),否则,处理流程结束。
*执行Handler对象中的filter方法,该方法会依次执行注册到该Handler对象中的Filter。如果有一个Filter判断该日志信息为假,则此后的所有Filter都不再执行,而直接将该日志信息丢弃,处理流程结束
*使用Formatter类格式化最终的输出结果。 注:Formatter同上述第2步的字符串格式化不同,它会添加额外的信息,比如日志产生的时间,产生日志的源代码所在的源文件的路径等等。
*真正地输出日志信息(到网络,文件,终端,邮件等)。至于输出到哪个目的地,由Handler的种类来决定
三、日志配置
3.1 配置方式
*显式创建记录器Logger、处理器Handler和格式化器Formatter,并进行相关设置
*通过简单方式进行配置,使用basicConfig()函数直接进行配置
*通过配置文件进行配置,使用fileConfig()函数读取配置文件
*通过配置字典进行配置,使用dictConfig()函数读取配置信息
*通过网络进行配置,使用listen()函数进行网络配置
——basicConfig关键字参数
filename:创建一个FileHandle,使用指定的文件名,而不是使用StreamHandle
filemode:如果指明了文件名,指明打开文件的模式,默认为‘a’
format:handler使用指明的格式化字符串
detefmt:使用指明的时间日期格式
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 -- 打印进程信息
内容来源:https://www.jianshu.com/p/feb86c06c4f4 http://python.jobbole.com/87300/