![f393c96b6ea60d7391cd3561b0e04476.png](https://i-blog.csdnimg.cn/blog_migrate/7dd887394960a21e378adbaecc0f6a10.jpeg)
本模块以例子为基础,来阐述python3的logging模块,参考链接为https://www.cnblogs.com/nancyzhu/p/8551506.html
样例一
import logginglogger = logging.getLogger('test')logger.setLevel('INFO')handler = logging.StreamHandler()formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')handler.setFormatter(formatter)logger.addHandler(handler)logger.debug('debug message')logger.info('info message')logger.warning('warn message')logger.error('error message')logger.critical('critical message')
结果:
D:pythonpython.exe D:/mywork/autotest/test04-pytest/logg.py2020-05-31 17:05:42,531 - test - INFO - info message2020-05-31 17:05:42,532 - test - WARNING - warn message2020-05-31 17:05:42,532 - test - ERROR - error message2020-05-31 17:05:42,532 - test - CRITICAL - critical message进程已结束,退出代码0
![1c71aad58fb74f654ce2eb03af9f0692.png](https://i-blog.csdnimg.cn/blog_migrate/698df45aa4fa0ced09434455ab9b10e0.jpeg)
日志作用
通过log的分析,可以方便用户了解系统或软件、应用的运行情况;如果你的应用log足够丰富,也可以分析以往用户的操作行为、类型喜好、地域分布或其他更多信息;如果一个应用的log同时也分了多个级别,那么可以很轻易地分析得到该应用的健康状况,及时发现问题并快速定位、解决问题,补救损失。
简单来讲就是,我们通过记录和分析日志可以了解一个系统或软件程序运行情况是否正常,也可以在应用程序出现故障时快速定位问题。比如,做运维的同学,在接收到报警或各种问题反馈后,进行问题排查时通常都会先去看各种日志,大部分问题都可以在日志中找到答案。再比如,做开发的同学,可以通过IDE控制台上输出的各种日志进行程序调试。对于运维老司机或者有经验的开发人员,可以快速的通过日志定位到问题的根源。可见,日志的重要性不可小觑。日志的作用可以简单总结为以下3点:
- 程序调试
- 了解软件程序运行情况,是否正常
- 软件程序运行故障分析与问题定位
如果应用的日志信息足够详细和丰富,还可以用来做用户行为分析,如:分析用户的操作行为、类型洗好、地域分布以及其它更多的信息,由此可以实现改进业务、提高商业利益。
日志等级
python logging提供了一组便利的函数,用来做简单的日志。它们是 debug()、 info()、 warning()、 error() 和 critical()。
logging函数根据它们用来跟踪的事件的级别或严重程度来命名。标准级别及其适用性描述如下(以严重程度递增排序):
![b5e5102aa9f9e49b6ea59e6c6af81437.png](https://i-blog.csdnimg.cn/blog_migrate/0100b1cfe1c0eb2962b88cede03d3dad.jpeg)
默认等级是WARNING,这意味着仅仅这个等级及以上的才会反馈信息,除非logging模块被用来做其它事情。
![c6888583813fcb084b00293b096345bd.png](https://i-blog.csdnimg.cn/blog_migrate/35460c7f1ef8aead87261306ff221e1d.jpeg)
打印到控制台
被跟踪的事件能以不同的方式被处理。最简单的处理方法就是把它们在控制台上打印出来。另一种常见的方法就是写入磁盘文件。首先我们来说一下,打印到控制台的方法:
import logginglogging.debug('debug 信息')logging.warning('warning信息')logging.info('info 信息')
结果(由于默认设置的等级是warning,所有只有warning的信息会输出到控制台。):
D:pythonpython.exe D:/mywork/autotest/test04-pytest/logger.pyWARNING:root:warning信息进程已结束,退出代码0
利用logging.basicConfig()打印信息到控制台:
import logginglogging.basicConfig(format='%(asctime)s - %(pathname)s[line:%(lineno)d] - %(levelname)s: %(message)s', level=logging.DEBUG) //由于在logging.basicConfig()中的level 的值设置为logging.DEBUG, 所有debug, info, warning, error, critical 的log都会打印到控制台。logging.debug('debug 信息')logging.info('info 信息')logging.warning('warning 信息')logging.error('error 信息')logging.critical('critial 信息')//所以如果设置level = logging.info()的话,debug 的信息则不会输出到控制台。
结果:
D:pythonpython.exe D:/mywork/autotest/test04-pytest/logger.py2020-05-31 17:57:19,743 - D:/mywork/autotest/test04-pytest/logger.py[line:6] - WARNING: warning 信息2020-05-31 17:57:19,744 - D:/mywork/autotest/test04-pytest/logger.py[line:7] - ERROR: error 信息2020-05-31 17:57:19,744 - D:/mywork/autotest/test04-pytest/logger.py[line:8] - CRITICAL: critial 信息进程已结束,退出代码0
由于在logging.basicConfig()中的level 的值设置为logging.DEBUG, 所有debug, info, warning, error, critical 的log都会打印到控制台。所以如果设置level = logging.info()的话,debug 的信息则不会输出到控制台。
![669a9725b392a007525a7d61faa7e71b.png](https://i-blog.csdnimg.cn/blog_migrate/399d46e1c5cb3e43a360b1c246cd7d83.jpeg)
利用logging.basicConfig()保存到log文件
利用logging.basicConfig()保存log到文件
logging.basicConfig(level=logging.DEBUG,//控制台打印的日志级别 filename='new.log', filemode='a',//模式,有w和a,w就是写模式,每次都会重新写日志,覆盖之前的日志 //a是追加模式,默认如果不写的话,就是追加模式 format= '%(asctime)s - %(pathname)s[line:%(lineno)d] - %(levelname)s: %(message)s' //日志格式 )
如果在logging.basicConfig()设置filename 和filemode,则只会保存log到文件,不会输出到控制台。
既往屏幕输入,也往文件写入log
import os.pathimport loggingimport timeclass Logger(object): def __init__(self, logger): self.logger = logging.getLogger(logger) self.logger.setLevel(logging.DEBUG) rq = time.strftime('%Y%m%d%H%M', time.localtime(time.time())) log_path = os.path.dirname(os.path.abspath('.')) + '/logs/' log_name = log_path + rq + '.log' fh = logging.FileHandler(log_name) fh.setLevel(logging.INFO) ch = logging.StreamHandler() ch.setLevel(logging.INFO) formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s') fh.setFormatter(formatter) ch.setFormatter(formatter) self.logger.addHandler(fh) self.logger.addHandler(ch) def getlog(self): return self.logger
结果(上例封装了类,其他地方调用该类):
2020-05-31 17:11:12,134 - read_config - INFO - the configPath: D:myworkautotestznfz_test1configconfig.ini2020-05-31 17:11:12,346 - read_config - INFO - the userInfo : 周朝阳2020-05-31 17:11:12,347 - read_config - INFO - the userInfo : qazwsxedc2020-05-31 17:11:12,357 - read_config - INFO - the browserType : Chrome2020-05-31 17:11:12,357 - read_config - INFO - the testUrl : https://www.baidu.com2020-05-31 17:11:12,357 - browser_engine - INFO - browserName: Chrome2020-05-31 17:11:15,848 - read_config - INFO - the browserType : Chrome2020-05-31 17:11:15,848 - read_config - INFO - the userInfo : 周朝阳2020-05-31 17:11:15,850 - read_config - INFO - the userInfo : qazwsxedc
logging库采取了模块化的设计,提供了许多组件:记录器、处理器、过滤器和格式化器:
- Logger 暴露了应用程序代码能直接使用的接口。
- Handler将(记录器产生的)日志记录发送至合适的目的地。
- Filter提供了更好的粒度控制,它可以决定输出哪些日志记录。
- Formatter 指明了最终输出中日志记录的布局。
Handlers
处理程序对象负责将适当的日志消息(基于日志消息的严重性)分派到处理程序的指定目标。Logger 对象可以通过addHandler()方法增加零个或多个handler对象。举个例子,一个应用可以将所有的日志消息发送至日志文件,所有的错误级别(error)及以上的日志消息发送至标准输出,所有的严重级别(critical)日志消息发送至某个电子邮箱。在这个例子中需要三个独立的处理器,每一个负责将特定级别的消息发送至特定的位置。
常用的有4种:
- logging.StreamHandler -> 控制台输出
使用这个Handler可以向类似与sys.stdout或者sys.stderr的任何文件对象(file object)输出信息。
它的构造函数是:
StreamHandler([strm])
其中strm参数是一个文件对象。默认是sys.stderr
- logging.FileHandler -> 文件输出
和StreamHandler类似,用于向一个文件输出日志信息。不过FileHandler会帮你打开这个文件。它的构造函数是:
FileHandler(filename[,mode])
filename是文件名,必须指定一个文件名。
mode是文件的打开方式。默认是’a',即添加到文件末尾。
- logging.handlers.RotatingFileHandler -> 按照大小自动分割日志文件,一旦达到指定的大小重新生成文件
这个Handler类似于上面的FileHandler,但是它可以管理文件大小。当文件达到一定大小之后,它会自动将当前日志文件改名,然后创建 一个新的同名日志文件继续输出。比如日志文件是chat.log。当chat.log达到指定的大小之后,RotatingFileHandler自动把 文件改名为chat.log.1。不过,如果chat.log.1已经存在,会先把chat.log.1重命名为chat.log.2。。。最后重新创建 chat.log,继续输出日志信息。它的构造函数是:
RotatingFileHandler( filename[, mode[, maxBytes[, backupCount]]])
其中filename和mode两个参数和FileHandler一样。
maxBytes用于指定日志文件的最大文件大小。如果maxBytes为0,意味着日志文件可以无限大,这时上面描述的重命名过程就不会发生。
backupCount用于指定保留的备份文件的个数。比如,如果指定为2,当上面描述的重命名过程发生时,原有的chat.log.2并不会被更名,而是被删除。
- logging.handlers.TimedRotatingFileHandler -> 按照时间自动分割日志文件
这个Handler和RotatingFileHandler类似,不过,它没有通过判断文件大小来决定何时重新创建日志文件,而是间隔一定时间就 自动创建新的日志文件。重命名的过程与RotatingFileHandler类似,不过新的文件不是附加数字,而是当前时间。它的构造函数是:
TimedRotatingFileHandler( filename [,when [,interval [,backupCount]]])
其中filename参数和backupCount参数和RotatingFileHandler具有相同的意义。
interval是时间间隔。
when参数是一个字符串。表示时间间隔的单位,不区分大小写。它有以下取值:
S 秒
M 分
H 小时
D 天
W 每星期(interval==0时代表星期一)
midnight 每天凌晨
配置方法:
- setLevel()方法和日志对象的一样,指明了将会分发日志的最低级别。为什么会有两个setLevel()方法?记录器的级别决定了消息是否要传递给处理器。每个处理器的级别决定了消息是否要分发。
- setFormatter()为该处理器选择一个格式化器。
- addFilter()和removeFilter()分别配置和取消配置处理程序上的过滤器对象。