日志logging

清疚 2022-11-27 12:19 217阅读 0赞

## 前言 ##

日志就是用于记录系统运行时的信息，对一个事件的记录；也称为Log。

## 一、日志的作用 ##

*  调试程序
 *  了解系统程序运行的情况，是否正常
 *  系统程序运行故障分析与问题定位
 *  用来做用户行为分析和数据统计

## 二、日志级别 ##

*  日志级别：是指日志信息的优先级、重要性或者严重程度
 *  常见的日志级别

<table> 
 <thead> 
  <tr> 
   <th>日志级别</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>DEBUG</td> 
   <td>调试级别，打印非常详细的日志信息，通常用于对代码的调试</td> 
  </tr> 
  <tr> 
   <td>INFO</td> 
   <td>信息级别，打印一般的日志信息，突出强调程序的运行过程</td> 
  </tr> 
  <tr> 
   <td>WARNING</td> 
   <td>警告级别，打印警告日志信息，表明会出现潜在错误的情形，一般不影响软件的正常使用</td> 
  </tr> 
  <tr> 
   <td>ERROR</td> 
   <td>错误级别，打印错误异常信息，该级别的错误可能会导致系统的一些功能无法正常使用</td> 
  </tr> 
  <tr> 
   <td>CRITICAL</td> 
   <td>严重错误级别，一个严重的错误，这表明系统可能无法继续运行</td> 
  </tr> 
 </tbody> 
</table>

说明

1.  上面列表中的日志级别是从上到下依次升高的，即：DEBUG < INFO < WARNING < ERROR < CRITICAL；
2.  当为程序指定一个日志级别后，程序会记录所有日志级别大于或等于指定日志级别的日志信息，而不是仅仅记录指定级别的日志信息；
3.  一般建议只使用DEBUG、INFO、WARNING、ERROR这四个级别

## 三、logging 使用 ##

Python中有一个标准库模块logging可以直接记录日志

##### （一）Logging 基本使用 #####

步骤：

1.  导包 如：import logging
2.  调用相应的级别方法，如记录日志信息 logging.debug(“debug…”)

##### （二）设置级别： #####

logging中默认的日志级别为WARNING，程序中大于等于该级别的日志才能输出，小于该级别的日志不会被打印出来。

logging.basicConfig(level=logging.DEBUG)

注：

1.  默认级别为：logging.WARNING；
2.  设置级别时调用的是 logging 文件夹下面的常量，而不是调用的小写方法；
3.  在开发环境和测试环境中，可以使用DEBUG或INFO级别的日志获取详细的日志信息：在生产环境中，通常设置成WARNING或ERROR级别。

##### （三）设置日志格式 #####

1.  默认的日志的格式  
    日志级别:Logger名称:日志内容，如 WARNING:root:这是一条警告信息
2.  自定义日志格式

logging.basicConfig(format="%(levelname)s:%(name)s:%(message)s")

format参数中可能用到的格式化信息：

<table> 
 <thead> 
  <tr> 
   <th>占位符</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>%(name)s</td> 
   <td>Logger的名字</td> 
  </tr> 
  <tr> 
   <td>%(levelno)s</td> 
   <td>数字形式的日志级别</td> 
  </tr> 
  <tr> 
   <td><strong>%(levelname)s</strong></td> 
   <td><strong>文本形式的日志级别</strong></td> 
  </tr> 
  <tr> 
   <td>%(pathname)s</td> 
   <td>调用日志输出函数的模块的完整路径名，可能没有</td> 
  </tr> 
  <tr> 
   <td><strong>%(filename)s</strong></td> 
   <td><strong>调用日志输出函数的模块的文件名</strong></td> 
  </tr> 
  <tr> 
   <td>%(module)s</td> 
   <td>调用日志输出函数的模块名</td> 
  </tr> 
  <tr> 
   <td>%(funcName)s</td> 
   <td>调用日志输出函数的函数名</td> 
  </tr> 
  <tr> 
   <td><strong>%(lineno)d</strong></td> 
   <td><strong>调用日志输出函数的语句所在的代码行</strong></td> 
  </tr> 
  <tr> 
   <td>%(created)f</td> 
   <td>当前时间，用UNIX标准的表示时间的浮 点数表示</td> 
  </tr> 
  <tr> 
   <td>%(relativeCreated)d</td> 
   <td>输出日志信息时的，自Logger创建以来的毫秒数</td> 
  </tr> 
  <tr> 
   <td><strong>%(asctime)s</strong></td> 
   <td><strong>字符串形式的当前时间。默认格式是 “2003-07-08 16:49:45,896”</strong></td> 
  </tr> 
  <tr> 
   <td>%(thread)d</td> 
   <td>线程ID。可能没有</td> 
  </tr> 
  <tr> 
   <td>%(threadName)s</td> 
   <td>线程名。可能没有</td> 
  </tr> 
  <tr> 
   <td>%(process)d</td> 
   <td>进程ID。可能没有</td> 
  </tr> 
  <tr> 
   <td><strong>%(message)s</strong></td> 
   <td><strong>用户输出的消息</strong></td> 
  </tr> 
 </tbody> 
</table>

##### （四）将日志信息输出到文件中 #####

默认情况下Python的logging模块将日志打印到控制台

1.  将日志信息输出到文件中：

logging.basicConfig(filename="a.log")

1.  示例代码

import logging
    fmt = '%(asctime)s %(levelname)s [%(name)s] [%(filename)s(%(funcName)s:%(lineno)d)] - %(message)s'
    logging.basicConfig(filename="a.log", level=logging.INFO, format=fmt)
    logging.debug("调试")
    logging.info("信息")
    logging.warning("警告")
    logging.error("错误")

## 四、日志的高级用法 ##

##### （一） logging日志模块四大组件 #####

<table> 
 <thead> 
  <tr> 
   <th>组件名称</th> 
   <th>类名</th> 
   <th>功能描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>日志器</td> 
   <td>Logger</td> 
   <td>提供了程序使用日志的入口</td> 
  </tr> 
  <tr> 
   <td>处理器</td> 
   <td>Handler</td> 
   <td>将logger创建的日志记录发送到合适的目的输出</td> 
  </tr> 
  <tr> 
   <td>格式器</td> 
   <td>Formatter</td> 
   <td>决定日志记录的最终输出格式</td> 
  </tr> 
  <tr> 
   <td>过滤器</td> 
   <td>Filter</td> 
   <td>提供了更细粒度的控制工具来决定输出哪条日志记录，丢弃哪条日志记录</td> 
  </tr> 
 </tbody> 
</table>

##### （二）组件之间的关系 #####

*  日志器（logger）需要通过处理器（handler）将日志信息输出到目标位置，如：文件、sys.stdout、网络等；  
    不同的处理器（handler）可以将日志输出到不同的位置；
 *  日志器（logger）可以设置多个处理器（handler）将同一条日志记录输出到不同的位置；
 *  每个处理器（handler）都可以设置自己的格式器（formatter）实现同一条日志以不同的格式输出到不同的地  
    方。
 *  每个处理器（handler）都可以设置自己的过滤器（filter）实现日志过滤，从而只保留感兴趣的日志；

简单点说就是：日志器（logger）是入口，真正干活儿的是处理器（handler），处理器（handler）还可以通过过滤器（filter）和格式器（formatter）对要输出的日志内容做过滤和格式化等处理操作。

##### （三）Logger类 #####

1.  创建Logger对象

logger = logging.getLogger()
    logger = logging.getLogger("myLogger")

注：  
logging.getLogger()方法有一个可选参数name，该参数表示将要返回的日志器的名称标识，如果不提供该参数，则  
返回root日志器对象。 若以相同的name参数值多次调用getLogger()方法，将会返回指向同一个logger对象的引  
用。  
2. Logger常用的方法

<table> 
 <thead> 
  <tr> 
   <th>方法</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>logger.debug()</td> 
   <td>打印日志</td> 
  </tr> 
  <tr> 
   <td>logger.info()</td> 
   <td>打印日志</td> 
  </tr> 
  <tr> 
   <td>logger.warning()</td> 
   <td>打印日志</td> 
  </tr> 
  <tr> 
   <td>logger.error()</td> 
   <td>打印日志</td> 
  </tr> 
  <tr> 
   <td>logger.critical()</td> 
   <td>打印日志</td> 
  </tr> 
  <tr> 
   <td>logger.setLevel()</td> 
   <td>设置日志器将会处理的日志消息的最低严重级别</td> 
  </tr> 
  <tr> 
   <td>logger.addHandler()</td> 
   <td>为该logger对象添加一个handler对象</td> 
  </tr> 
  <tr> 
   <td>logger.addFilter()</td> 
   <td>为该logger对象添加一个filter对象</td> 
  </tr> 
 </tbody> 
</table>

##### （四）Handler类 #####

Handler对象的作用是将消息分发到handler指定的位置，比如：控制台、文件、网络、邮件等。 Logger对象可以通过addHandler()方法为自己添加多个handler对象。

1.  创建Handler对象  
    Handler是一个基类，它只定义了Handler应该有的接口。 应该使用Handler子类来创建对象。  
    logging中内置的常用的Handler包括：

<table> 
 <thead> 
  <tr> 
   <th>Handler</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>logging.StreamHandler</td> 
   <td>将日志消息发送到输出到Stream，如std.out, std.err或任何file-like对象。</td> 
  </tr> 
  <tr> 
   <td>logging.FileHandler</td> 
   <td>将日志消息发送到磁盘文件，默认情况下文件大小会无限增长</td> 
  </tr> 
  <tr> 
   <td>logging.handlers.RotatingFileHandler</td> 
   <td>将日志消息发送到磁盘文件，并支持日志文件按大小切割</td> 
  </tr> 
  <tr> 
   <td>logging.hanlders.TimedRotatingFileHandler</td> 
   <td>将日志消息发送到磁盘文件，并支持日志文件按时间切割</td> 
  </tr> 
  <tr> 
   <td>logging.handlers.HTTPHandler</td> 
   <td>将日志消息以GET或POST的方式发送给一个HTTP服务器</td> 
  </tr> 
  <tr> 
   <td>logging.handlers.SMTPHandler</td> 
   <td>将日志消息发送给一个指定的email地址</td> 
  </tr> 
 </tbody> 
</table>

1.  Handler常用的方法

<table> 
 <thead> 
  <tr> 
   <th>方法</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>handler.setLevel()</td> 
   <td>设置handler将会处理的日志消息的最低严重级别</td> 
  </tr> 
  <tr> 
   <td>handler.setFormatter()</td> 
   <td>为handler设置一个格式器对象</td> 
  </tr> 
  <tr> 
   <td>handler.addFilter()</td> 
   <td>为handler添加一个过滤器对象</td> 
  </tr> 
 </tbody> 
</table>

##### （五）Formatter类 #####

Formatter对象用于配置日志信息的格式。  
创建Handler对象

formatter = logging.Formatter(fmt=None, datefmt=None, style='%')
    """
    fmt：指定消息格式化字符串，如果不指定该参数则默认使用message的原始值
    datefmt：指定日期格式字符串，如果不指定该参数则默认使用"%Y-%m-%d %H:%M:%S"
    style：Python 3.2新增的参数，可取值为 '%', '{'和 '$'，如果不指定该参数则默认使用'%'
    """

## 五、日志封装 ##

# -*-coding:utf-8 -*-
    # Auothor:yue_luo
    # 导包
    import logging.handlers
    import os
    # 工程目录
    BASE_DIR = os.path.dirname(os.path.abspath(__file__))
    class GetLogger():
    
        logger = None
    
        @classmethod
        def get_logger(cls):
            if cls.logger is None:
                fmt = "%(asctime)s %(levelname)s [%(filename)s(%(funcName)s:%(lineno)d)] - %(message)s"
                # 创建日志器
                cls.logger = logging.getLogger()
                cls.logger.setLevel(logging.INFO)
    
                # 创建格式化器
                formatter = logging.Formatter(fmt)
    
                # 输出到控制台
                sh = logging.StreamHandler()
                sh.setFormatter(formatter)
                cls.logger.addHandler(sh)
    
                # 输出到文件，每日一个文件
                log_path = os.path.join(BASE_DIR, "../log", "tpshop.log").replace('\\','/')
                fh = logging.handlers.TimedRotatingFileHandler(log_path, when='MIDNIGHT', interval=1
                                                               , backupCount=3)
                fh.setFormatter(formatter)
                cls.logger.addHandler(fh)
            return cls.logger