Python日志输出——logging模块

http://blog.csdn.net/chosen0ne/article/details/7319306

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的级别。

[python] view plaincopyprint?

  1. import logging  
  2. import logging.handlers  
  3. LOG_FILE = 'tst.log'
  4. handler = logging.handlers.RotatingFileHandler(LOG_FILE, maxBytes = 1024*1024, backupCount = 5) # 实例化handler 
  5. fmt = '%(asctime)s - %(filename)s:%(lineno)s - %(name)s - %(message)s'
  6. formatter = logging.Formatter(fmt)   # 实例化formatter
  7. handler.setFormatter(formatter)      # 为handler添加formatter
  8. logger = logging.getLogger('tst')    # 获取名为tst的logger
  9. logger.addHandler(handler)           # 为logger添加handler
  10. logger.setLevel(logging.DEBUG)  
  11. logger.info('first info message')  
  12. logger.debug('first debug message')  

        输出:

[plain] view plaincopyprint?

  1. 2012-03-04 23:21:59,682 - log_test.py:16 - tst - first info message   
  2. 2012-03-04 23:21:59,682 - log_test.py:17 - tst - first debug message  

        关于formatter的配置,采用的是%(<dict key>)s的形式,就是字典的关键字替换。提供的关键字包括:

Format

Description

%(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 the LogRecord was created (as returned by time.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 the LogRecord was 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 the LogRecord was 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 as msg % args.

        这个是摘自官网,提供了很多信息。

2. logging的配置

        logging的配置可以采用python代码或是配置文件。python代码的方式就是在应用的主模块中,构建handler,handler,formatter等对象。而配置文件的方式是将这些对象的依赖关系分离出来放在文件中。比如前面的例子就类似于python代码的配置方式。这里看一下采用配置文件的方式。

[python] view plaincopyprint?

  1. import logging  
  2. import logging.config  
  3. logging.config.fileConfig("logging.conf")    # 采用配置文件
  4. # create logger
  5. logger = logging.getLogger("simpleExample")  
  6. # "application" code
  7. logger.debug("debug message")  
  8. logger.info("info message")  
  9. logger.warn("warn message")  
  10. logger.error("error message")  
  11. logger.critical("critical message")  

        loggin.conf采用了模式匹配的方式进行配置,正则表达式是r'^[(.*)]$',从而匹配出所有的组件。对于同一个组件具有多个实例的情况使用逗号‘,’进行分隔。对于一个实例的配置采用componentName_instanceName配置块。使用这种方式还是蛮简单的。

[plain] view plaincopyprint?

  1. [loggers]  
  2. keys=root,simpleExample  
  3. [handlers]  
  4. keys=consoleHandler  
  5. [formatters]  
  6. keys=simpleFormatter  
  7. [logger_root]  
  8. level=DEBUG  
  9. handlers=consoleHandler  
  10. [logger_simpleExample]  
  11. level=DEBUG  
  12. handlers=consoleHandler  
  13. qualname=simpleExample  
  14. propagate=0  
  15. [handler_consoleHandler]  
  16. class=StreamHandler  
  17. level=DEBUG  
  18. formatter=simpleFormatter  
  19. args=(sys.stdout,)  
  20. [formatter_simpleFormatter]  
  21. format=%(asctime)s - %(name)s - %(levelname)s - %(message)s  
  22. datefmt=  

        在指定handler的配置时,class是具体的handler类的类名,可以是相对logging模块或是全路径类名,比如需要RotatingFileHandler,则class的值可以为:RotatingFileHandler或者logging.handlers.RotatingFileHandler。args就是要传给这个类的构造方法的参数,就是一个元组,按照构造方法声明的参数的顺序。

        输出:

[plain] view plaincopyprint?

  1. 2012-03-06 00:09:35,713 - simpleExample - DEBUG - debug message  
  2. 2012-03-06 00:09:35,713 - simpleExample - INFO - info message  
  3. 2012-03-06 00:09:35,714 - simpleExample - WARNING - warn message  
  4. 2012-03-06 00:09:35,714 - simpleExample - ERROR - error message  
  5. 2012-03-06 00:09:35,714 - simpleExample - CRITICAL - critical message  

        这里还要明确一点,logger对象是有继承关系的,比如名为a.b和a.c的logger都是名为a的子logger,并且所有的logger对象都继承于root。如果子对象没有添加handler等一些配置,会从父对象那继承。这样就可以通过这种继承关系来复用配置。

3. 多模块使用logging

        logging模块保证在同一个python解释器内,多次调用logging.getLogger('log_name')都会返回同一个logger实例,即使是在多个模块的情况下。所以典型的多模块场景下使用logging的方式是在main模块中配置logging,这个配置会作用于多个的子模块,然后在其他模块中直接通过getLogger获取Logger对象即可。

        这里使用上面配置文件:

[plain] view plaincopyprint?

  1. [loggers]  
  2. keys=root,main  
  3. [handlers]  
  4. keys=consoleHandler,fileHandler  
  5. [formatters]  
  6. keys=fmt  
  7. [logger_root]  
  8. level=DEBUG  
  9. handlers=consoleHandler  
  10. [logger_main]  
  11. level=DEBUG  
  12. qualname=main  
  13. handlers=fileHandler  
  14. [handler_consoleHandler]  
  15. class=StreamHandler  
  16. level=DEBUG  
  17. formatter=fmt  
  18. args=(sys.stdout,)  
  19. [handler_fileHandler]  
  20. class=logging.handlers.RotatingFileHandler  
  21. level=DEBUG  
  22. formatter=fmt  
  23. args=('tst.log','a',20000,5,)  
  24. [formatter_fmt]  
  25. format=%(asctime)s - %(name)s - %(levelname)s - %(message)s  
  26. datefmt=  

        主模块main.py:

[python] view plaincopyprint?

  1. import logging  
  2. import logging.config  
  3. logging.config.fileConfig('logging.conf')  
  4. root_logger = logging.getLogger('root')  
  5. root_logger.debug('test root logger...')  
  6. logger = logging.getLogger('main')  
  7. logger.info('test main logger')  
  8. logger.info('start import module \'mod\'...')  
  9. import mod  
  10. logger.debug('let\'s test mod.testLogger()')  
  11. mod.testLogger()  
  12. root_logger.info('finish test...')  

        子模块mod.py:

[python] view plaincopyprint?

  1. import logging  
  2. import submod  
  3. logger = logging.getLogger('main.mod')  
  4. logger.info('logger of mod say something...')  
  5. def testLogger():  
  6.     logger.debug('this is mod.testLogger...')  
  7.     submod.tst()  

        子子模块submod.py:

[python] view plaincopyprint?

  1. import logging  
  2. logger = logging.getLogger('main.mod.submod')  
  3. logger.info('logger of submod say something...')  
  4. def tst():  
  5.     logger.info('this is submod.tst()...')  

        然后运行python main.py,控制台输出:

[plain] view plaincopyprint?

  1. 2012-03-09 18:22:22,793 - root - DEBUG - test root logger...  
  2. 2012-03-09 18:22:22,793 - main - INFO - test main logger  
  3. 2012-03-09 18:22:22,809 - main - INFO - start import module 'mod'...  
  4. 2012-03-09 18:22:22,809 - main.mod.submod - INFO - logger of submod say something...  
  5. 2012-03-09 18:22:22,809 - main.mod - INFO - logger say something...  
  6. 2012-03-09 18:22:22,809 - main - DEBUG - let's test mod.testLogger()  
  7. 2012-03-09 18:22:22,825 - main.mod - DEBUG - this is mod.testLogger...  
  8. 2012-03-09 18:22:22,825 - main.mod.submod - INFO - this is submod.tst()...  
  9. 2012-03-09 18:22:22,841 - root - INFO - finish test...           可以看出,和预想的一样,然后在看一下tst.log,logger配置中的输出的目的地:

[plain] view plaincopyprint?

  1. 2012-03-09 18:22:22,793 - main - INFO - test main logger  
  2. 2012-03-09 18:22:22,809 - main - INFO - start import module 'mod'...  
  3. 2012-03-09 18:22:22,809 - main.mod.submod - INFO - logger of submod say something...  
  4. 2012-03-09 18:22:22,809 - main.mod - INFO - logger say something...  
  5. 2012-03-09 18:22:22,809 - main - DEBUG - let's test mod.testLogger()  
  6. 2012-03-09 18:22:22,825 - main.mod - DEBUG - this is mod.testLogger...  
  7. 2012-03-09 18:22:22,825 - main.mod.submod - INFO - this is submod.tst()...  

        tst.log中没有root logger输出的信息,因为logging.conf中配置了只有main logger及其子logger使用RotatingFileHandler,而root logger是输出到标准输出。

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏lgp20151222

@RequestParam与@PathVariable的区别

value:参数名字,即入参的请求参数名字,如username表示请求的参数区中的名字为username的参数的值将传入;

1362
来自专栏小樱的经验随笔

Codeforces 712C Memory and De-Evolution

C. Memory and De-Evolution time limit per test:2 seconds memory limit per test:2...

2826
来自专栏java学习

Spring常用注解(收藏大全)

如果你是初学者,或者是自学者!你可以加小编微信(xxf960513)!小编可以给你学习上,工作上的一些建议以及可以给你(免费)提供学习资料!最重要我们还可以交个...

1042
来自专栏C/C++基础

CMake简介及使用实例

CMake是一个跨平台的建构系统的工具,可以用简单的语句来描述所有平台的安装(编译过程)。他能够输出各种各样的构建文档makefile或者project文件,描...

1852
来自专栏阿杜的世界

Java Web技术经验总结(八)

使用XML文件中的mvc:annoation-driven元素也可以,具体代码如下:

1063
来自专栏青青天空树

spring基础(2:最小化XML配置)

  byType在出现多个匹配项时不会自动选择一个然是报错,为避免报错,有两种办法:1.使用<bean>元素的primary属性,设置为首选Bean,但所有be...

1062
来自专栏代码拾遗

深入理解Spring MVC

使用Spring Boot和web,thymeleaf的starter来设置初始工程。xml配置如下:

1112
来自专栏Linyb极客之路

Spring Cloud开发注意事项

如果provider中需要引入其他feign client的接口,需在 provider的启动类添加注解 @EnableFeignClients(basePac...

3843
来自专栏lgp20151222

Spring中的@scope注解

但是也可以理解成,singleton是启动创建,prototype/request/session/globalsession是动态创建。

1271
来自专栏Golang语言社区

linux 内核同步机制使用

Linux 内核中的同步机制:原子操作、信号量、读写信号量、自旋锁的API、大内核锁、读写锁、大读者锁、RCU和顺序锁。 1、介绍 在现代操作系统里,同一时间...

3985

扫码关注云+社区

领取腾讯云代金券