python笔记-logging日志
一、日志基本概述
日志是跟踪软件运行时所发生的事件的一种方法。软件开发者在代码中调用日志函数，表明发生了特定的事件。事件由描述性消息描述，该描述性消息可以可选地包含可变数据。事件还具有开发者归因于事件的重要性，重要性也可以称为级别或严重性。
logging提供了一组便利的函数，用来做简单的日志。它们是debug()、info()、warning()、error()和critical()。
1、什么是日志
日志就是用于记录系统运行时的信息，对一个事件的记录，也称为log。
2、日志的用途
日志的基本用途如下：
- 记录程序运行过程中的错误，方便跟踪定位问题，减少调试和维护成本
- 通过日志能还原整个程序的执行过程，能了解程序的整体状态
- 对用户行为分析和数据统计，知晓信息来自于哪个模块
- 在设计测试框架的时候，也可以通过设计日志来记录框架的整个测试流程
3、日志的级别
常见的日志等级如下：
- DEBUG：调试级别，打印非常详细的日志信息，通常仅在Debug时使用，如算法中每个循环的中间状态
- INFO：信息级别，打印一般的日志信息，突出强调程序的运行过程，主要用于处理请求或者状态变化等日常事务
- WARNING：警告级别，打印警告日志信息，表明会出现潜在错误的情形，如某些预期之外的情况发生或者在将来可能发生什么，此情况一般不会影响软件的正常实用，如用户登录密码错误
- ERROR：错误级别，打印错误异常信息，该级别的错误可能会导致系统的一些功能无法正常使用，如IO操作失败或者连接问题
- CRITICAL：严重错误，一个严重的错误，导致系统可能无法继续运行，如内存耗尽、磁盘空间为空，一般很少使用
二、logging模块简介
几乎所有开发语言都会内置日志相关功能，或者会有比较优秀的第三方库来提供日志操作功能，比如：log4j，log4php等。它们功能强大、使用简单。Python自身也提供了一个用于记录日志的标准库模块——logging。
1、logging模块介绍
logging模块是python内置的标准模块，主要用于输出运行日志，可以设置输出日志的等级、日志保存路径、日志文件回滚等。
2、logging模块的日志级别
logging模块默认定义了以下几个日志等级，它允许开发人员自定义其他日志级别，但是这是不被推荐的，尤其是在开发供别人使用的库时，因为这会导致日志级别的混乱。
| 日志等级（level） | 描述 |
| DEBUG | 最详细的日志信息，典型应用场景是 问题诊断 |
| INFO | 信息详细程度仅次于DEBUG，通常只记录关键节点信息，用于确认一切都是按照我们预期的那样进行工作 |
| WARNING | 当某些不期望的事情发生时记录的信息（如，磁盘可用空间较低），但是此时应用程序还是正常运行的 |
| ERROR | 由于一个更严重的问题导致某些功能不能正常运行时记录的信息 |
| CRITICAL | 当发生严重错误，导致应用程序不能继续运行时记录的信息 |
说明：
- 开发应用程序或部署开发环境时，可以使用DEBUG或INFO级别的日志获取尽可能详细的日志信息来进行开发或部署调试；应用上线或部署生产环境时，应该使用WARNING或ERROR或CRITICAL级别的日志来降低机器的I/O压力和提高获取错误日志信息的效率。日志级别的指定通常都是在应用程序的配置文件中进行指定的；
- 面列表中的日志等级是从上到下依次升高的，即：DEBUG < INFO < WARNING < ERROR < CRITICAL，而日志的信息量是依次减少的；
- 当为某个应用程序指定一个日志级别后，应用程序会记录所有日志级别大于或等于指定日志级别的日志信息，而不是仅仅记录指定级别的日志信息。
3、logging模块的使用方式
logging模块提供了两种记录日志的方式：
- 第一种方式是使用logging提供的模块级别的函数
- 第二种方式是使用logging日志系统的四大组件
其实，logging所提供的模块级别的日志记录函数也是对logging日志系统相关类的封装而已。
logging模块定义的模块级别的常用函数：
| 函数 |
说明 |
| logging.debug(msg, *args, **kwargs) | 创建一条严重级别为DEBUG的日志记录 |
| logging.info(msg, *args, **kwargs) | 创建一条严重级别为INFO的日志记录 |
| logging.warning(msg, *args, **kwargs) | 创建一条严重级别为WARNING的日志记录 |
| logging.error(msg, *args, **kwargs) | 创建一条严重级别为ERROR的日志记录 |
| logging.critical(msg, *args, **kwargs) | 创建一条严重级别为CRITICAL的日志记录 |
| logging.log(level, *args, **kwargs) | 创建一条严重级别为level的日志记录 |
| logging.basicConfig(**kwargs) | 对root logger进行一次性配置 |
其中，logging.basciConfig(**kwargs)函数用于指定“要记录的日志级别”、‘日志格式’、“日志输出位置”、“日志文件的打开模块”等信息，其它几个都是用于记录各个级别日志的函数。
logging模块的四大组件：
| 组件 | 说明 |
| loggers | 提供应用程序代码直接使用的接口 |
| handlers | 用于将日志记录发送到指定的目的位置 |
| filters | 提供更细粒度的日志过滤功能，用于决定哪些日志记录将会被输出（其它的日志记录将会被忽略） |
| formatters | 用于控制日志信息的最终输出格式 |
说明： logging模块提供的模块级别的那些函数实际上也是通过这几个组件的相关实现类来记录日志的，只是在创建这些类的实例时设置了一些默认值
三、使用logging提供的模块级别的函数记录日志
1、最简单的日志输出
先来试着分别输出一条不同日志级别的日志记录：
import logging logging.debug('This is a debug log') logging.info('This is a info log') logging.warning('This is a warning log') logging.error('This is a error log') logging.critical('This is a critical log')
也可以这样写：
import logging logging.log(logging.DEBUG, 'This is a debug log') logging.log(logging.INFO, 'This is a info log') logging.log(logging.WARNING, 'This is a warning log') logging.log(logging.ERROR, 'This is a error log') logging.log(logging.CRITICAL, 'This is a critical log')
输出结果：
WARNING:root:This is a warning log ERROR:root:This is a error log CRITICAL:root:This is a critical log
2、发现问题
问题1：为什么前面两条日志没有被打印出来？
这是因为logging模块提供的日志记录函数所使用的日志器设置的日志级别是WARNING，因此只有WARNING级别的日志记录以及大于它的ERROR和CRITICAL级别的日志记录被输出了，而小于它的DEBUG和INFO级别的日志记录被丢弃了。
问题2：打印出来的日志信息中各字段表示什么意思？为什么会这样输出？
上面输出结果中每行日志记录的各个字段含义分别是：日志级别：日志器名称：日志内容；
之所以会这样输出，是因为logging模块提供的日志记录函数所使用的日志器设置的日志格式默认是BASIC_FORMAT，其值为："%(levelname)s:%(name)s:%(message)s"。
问题3：如何将日志记录输出到文件中，而不是打印到控制台？
因为logging模块提供的日志记录函数所使用的日志器设置的处理器所指定的日志输出位置默认是：sys.stderr。
问题4：如何知道这些？
查看这些日志记录函数的实现代码，可以发现：当我们没有提供任何配置信息的时候，这些函数都会去调用logging.basicConfig(**kwargs)方法，且不会向该方法传递任何参数。继续查看basicConfig()方法的代码就可以找到上面这些问题的答案了。
问题5：怎么修改这些默认设置呢？
其实很简单，在我们调用上面这些日志记录函数之前，手动调用一下basicConfig()方法，把我们想设置的内容以参数的形式传递进去就可以了。
3、logging.basicConfig()函数说明
该方法用于为logging日志系统做一些基本配置，方法定义如下：
logging.basicConfig(**kwargs)
该函数可接收的关键字参数如下：
| 参数名称 | 描述 |
| filename | 指定日志输出目标文件的文件名，指定该设置项后日志信息就不会被输出到控制台了 |
| filemode | 指定日志文件的打开模式，默认为'a'。需要注意的是，该选项要在filename指定时才有效 |
| format | 指定日志格式字符串，即指定日志输出时所包含的字段信息以及它们的顺序。logging模块定义的格式字段下面会列出 |
| datefmt | 指定日期/时间格式。需要注意的是，该选项要在format中包含时间字段%(asctime)s时才有效 |
| level | 指定日志器的日志级别 |
| stream | 指定日志输出目标stream，如sys.stdout、sys.stderr以及网络stream。需要说明的是，stream和filename不能同时提供，否则会引发 ValueError异常 |
| style | Python 3.2中新添加的配置项。指定format格式字符串的风格，可取值为'%'、'{'和'$'，默认为'%' |
| handlers | Python 3.3中新添加的配置项。该选项如果被指定，它应该是一个创建了多个Handler的可迭代对象，这些handler将会被添加到root logger。需要说明的是：filename、stream和handlers这三个配置项只能有一个存在，不能同时出现2个或3个，否则会引发ValueError异常。 |
4、logging模块定义的格式字符串字段
列举一下logging模块中定义好的可以用于format格式字符串中字段有哪些：
| 字段/属性名称 | 使用格式 | 描述 |
| asctime | %(asctime)s | 日志事件发生的时间--人类可读时间，如：2003-07-08 16:49:45,896 |
| created | %(created)f | 日志事件发生的时间--时间戳，就是当时调用time.time()函数返回的值 |
| relativeCreated | %(relativeCreated)d | 日志事件发生的时间相对于logging模块加载时间的相对毫秒数（目前还不知道干嘛用的） |
| msecs | %(msecs)d | 日志事件发生事件的毫秒部分 |
| levelname | %(levelname)s | 该日志记录的文字形式的日志级别（'DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'） |
| levelno | %(levelno)s | 该日志记录的数字形式的日志级别（10, 20, 30, 40, 50） |
| name | %(name)s | 所使用的日志器名称，默认是'root'，因为默认使用的是 rootLogger |
| message | %(message)s | 日志记录的文本内容，通过 msg % args计算得到的 |
| pathname | %(pathname)s | 调用日志记录函数的源码文件的全路径 |
| filename | %(filename)s | pathname的文件名部分，包含文件后缀 |
| module | %(module)s | filename的名称部分，不包含后缀 |
| lineno | %(lineno)d | 调用日志记录函数的源代码所在的行号 |
| funcName | %(funcName)s | 调用日志记录函数的函数名 |
| process | %(process)d | 进程ID |
| processName | %(processName)s | 进程名称，Python 3.1新增 |
| thread | %(thread)d | 线程ID |
| threadName | %(thread)s | 线程名称 |
5、经过配置的日志输出
先简单配置下日志器的日志级别：
import logging logging.basicConfig(level=logging.ERROR) logging.debug('This is a debug log') logging.info('This is a info log') logging.warning('This is a warning log') logging.error('This is a error log') logging.critical('This is a critical log')
输出结果：
ERROR:root:This is a error log CRITICAL:root:This is a critical log
只有ERROR及以上级别的日志输出，说明配置生效了。
在配置日志器日志级别的基础上，在配置下日志输出目标文件和日志格式
import logging LOG_FORMAT = '%(asctime)s - %(levelname)s - %(meaasge)s' logging.basicConfig(filename='mylog.log', level=logging.ERROR, format=LOG_FORMAT) logging.debug('This is a debug log') logging.info('This is a info log') logging.warning('This is a warning log') logging.error('This is a error log') logging.critical('This is a critical log')
此时会发现，控制台已经没有输出日志内容了，但是在python代码文件的相同目录下会生成一个名为'mylog.log'的日志文件，该文件中的内容为：
2021-11-04 18:07:06,355 - ERROR - This is a error log 2021-11-04 18:07:06,355 - CRITICAL - This is a critical log
在上面的基础上，我们再来设置下日期/时间格式：
import logging import time LOG_FORMAT = '%(asctime)s - %(levelname)s - %(message)s' LOG_DATE = time.strftime("%Y-%m-%d %H:%M:%S", time.localtime()) logging.basicConfig(filename='mylog.log', level=logging.ERROR, format=LOG_FORMAT, datefmt=LOG_DATE) logging.debug('This is a debug log') logging.info('This is a info log') logging.warning('This is a warning log') logging.error('This is a error log') logging.critical('This is a critical log')
此时会在mylog.log日志文件中看到以下输出内容：
2021-11-04 18:09:15 - ERROR - This is a error log 2021-11-04 18:09:15 - CRITICAL - This is a critical log
6、其它说明
几个要说明的内容：
logging.basicConfig()函数是一个一次性的简单配置工具使，也就是说只有在第一次调用该函数时会起作用，后续再次调用该函数时完全不会产生任何操作的，多次调用的设置并不是累加操作；- 日志器（Logger）是有层级关系的，上面调用的logging模块级别的函数所使用的日志器是
RootLogger类的实例，其名称为'root'，它是处于日志器层级关系最顶层的日志器，且该实例是以单例模式存在的； - 如果要记录的日志中包含变量数据，可使用一个格式字符串作为这个事件的描述消息（logging.debug、logging.info等函数的第一个参数），然后将变量数据作为第二个参数*args的值进行传递，如:
logging.warning('%s is %d years old.', 'Tom', 10)，输出内容为WARNING:root:Tom is 10 years old - logging.debug(), logging.info()等方法的定义中，除了msg和args参数外，还有一个**kwargs参数。它们支持3个关键字参数:
exc_info, stack_info, extra，下面对这几个关键字参数作个说明。
关于exc_info、stack_info、extra关键词参数的说明：
- exc_info：其值为布尔值，如果该参数的值设置为True，则会将异常异常信息添加到日志消息中。如果没有异常信息则添加None到日志信息中
- stack_info：其值也为布尔值，默认值为False。如果该参数的值设置为True，栈信息将会被添加到日志信息中
- extra：这是一个字典（dict）参数，它可以用来自定义消息格式中所包含的字段，但是它的key不能与logging模块定义的字段冲突
一个例子：在在日志消息中添加exc_info和stack_info信息，并添加两个自定义的字端 ip和user：
LOG_FORMAT = "%(asctime)s - %(levelname)s - %(user)s[%(ip)s] - %(message)s" DATE_FORMAT = "%m/%d/%Y %H:%M:%S %p" logging.basicConfig(format=LOG_FORMAT, datefmt=DATE_FORMAT) logging.warning("Some one delete the log file.", exc_info=True, stack_info=True, extra={'user': 'Tom', 'ip':'47.98.53.222'})
输出结果：
05/08/2017 16:35:00 PM - WARNING - Tom[47.98.53.222] - Some one delete the log file. NoneType Stack (most recent call last): File "C:/Users/wader/PycharmProjects/LearnPython/day06/log.py", line 45, in <module> logging.warning("Some one delete the log file.", exc_info=True, stack_info=True, extra={'user': 'Tom', 'ip':'47.98.53.222'})
四、logging模块日志流处理流程
1、logging日志模块四大组件
| 组件名称 | 对应类名 | 功能描述 |
| 日志器 | Logger | 提供了应用程序可一直使用的接口 |
| 处理器 | Handler | 将logger创建的日志记录发送到合适的目的输出 |
| 过滤器 | Filter | 提供了更细粒度的控制工具来决定输出哪条日志记录，丢弃哪条日志记录 |
| 格式器 | Formatter | 决定日志记录的最终输出格式 |
logging模块就是通过这些组件来完成日志处理的，上面所使用的logging模块级别的函数也是通过这些组件对应的类来实现的。
这些组件之间的关系描述：
- 日志器（logger）需要通过处理器（handler）将日志信息输出到目标位置，如：文件、sys.stdout、网络等；
- 不同的处理器（handler）可以将日志输出到不同的位置；
- 日志器（logger）可以设置多个处理器（handler）将一条日志记录输出到不同的位置；
- 每个处理器（handler）都可以设置自己的过滤器（filter）实现日志过滤，从而只保留感兴趣的日志；
- 每个处理器（handler）都可以设置自己的格式器（formatter）实现同一条日志以不同的格式输出到不同的地方。
简单点说就是：日志器（logger）是入口，真正干活儿的是处理器（handler），处理器（handler）还可以通过过滤器（filter）和格式器（formatter）对要输出的日志内容做过滤和格式化等处理操作。
2、logging日志模块相关类及常用方法介绍
下面介绍下与logging四大组件相关的类：Logger, Handler, Filter, Formatter。
①logger类
Logger对象有3个任务要做：
- 向应用程序代码暴露几个方法，使应用程序可以在运行时记录日志消息；
- 基于日志严重等级（默认的过滤设施）或filter对象来决定要对哪些日志进行后续处理；
- 将日志消息传送给所有感兴趣的日志handlers。
Logger对象最常用的方法分为两类：配置方法 和 消息发送方法。
最常用的配置方法如下：
| 方法 | 描述 |
| Logger.setLevel() | 设置日志器将会处理的日志消息的最低严重级别 |
| Logger.addHandler() 和 Logger.removeHandler() | 为该logger对象添加 和 移除一个handler对象 |
| Logger.addFilter() 和 Logger.removeFilter() | 为该logger对象添加 和 移除一个filter对象 |
logger对象配置完成后，可以使用下面的方法来创建日志记录：
| 方法 | 描述 |
| Logger.debug(), Logger.info(), Logger.warning(), Logger.error(), Logger.critical() | 创建一个与它们的方法名对应等级的日志记录 |
| Logger.exception() | 创建一个类似于Logger.error()的日志消息 |
| Logger.log() | 需要获取一个明确的日志level参数来创建一个日志记录 |
说明：
- Logger.exception()与Logger.error()的区别在于：Logger.exception()将会输出堆栈追踪信息，另外通常只是在一个exception handler中调用该方法；
- Logger.log()与Logger.debug()、Logger.info()等方法相比，虽然需要多传一个level参数，显得不是那么方便，但是当需要记录自定义level的日志时还是需要该方法来完成。
那么，怎样得到一个Logger对象呢？
一种方式是通过Logger类的实例化方法创建一个Logger类的实例，但是我们通常都是用第二种方式--logging.getLogger()方法。
logging.getLogger()方法有一个可选参数name，该参数表示将要返回的日志器的名称标识，如果不提供该参数，则其值为'root'。若以相同的name参数值多次调用getLogger()方法，将会返回指向同一个logger对象的引用。
关于logger的层级结构与有效等级的说明：
- logger的名称是一个以'.'分割的层级结构，每个'.'后面的logger都是'.'前面的logger的children，例如，有一个名称为 foo 的logger，其它名称分别为 foo.bar, foo.bar.baz 和 foo.bam都是 foo 的后代；
- logger有一个"有效等级（effective level）"的概念。如果一个logger上没有被明确设置一个level，那么该logger就是使用它parent的level;如果它的parent也没有明确设置level则继续向上查找parent的parent的有效level，依次类推，直到找到个一个明确设置了level的祖先为止。需要说明的是，root logger总是会有一个明确的level设置（默认为 WARNING）。当决定是否去处理一个已发生的事件时，logger的有效等级将会被用来决定是否将该事件传递给该logger的handlers进行处理；
- child loggers在完成对日志消息的处理后，默认会将日志消息传递给与它们的祖先loggers相关的handlers。因此，我们不必为一个应用程序中所使用的所有loggers定义和配置handlers，只需要为一个顶层的logger配置handlers，然后按照需要创建child loggers就可足够了。我们也可以通过将一个logger的propagate属性设置为False来关闭这种传递机制。
②Handler类
Handler对象的作用是（基于日志消息的level）将消息分发到handler指定的位置（文件、网络、邮件等）。Logger对象可以通过addHandler()方法为自己添加0个或者更多个handler对象。比如，一个应用程序可能想要实现以下几个日志需求：
1>把所有日志都发送到一个日志文件中；
2>把所有严重级别大于等于error的日志发送到stdout（标准输出）；
3>把所有严重级别为critical的日志发送到一个email邮件地址。
这种场景就需要3个不同的handlers，每个handler负责发送一个特定严重级别的日志到一个特定的位置。
一个handler中只有非常少数的方法是需要应用开发人员去关心的。对于使用内建handler对象的应用开发人员来说，似乎唯一相关的handler方法就是下面这几个配置方法：
记录器的级别决定了消息是否要传递给处理器。每个处理器的级别决定了消息是否要分发。
| 方法 | 描述 |
| Handler.setLevel() | 设置handler将会处理的日志消息的最低严重级别 |
| Handler.setFormatter() | 为handler设置一个格式器对象 |
| Handler.addFilter() 和 Handler.removeFilter() | 为handler添加 和 删除一个过滤器对象 |
需要说明的是，应用程序代码不应该直接实例化和使用Handler实例。因为Handler是一个基类，它只定义了所有handlers都应该有的接口，同时提供了一些子类可以直接使用或覆盖的默认行为。下面是一些常用的Handler：
| Handler | 描述 |
| logging.StreamHandler | 将日志消息发送到输出到Stream，如std.out, std.err或任何file-like对象。 |
| logging.FileHandler | 将日志消息发送到磁盘文件，默认情况下文件大小会无限增长 |
| logging.handlers.RotatingFileHandler | 将日志消息发送到磁盘文件，并支持日志文件按大小切割 |
| logging.hanlders.TimedRotatingFileHandler | 将日志消息发送到磁盘文件，并支持日志文件按时间切割 |
| logging.handlers.HTTPHandler | 将日志消息以GET或POST的方式发送给一个HTTP服务器 |
| logging.handlers.SMTPHandler | 将日志消息发送给一个指定的email地址 |
| logging.NullHandler | 该Handler实例会忽略error messages，通常被想使用logging的library开发者使用来避免'No handlers could be found for logger XXX'信息的出现 |
1> logging.StreamHandler-------->控制台输出
使用这个Handler可以向类似与sys.stdout或者sys.stderr的任何文件对象(file object)输出信息
它的构造函数是：
StreamHandler([strm])
其中strm参数是一个文件对象。默认是sys.stderr
2> logging.FileHandler-------->文件输出
和StreamHandler类似，用于向一个文件输出日志信息。不过FileHandler会帮你打开这个文件。它的构造函数是：
FileHandler(filename[,mode])
filename是文件名，必须指定一个文件名。
mode是文件的打开方式。默认是’a'，即添加到文件末尾。
3>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并不会被更名，而是被删除。
4>logging.handlers.TimedRotatingFileHandler------>按照时间自动分隔日志文件
这个Handler和RotatingFileHandler类似，不过，它没有通过判断文件大小来决定何时重新创建日志文件，而是间隔一定时间就 自动创建新的日志文件。重命名的过程与RotatingFileHandler类似，不过新的文件不是附加数字，而是当前时间。
TimedRotatingFileHandler的构造函数定义如下：
TimedRotatingFileHandler(filename [,when [,interval [,backupCount]]])
- filename：输出日志文件名的前缀，比如说 testServiceLog 这样的就是日志文件名前缀
- when是一个字符串的定义，表示时间间隔的单位，它有以下取值：
- "S"：Seconds，秒
- “M”：Minutes，分
- “H”：Hours，小时
- "D"：Days，天
- “W”：Week day(0=Monday)，每星期，等于0代表星期一
- “midnight”：每天凌晨
- interval：间隔时间单位的个数，指等待多少个 when 的时间后 Logger 会自动重建新闻继续进行日志记录。这里需要注意的一点是，如果创建的文件和已有文件存在重名的情况，则会对历史的文件进行覆盖操作，所以使用好 suffix 避免文件名称重复。
- backupCount：保留日志个数。默认的0是不会自动删除掉日志。如果设置为 N（正整数），则会在创建新的日志文件时会检查日志文件个数是否到达 N，达到了的话就会从最先创建的开始删除，从而达到维持日志文件个数为 N 个的目标。
③Formater类
Formater对象用于配置日志信息的最终顺序、结构和内容。与logging.Handler基类不同的是，应用代码可以直接实例化Formatter类。另外，如果你的应用程序需要一些特殊的处理行为，也可以实现一个Formatter的子类来完成。
Formatter类的构造方法定义如下：
logging.Formatter.__init__(fmt=None, datefmt=None, style='%')
可见，该构造方法接收3个可选参数：
- fmt：指定消息格式化字符串，如果不指定该参数则默认使用message的原始值；
- datefmt：指定日期格式字符串，如果不指定该参数则默认使用"%Y-%m-%d %H:%M:%S"；
- style：Python 3.2新增的参数，可取值为 '%', '{'和 '$'，如果不指定该参数则默认使用'%'。
③Filter类
Filter可以被Handler和Logger用来做比level更细粒度的、更复杂的过滤功能。Filter是一个过滤器基类，它只允许某个logger层级下的日志事件通过过滤。该类定义如下：
class logging.Filter(name='') filter(record)
比如，一个filter实例化时传递的name参数值为'A.B'，那么该filter实例将只允许名称为类似如下规则的loggers产生的日志记录通过过滤：'A.B'，'A.B,C'，'A.B.C.D'，'A.B.D'，而名称为'A.BB', 'B.A.B'的loggers产生的日志则会被过滤掉。如果name的值为空字符串，则允许所有的日志事件通过过滤。
比如，一个filter实例化时传递的name参数值为'A.B'，那么该filter实例将只允许名称为类似如下规则的loggers产生的日志记录通过过滤：'A.B'，'A.B,C'，'A.B.C.D'，'A.B.D'，而名称为'A.BB', 'B.A.B'的loggers产生的日志则会被过滤掉。如果name的值为空字符串，则允许所有的日志事件通过过滤。
说明：
- 如果有需要，也可以在filter(record)方法内部改变该record，比如添加、删除或修改一些属性
- 我们还可以通过filter做一些统计工作，比如可以计算下被一个特殊的logger或handler所处理的record数量等
3、logging日志流处理流程
下面这个图描述了日志流的处理流程：
我们来描述下上面这个图的日志流处理流程：
1>（在用户代码中进行）日志记录函数调用，如：logger.info(...)，logger.debug(...)等；
2>判断要记录的日志级别是否满足日志器设置的级别要求（要记录的日志级别要大于或等于日志器设置的级别才算满足要求），如果不满足则该日志记录会被丢弃并终止后续的操作，如果满足则继续下一步操作
3>根据日志记录函数调用时掺入的参数，创建一个日志记录（LogRecord类）对象
4>判断日志记录器上设置的过滤器是否拒绝这条日志记录，如果日志记录器上的某个过滤器拒绝，则该日志记录会被丢弃并终止后续的操作，如果日志记录器上设置的过滤器不拒绝这条日志记录或者日志记录器上没有设置过滤器则继续下一步操作--将日志记录分别交给该日志器上添加的各个处理器
5>判断要记录的日志级别是否满足处理器设置的级别要求（要记录的日志级别要大于或等于该处理器设置的日志级别才算满足要求），如果不满足记录将会被该处理器丢弃并终止后续的操作，如果满足则继续下一步操作
6>判断该处理器上设置的过滤器是否拒绝这条日志记录，如果该处理器上的某个过滤器拒绝，则该日志记录会被当前处理器丢弃并终止后续的操作，如果当前处理器上设置的过滤器不拒绝这条日志记录或当前处理器上没有设置过滤器测继续下一步操作
7>如果能到这一步，说明这条日志记录经过了层层关卡允许被输出了，此时当前处理器会根据自身被设置的格式器（如果没有设置则使用默认格式）将这条日志记录进行格式化，最后将格式化后的结果输出到指定位置（文件、网络、类文件的Stream等）
8>如果日志器被设置了多个处理器的话，上面的第5-8步会执行多次
9>这里才是完整流程的最后一步：判断该日志器输出的日志消息是否需要传递给上一级logger（之前提到过，日志器是有层级关系的）的处理器，如果propagate属性值为1则表示日志消息将会被输出到处理器指定的位置，同时还会被传递给parent日志器的handlers进行处理直到当前日志器的propagate属性为0停止，如果propagate值为0则表示不向parent日志器的handlers传递该消息，到此结束
可见，一条日志信息要想被最终输出需要依次经过以下几次过滤：
- 日志器等级过滤
- 日志器的过滤器过滤
- 日志器的处理器等级过滤
- 日志器的处理器的过滤器过滤
说明的是： 关于上面第9个步骤，如果propagate值为1，那么日志消息会直接传递交给上一级logger的handlers进行处理，此时上一级logger的日志等级并不会对该日志消息进行等级过滤。
五、使用logging四大组件记录日志
现在，我们对logging模块的重要组件及整个日志流处理流程都应该有了一个比较全面的了解，下面我们来看一个例子。
1、需求
现在有以下几个日志记录的需求：
1>要求将所有级别的所有日志都写入磁盘文件中；
2>all.log文件中记录所有的日志信息，日志格式为：日期和时间 - 日志级别 - 日志信息；
3>error.log文件中单独记录error及以上级别的日志信息，日志格式为：日期和时间 - 日志级别 - 文件名[:行号] - 日志信息；
4>要求all.log在每天凌晨进行日志切割。
2、分析
1>要记录所有级别的日志，因此日志器的有效level需要设置为最低级别--DEBUG;
2>日志需要被发送到两个不同的目的地，因此需要为日志器设置两个handler；另外，两个目的地都是磁盘文件，因此这两个handler都是与FileHandler相关的；
3>all.log要求按照时间进行日志切割，因此他需要用logging.handlers.TimedRotatingFileHandler; 而error.log没有要求日志切割，因此可以使用FileHandler;
4>两个日志文件的格式不同，因此需要对这两个handler分别设置格式器。
3、代码实现
import logging import logging.handlers l_g = logging.getLogger() # 获取logger对象 l_g.setLevel(logging.DEBUG) # 用logger对象调用setLevel设置日志器会处理的日志消息的最低严重级别 rf_handler = logging.handlers.TimedRotatingFileHandler('../logs/all.log', when='midnight', interval=1, backupCount=7) # 将日志消息发送到磁盘文件，并支持日志文件按时间切割(all.log在每天凌晨进行日志切割) rf_handler.setFormatter(logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')) # 设置日志格式 f_handler = logging.FileHandler('../logs/error.log') # 建立一个FileHandler来把日志记录在文件里，级别为ERROR及以上 f_handler.setLevel(logging.ERROR) f_handler.setFormatter(logging.Formatter('%(asctime)s - %(levelname)s - %(filename)s[:%(lineno)d] - %(message)s')) # 设置日志格式 # 将相应的handler添加在logger对象中 l_g.addHandler(rf_handler) l_g.addHandler(f_handler) # 开始打印日志 l_g.debug("This is a debug log.") l_g.info("This is a info log.") l_g.warning("This is a warning log.") l_g.error("This is a error log.") l_g.critical("This is a critical log.")
all.log文件输出
2021-11-08 19:56:31,000 - DEBUG - This is a debug log. 2021-11-08 19:56:31,002 - INFO - This is a info log. 2021-11-08 19:56:31,002 - WARNING - This is a warning log. 2021-11-08 19:56:31,002 - ERROR - This is a error log. 2021-11-08 19:56:31,002 - CRITICAL - This is a critical log.
error.log文件输出
2021-11-08 19:56:31,002 - ERROR - test.py[:23] - This is a error log. 2021-11-08 19:56:31,002 - CRITICAL - test.py[:24] - This is a critical log.
六、配置logging的几种方式
作为开发者，我们可以通过以下3中方式来配置logging:
1>使用Python代码显式的创建loggers, handlers和formatters并分别调用它们的配置函数；
2>创建一个日志配置文件，然后使用fileConfig()函数来读取该文件的内容；
3>）创建一个包含配置信息的dict，然后把它传递个dictConfig()函数。
具体说明请参考另一篇博文：https://www.cnblogs.com/yyds/p/6885182.html
参考文档：https://www.cnblogs.com/yyds/p/6901864.html
