Python logging模块使用配置文件记录日志

- 日理万妓 2021-12-03 03:57 284阅读 0赞

良好的日志是应用程序调试、质量跟踪的重要线索，因此在应用开发过程中应当养成良好的日志记录习惯。在Python中内建了logging模块，可以使用该模块生成高质量的应用程序日志。

# 基本用法 #

默认情况下，logging将日志打印到屏幕，日志级别为WARNING；日志级别大小关系为：CRITICAL > ERROR > WARNING > INFO > DEBUG > NOTSET，当然也可以自己定义日志级别。

import logging
    
    logging.debug('This is debug message')
    logging.info('This is info message')
    logging.warning('This is warning message')

# 推荐用法 #

在项目中推荐使用**按照时间的滚动日志记录**方式，并使用**配置文件**进行日志记录配置。这样有很多好处：不会让日志文件无限变大，很容易实现保留最近N天日志的功能，需要修改日志记录规则直接改配置文件就好。按照时间滚动的日志需要使用TimedRotationHandler，其定义如下所示：

> 所谓按时间滚动意思是系统会在时间满足一定条件时给旧的日志文件存档，并仅保留一定时间内的日志，最终存档的日志文件名称类似：xx.log.2016-06-01。

class logging.handlers.TimedRotatingFileHandler(filename, when='h', interval=1, backupCount=0, encoding=None, delay=False, utc=False)

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>名称</th> 
   <th>解释</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>filename</td> 
   <td>文件名</td> 
   <td>在时间滚动模式中，它实际上代表文件名的前缀</td> 
  </tr> 
  <tr> 
   <td>when</td> 
   <td>时间</td> 
   <td>按照哪种时间单位滚动（可选s-按秒，m-按分钟，h-按小时，d-按天，w0-w6-按指定的星期几，midnight-在午夜）</td> 
  </tr> 
  <tr> 
   <td>interval</td> 
   <td>间隔</td> 
   <td>比如when设置为s，interval设置为1意思是每1秒</td> 
  </tr> 
  <tr> 
   <td>backupCount</td> 
   <td>备份数量</td> 
   <td>保存几份日志，系统会自动删除超出此数目的日志文件</td> 
  </tr> 
  <tr> 
   <td>encoding</td> 
   <td>编码</td> 
   <td>默认是UTF-8编码</td> 
  </tr> 
  <tr> 
   <td>delay</td> 
   <td>延迟写入</td> 
   <td>如果设置为True那么只有调用了emit()后才会写入文件。</td> 
  </tr> 
  <tr> 
   <td>utc</td> 
   <td>标准时间</td> 
   <td>设置为False(默认)使用本地时间，否则使用标准时间</td> 
  </tr> 
 </tbody> 
</table>

## 配置文件 ##

下面简单介绍一下配置文件中的要素。

### 设置按时间滚动 ###

可以在log.conf文件中用下面的样式设置按时间滚动的handler。使用class指定handler，使用level指定使用此handler处理的日志级别，使用formatter指定此handler的日志格式，使用args传递参数，参数应该按上述定义的顺序写。

### 设置HTTP ###

题外话：可以设置向HTTP服务器发送数据，通常在一个分布式的环境中，我们会选择实现一个HTTP接口用来接收来自各个网络组件的日志。

## 使用示例 ##

可以使用下面的代码从配置文件中载入日志配置并进行日志记录。

import logging
    import logging.config
    
    logging.config.fileConfig("logger.conf")
    logger = logging.getLogger("example01")
    
    logger.debug('This is debug message')
    logger.info('This is info message')
    logger.warning('This is warning message')

# 在工程中的实践 #

下面我们来看看如何在实际的工程中按照推荐的用法使用logging模块。在工程中，我推荐使用下面这种结构：

--lib   |--class1.py
      |--class2.py
    --config.py --main.py --logger.conf

工程中我们使用一个名字为config.py的Python模块用来保存全局的配置，由于logging在工程中每个源代码文件都可能用到，因此我们把logging模块在config.py中生成一个实例，这样其它模块只需要引用这个实例就可以了。

import logging
    import logging.config
    from pymongo import MongoClient
    
    config = {    "key1":"value1"     }
    
    logging.config.fileConfig("logger.conf")
    logger = logging.getLogger("cse")

在其它模块中，我们使用这样的语句引用logger对象：

from config import logger

需要记录日志的时候，只需要使用logger.error，logger.debug类似的语句就好了。

## 完整的logger.conf ##

下面是一个完整的logger.conf文件示例，它默认为会将日志存储在当前目录的log目录下，会将ERROR及以上级别的日志通过POST请求发送到[http://localhost:8087/api/v1.0/log][http_localhost_8087_api_v1.0_log]。请根据需要自行修改。

#logger.conf
    
    ###############################################
    
    [loggers]
    keys=root,cse
    
    [logger_root]
    level=DEBUG
    handlers=stream
    
    [logger_cse]
    handlers=stream,timedrt,http
    qualname=cse
    propagate=0
    
    ###############################################
    
    [handlers]
    keys=stream,timedrt,http
    
    [handler_stream]
    class=StreamHandler
    level=NOTSET
    formatter=form01
    args=(sys.stderr,)
    
    [handler_filert]
    class=handlers.RotatingFileHandler
    level=INFO
    formatter=form02
    args=('log/cse.log', 'a', 10*1024*1024, 5)
    
    [handler_timedrt]
    class=handlers.TimedRotatingFileHandler
    level=DEBUG
    formatter=form01
    args=('log/cse.log', 'd', 1 , 10 )
    
    [handler_http]
    class=handlers.HTTPHandler
    level=ERROR
    formatter=form01
    args=('localhost:8087', '/api/v1.0/log', 'POST')
    
    
    ###############################################
    
    [formatters]
    keys=form01,form02
    
    [formatter_form01]
    format=[%(asctime)s][%(filename)s][line:%(lineno)d][%(levelname)s] %(message)s
    datefmt=%a, %d %b %Y %H:%M:%S
    
    [formatter_form02]
    format=%(name)-12s: %(levelname)-8s %(message)s
    datefmt=

> **值得一提的是，logging模块是线程安全的。**

# 参考文档 #

*  [https://docs.python.org/2/library/logging.html][https_docs.python.org_2_library_logging.html]
 *  转载 [https://blog.csdn.net/langkew/article/details/51553549][https_blog.csdn.net_langkew_article_details_51553549]

[http_localhost_8087_api_v1.0_log]: http://localhost:8087/api/v1.0/log
[https_docs.python.org_2_library_logging.html]: https://docs.python.org/2/library/logging.html
[https_blog.csdn.net_langkew_article_details_51553549]: https://blog.csdn.net/langkew/article/details/51553549