用Python的logging库记录日志

Python的logging模块提供了一种灵活可配置的日志记录系统，可用于监测程序运行时的信息，方便开发者进行故障排查和性能优化。

下面的代码利用 basicConfig() 配置了一个简单的日志记录器，通过logging库记录程序运行日志，其中，logging库包含了五种日志级别，并按照一定格式 format 将日志信息保存到指定文件中 example.log，我们逐一展开介绍日志的这些内容。

# 配置日志记录器
logging.basicConfig(filename='example.log', 
                    level=logging.INFO,
                    format='%(asctime)s [%(levelname)s]: %(message)s')

# 记录不同级别的日志
logging.debug('This is a debug message')
logging.info('This is an info message')
logging.warning('This is a warning message')
logging.error('This is an error message')
logging.critical('This is a critical message')

---

---

基于basicConfig()配置日志记录器

logging 库允许通过配置文件或编程方式配置日志记录系统，以适应不同的应用场景，日志记录器可以通过 logging.basicConfig()进行简单配置，这里仅介绍部分基础的配置参数（如下所示），更多的配置参数及功能可以自行探索。

部分常用参数

filename: StrPath

如果没有指定该参数，则记录器默认会将日志输出打印到控制台。

当指定了该参数后，会将日志保存到相应路径的文件内，并可以通过filemode: str指定文件打开模式，若无指定模式，则默认为追加模式 a（有同名文件则追加新日志，无则新建）。

format: str

指定日志消息的字符串格式。

例如上面的代码例子：format='%(asctime)s [%(levelname)s]: %(message)s'，其中 '%(asctime)s' 表示日志记录的时间，%()s表示将asctime插入到括号中并格式化为字符串，'%(levelname)s' 表示日志级别，'%(message)s' 表示日志消息的内容，具体的字符串格式可以根据需求进行定制。

level: _Level

指定一个日志级别，只有达到该级别或更高级别的日志消息才会被记录，以此来控制日志的详细程度。

例如：设置了 level=logging.WARNING，则只会记录 WARNING、ERROR、CRITICAL级别的日志，而忽略 DEBUG、INFO 级别的日志。

stream: SupportsWrite[str]

将日志消息输出到流，该参数与 filename 参数相冲突，若同时设置了两个相冲突的参数，则 stream 参数自动被忽略。

记录不同级别的日志

logging 模块定义了五种日志级别，包括 DEBUG、INFO、WARNING、ERROR 和 CRITICAL。日志级别用于指示日志消息的严重程度，在配置日志记录器时，可以有选择地控制输出的详细程度。

不同日志级别的差异：

1. DEBUG：调试信息，用在开发和调试阶段追踪代码执行过程中的详细信息，不应该在生产环境中使用；
2. INFO：程序正常运行时的信息，用于生产环境中输出一般性的运行时信息，以判断程序是否按预期进行工作；
3. WARNING：潜在的问题或不太常见的情况信息；
4. ERROR：程序中发生的错误，但不一定导致程序终止；
5. CRITICAL：程序中比较严重的错误信息，通常会终止程序。

如上面的代码例子所示，通过调用 logging.debug、logging.info、logging.warning、logging.error、logging.critical 可以记录不同级别的日志消息。这些消息将根据记录器的配置被写入到文件 ‘example.log’ 中。

通过添加Handler配置日志记录器

上述通过 basicConfig() 配置日志记录器的方式虽然简单，但是灵活性较差，相当于是底层的 Handler 的配置都被封装起来了，没法做到更细化地配置。这里举例介绍创建多 Handler 的方法。

实例化记录器

Logger 对象是 logging 库中最重要的组件之一。通过创建 Logger 实例，你可以在应用程序中的不同部分记录日志。每个 Logger 都有一个名称，以便识别不同的日志记录源。

import logging

logger = logging.getLogger('example_logger')

定义日志处理器

Handler 处理器可以理解为，生成的日志信息的输出方式。一个记录器可以携带多个Handler，此时若该记录器生成日志记录，则日志消息会交给多个Handler进行处理并分发到不同的目标，例如文件、控制台、网络等。

例如，这里创建了 FileHandler 和 StreamHandler，并将这两个 Handler 添加到记录器当中。

file_handler = logging.FileHandler('example.log')
logger.addHandler(file_handler)

console_handler = logging.StreamHandler()
logger.addHandler(console_handler)

其中，FileHandler() 传入的参数指明了日志消息保存到的文件，StreamHandler 指明将日志消息输出到控制台。

定义格式化器

Formatter 格式化器能够定义日志消息的输出格式，通过设置不同的格式，可以自定义日志消息、日志生成时间的的显示、保存方式。

fmt = "%(name)s %(asctime)-15s %(levelname)s %(filename)s %(lineno)d %(message)s"
datefmt = "%Y %H:%M:%S"
formatter = logging.Formatter(fmt, datefmt)

file_handler.setFormatter(formatter)
console_handler.setFormatter(formatter)

其中，name 是记录器的名字，asctime 是生成日志信息的时间，levelname 是日志信息的级别，filename 是运行的程序名，lineno 是生成日志消息的代码行数，message 是生成的日志信息。

定义输出的详细程度（级别）

如上面的例子，当我们需要控制输出日志信息的详细程度时，可以通过定义 Level 参数来控制，当控制输出控制台的信息只包含大于等于 info 级别的，可以如下操作：

logger.setLevel(logging.INFO)

若是要定义生成日志文件记录日志的详细程度，可以如下操作：

file_handler.setLevel(logging.ERROR)

完整代码演示

这里定义了一个名为 example_logger 的记录器，并将生成的日志消息传给 file_handler 和 console_handler 输出到文件及控制台，并定义了输出到这两个路径的日志消息的格式以及详细程度。

import logging


logger = logging.getLogger('example_logger')
logger.setLevel(logging.INFO)

fmt = "%(name)s %(asctime)-15s %(levelname)s %(filename)s %(lineno)d %(message)s"
datefmt = "%Y %H:%M:%S"
formatter = logging.Formatter(fmt, datefmt)


file_handler = logging.FileHandler('example.log')
file_handler.setFormatter(formatter)
file_handler.setLevel(logging.ERROR)
logger.addHandler(file_handler)


console_handler = logging.StreamHandler()
console_handler.setFormatter(formatter)
logger.addHandler(console_handler)


## 生成日志消息
logger.debug('debug message')
logger.info('info message')
logger.warning('warn message')
logger.error('error message')
logger.critical('critical message')

控制台输出内容：

example_logger 2024 19:40:15   INFO test_lins.py 25 info message
example_logger 2024 19:40:15   WARNING test_lins.py 26 warn message
example_logger 2024 19:40:15   ERROR test_lins.py 27 error message 
example_logger 2024 19:40:15   CRITICAL test_lins.py 28 critical message

日志文件输出内容：

example_logger 2024 19:40:15   ERROR test_lins.py 27 error message
example_logger 2024 19:40:15   CRITICAL test_lins.py 28 critical message