Python 学习入门(14)—— logging
1. logging介绍
Python的logging模块提供了通用的日志系统,可以方便第三方模块或者是应用使用。这个模块提供不同的日志级别,并可以采用不同的方式记录日志,比如文件,HTTP GET/POST,SMTP,Socket等,甚至可以自己实现具体的日志记录方式。
logging模块与log4j的机制是一样的,只是具体的实现细节不同。模块提供logger,handler,filter,formatter。
logger:提供日志接口,供应用代码使用。logger最长用的操作有两类:配置和发送日志消息。可以通过logging.getLogger(name)获取logger对象,如果不指定name则返回root对象,多次使用相同的name调用getLogger方法返回同一个logger对象。
handler:将日志记录(log record)发送到合适的目的地(destination),比如文件,socket等。一个logger对象可以通过addHandler方法添加0到多个handler,每个handler又可以定义不同日志级别,以实现日志分级过滤显示。
filter:提供一种优雅的方式决定一个日志记录是否发送到handler。
formatter:指定日志记录输出的具体格式。formatter的构造方法需要两个参数:消息的格式字符串和日期字符串,这两个参数都是可选的。
与log4j类似,logger,handler和日志消息的调用可以有具体的日志级别(Level),只有在日志消息的级别大于logger和handler的级别。
#!/usr/bin/python # -*- coding:utf-8 -*- # # ithomer.net import logging import logging.handlers LOG_FILE = 'tst.log' handler = logging.handlers.RotatingFileHandler(LOG_FILE, maxBytes = 1024*1024, backupCount=5) fmt = '%(asctime)s - %(filename)s:%(lineno)s - %(name)s - %(levelname)s - %(message)s' formatter = logging.Formatter(fmt) handler.setFormatter(formatter) logger = logging.getLogger('tst') logger.addHandler(handler) logger.setLevel(logging.DEBUG) logger.info('info msg') logger.debug('debug msg')
运行结果(tst.log日志文件内容):
2013-11-28 21:19:25,442 - logtest3.py:21 - tst - INFO - info msg
2013-11-28 21:19:25,442 - logtest3.py:22 - tst - DEBUG - debug msg
关于formatter的配置,采用的是%(<dict key>)s的形式,就是字典的关键字替换。提供的关键字包括:
%(name)s | Name of the logger (logging channel). |
%(levelno)s | Numeric logging level for the message (DEBUG,INFO,WARNING,ERROR,CRITICAL). |
%(levelname)s | Text logging level for the message ('DEBUG','INFO','WARNING','ERROR','CRITICAL'). |
%(pathname)s | Full pathname of the source file where the logging call was issued (if available). |
%(filename)s | Filename portion of pathname. |
%(module)s | Module (name portion of filename). |
%(funcName)s | Name of function containing the logging call. |
%(lineno)d | Source line number where the logging call was issued (if available). |
%(created)f | Time when theLogRecordwas created (as returned bytime.time()). |
%(relativeCreated)d | Time in milliseconds when the LogRecord was created, relative to the time the logging module was loaded. |
%(asctime)s | Human-readable time when theLogRecordwas created. By default this is of the form “2003-07-08 16:49:45,896” (the numbers after the comma are millisecond portion of the time). |
%(msecs)d | Millisecond portion of the time when theLogRecordwas created. |
%(thread)d | Thread ID (if available). |
%(threadName)s | Thread name (if available). |
%(process)d | Process ID (if available). |
%(message)s | The logged message, computed asmsg%args. |
2. logging的配置
logging的配置可以采用python代码或是配置文件。python代码的方式就是在应用的主模块中,构建handler,handler,formatter等对象。而配置文件的方式是将这些对象的依赖关系分离出来放在文件中。比如前面的例子就类似于python代码的配置方式。这里看一下采用配置文件的方式。
#!/usr/bin/python # -*- coding:utf-8 -*- # # ithomer.net import logging import logging.config LOG_FILE = 'tst.log' logging.config.fileConfig('logging.conf') # instance of logging logger = logging.getLogger('tst') logger.debug('debug msg') logger.info('info msg') logger.warn('warn msg') logger.error('error msg') logger.critical('critical msg')
loggin.conf采用了模式匹配的方式进行配置,正则表达式是r'^[(.*)]$',从而匹配出所有的组件。对于同一个组件具有多个实例的情况使用逗号‘,’进行分隔。对于一个实例的配置采用componentName_instanceName配置块。使用这种方式还是蛮简单的。
[loggers] keys=root,tst [handlers] keys=consoleHandler [formatters] keys=tstFormatter [logger_root] level=DEBUG handlers=consoleHandler [logger_tst] level=DEBUG handlers=consoleHandler qualname=tst propagate=0 [handler_consoleHandler] class=StreamHandler level=DEBUG formatter=tstFormatter args=(sys.stdout,) [formatter_tstFormatter] format=%(asctime)s - %(filename)s:%(lineno)s - %(name)s - %(levelname)s - %(message)s datefmt=在指定handler的配置时,class是具体的handler类的类名,可以是相对logging模块或是全路径类名,比如需要RotatingFileHandler,则class的值可以为:RotatingFileHandler或者logging.handlers.RotatingFileHandler。args就是要传给这个类的构造方法的参数,就是一个元组,按照构造方法声明的参数的顺序。
运行结果,控制台输出:
2013-11-28 23:02:32,574 - logtest4.py:16 - tst - DEBUG - debug msg
2013-11-28 23:02:32,574 - logtest4.py:17 - tst - INFO - info msg
2013-11-28 23:02:32,574 - logtest4.py:18 - tst - WARNING - warn msg
2013-11-28 23:02:32,574 - logtest4.py:19 - tst - ERROR - error msg
2013-11-28 23:02:32,574 - logtest4.py:20 - tst - CRITICAL - critical msg
这里还要明确一点,logger对象是有继承关系的,比如名为a.b和a.c的logger都是名为a的子logger,并且所有的logger对象都继承于root。如果子对象没有添加handler等一些配置,会从父对象那继承。这样就可以通过这种继承关系来复用配置。
3. 多模块使用logging
这里使用上面配置文件:
[loggers] keys=root,main [handlers] keys=consoleHandler,fileHandler [formatters] keys=fmt [logger_root] level=DEBUG handlers=consoleHandler [logger_main] level=DEBUG handlers=fileHandler qualname=main #propagate=0 [handler_consoleHandler] class=StreamHandler level=DEBUG formatter=fmt args=(sys.stdout,) [handler_fileHandler] class=logging.handlers.RotatingFileHandler level=DEBUG formatter=fmt args=('tst.log','a',20000,5,) [formatter_fmt] format=%(asctime)s - %(filename)s:%(lineno)s - %(name)s - %(levelname)s - %(message)s datefmt=主模块main.py:
#!/usr/bin/python # -*- coding:utf-8 -*- # # main.py # # ithomer.net import logging import logging.config logging.config.fileConfig('logging.conf') # root logger_root = logging.getLogger('root') logger_root.debug('debug root') # main logger_main = logging.getLogger('main') logger_main.info('info main') logger_main.info('start import module \'mod\'...') import mod logger_main.debug('test mod.testLogger()') mod.testLogger() logger_root.info('the end!')
子模块mod.py:
#!/usr/bin/python # -*- coding:utf-8 -*- # # mod.py # # ithomer.net import logging logger = logging.getLogger('main.mod') logger.info('info of main.mod') def testLogger(): logger.debug('this is main.mod testLogging()') logger.info('start import module \'submod\'...') import submod submod.testLogger()
子子模块submod.py:
#!/usr/bin/python # -*- coding:utf-8 -*- # # submod.py # # ithomer.net import logging logger = logging.getLogger('main.mod.submod') logger.info('info of main.mod.submod') def testLogger(): logger.debug('this is main.mod.submod testLogging()')然后运行python main.py,控制台输出:
2013-11-28 16:58:15,517 - main.py:16 - root - DEBUG - debug root 2013-11-28 16:58:15,517 - main.py:20 - main - INFO - info main 2013-11-28 16:58:15,517 - main.py:22 - main - INFO - start import module 'mod'... 2013-11-28 16:58:15,518 - mod.py:11 - main.mod - INFO - info of main.mod 2013-11-28 16:58:15,518 - main.py:24 - main - DEBUG - test mod.testLogger() 2013-11-28 16:58:15,518 - mod.py:14 - main.mod - DEBUG - this is main.mod testLogging() 2013-11-28 16:58:15,519 - mod.py:15 - main.mod - INFO - start import module 'submod'... 2013-11-28 16:58:15,519 - submod.py:11 - main.mod.submod - INFO - info of main.mod.submod 2013-11-28 16:58:15,519 - submod.py:14 - main.mod.submod - DEBUG - this is main.mod.submod testLogging() 2013-11-28 16:58:15,519 - main.py:27 - root - INFO - the end!
可以看出,和预想的一样,然后在看一下tst.log,logger配置中的输出的目的地:
2013-11-28 16:58:15,517 - main.py:20 - main - INFO - info main 2013-11-28 16:58:15,517 - main.py:22 - main - INFO - start import module 'mod'... 2013-11-28 16:58:15,518 - mod.py:11 - main.mod - INFO - info of main.mod 2013-11-28 16:58:15,518 - main.py:24 - main - DEBUG - test mod.testLogger() 2013-11-28 16:58:15,518 - mod.py:14 - main.mod - DEBUG - this is main.mod testLogging() 2013-11-28 16:58:15,519 - mod.py:15 - main.mod - INFO - start import module 'submod'... 2013-11-28 16:58:15,519 - submod.py:11 - main.mod.submod - INFO - info of main.mod.submod 2013-11-28 16:58:15,519 - submod.py:14 - main.mod.submod - DEBUG - this is main.mod.submod testLogging()tst.log中没有root logger输出的信息,因为logging.conf中配置了只有main logger及其子logger使用RotatingFileHandler,而root logger是输出到标准输出。
1、从一个使用场景开始
开发一个日志系统, 既要把日志输出到控制台, 还要写入日志文件
#!/usr/bin/python # ithomer in 2013 import logging # create instance of logging logger = logging.getLogger('mylogger') logger.setLevel(logging.DEBUG) # file handler fh = logging.FileHandler('test.log') fh.setLevel(logging.DEBUG) # console handler ch = logging.StreamHandler() ch.setLevel(logging.DEBUG) # formatter fmt = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s') fh.setFormatter(fmt) ch.setFormatter(fmt) # add formatter to handler logger.addHandler(fh) logger.addHandler(ch) # print a log logger.info('ithomer')运行后, 在控制台和日志文件(test.log)都有一条日志:
2013-11-27 23:45:20,329 - mylogger - INFO - ithomer
2、logging模块的API
结合上面的例子,我们说下几个最常使用的API
>>> print logging.NOTSET
0
>>> print logging.DEBUG
10
>>> print logging.INFO
20
>>> print logging.WARNING
30
>>> print logging.ERROR
40
>>> print logging.CRITICAL
50
如果把looger的级别设置为INFO, 那么小于INFO级别的日志都不输出,大于等于INFO级别的日志都输出
logger.debug("foobar") # 不输出
logger.info("foobar") # 输出
logger.warning("foobar") # 输出
logger.error("foobar") # 输出
logger.critical("foobar") # 输出
logging.basicConfig(format='%(levelname)s:%(message)s', level=logging.DEBUG)
logging.debug('This message should appear on the console')
3、root logger与logger 父子关系
最后到达root logger,一定设置过level。默认为logging.WARNING,child loggers得到消息后,既把消息分发给它的handler处理,也会传递给所有祖先logger处理,来看一个例子:
#/usr/bin/python # ithomer in 2013 import logging # root logger root = logging.getLogger() # root ch = logging.StreamHandler() ch.setLevel(logging.DEBUG) formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s') ch.setFormatter(formatter) root.addHandler(ch) # logging as parent p = logging.getLogger('foo') p.setLevel(logging.DEBUG) ch = logging.StreamHandler() ch.setLevel(logging.DEBUG) formatter = logging.Formatter('%(asctime)s - %(message)s') ch.setFormatter(formatter) p.addHandler(ch) # logging as child c = logging.getLogger('foo.bar') c.debug('foo')
运行结果:
2013-11-27 22:40:56,699 - foo
2013-11-27 22:40:56,699 - DEBUG - foo
参考推荐:
相关推荐
从零开始学习CANoe(十三)—— Logging Window_蚂蚁小兵-CSDN博客.html
用python写程序的,作为一个完整的项目而言,必须要有日志模块,而python的logging模块为我们提供了这么一种很好的机制,很方便的解决了这个问题。
logging模块是Python的内置模块,主要用于输出运行日志,可以灵活配置输出日志的各项信息。这篇文章主要介绍了Python常用模块logging——日志输出的实例代码,需要的朋友可以参考下
python库。 资源全名:python-logging-loki-0.2.0.tar.gz
实现了简单版本的logging.config,支持一般的通过config文件进行配置。感觉还有更好的方法,是直接利用logging.config.fileConfig(log_config_file)方式读进来之后,通过修改handler方式来进行修改。 复制代码 代码...
python库。资源全名:ecs-logging-1.0.0.tar.gz
[python]-日志记录之logging(csdn)————程序
logging模块是Python内置的标准模块,主要用于输出运行日志,可以设置输出日志的等级、日志保存路径、日志文件回滚等;相比print,具备如下优点: 可以通过设置不同的日志等级,在release版本中只输出重要信息,而...
logging python
资源分类:Python库 所属语言:Python 资源全名:logging_kernel-1.13.tar.gz 资源来源:官方 安装方法:https://lanzao.blog.csdn.net/article/details/101784059
14. Interactive Input Editing and History Substitution 133 14.1. Tab Completion and History Editing 133 14.2. Alternatives to the Interactive Interpreter 133 15. Floating Point Arithmetic: Issues and ...
Python模块学习logging 在部署项目时,不可能直接将所有的信息都输出到控制台中,我们可以将这些信息记录到日志文件中,这样不仅方便我们查看程序运行时的情况,也可以在项目出现故障时根据运行时产生的日志快速定位...
资源分类:Python库 所属语言:Python 资源全名:micropython-logging-0.1.1.tar.gz 资源来源:官方 安装方法:https://lanzao.blog.csdn.net/article/details/101784059
资源分类:Python库 所属语言:Python 使用前提:需要解压 资源全名:logging_elk_manager-0.0.1-py3-none-any.whl 资源来源:官方 安装方法:https://lanzao.blog.csdn.net/article/details/101784059
python 日志使用记录参考链接Python日志输出——logging模块Python之日志处理(logging模块)python logging现学现用 –
详解python的日志模块logging和django中对logging模块的使用
Python学习资料
资源分类:Python库 所属语言:Python 资源全名:python_logging_discord_handler-0.1-py3-none-any.whl 资源来源:官方 安装方法:https://lanzao.blog.csdn.net/article/details/101784059
Logbook-一个很酷的logging库,用来替换Python 内置logging库