Python日志配置与使用全解析

积累知识，胜过积蓄金银！毕竟在文章开发的过程中，会遇到各种各样的问题，往往都是一些细节知识点还没有掌握好而导致的，因此基础知识点的积累是很重要的。下面本文《Python 日志记录配置与使用详解》，就带大家讲解一下知识点，若是你对本文感兴趣，或者是想搞懂其中某个知识点，就请你继续往下看吧~

Python日志记录通过logging模块实现，核心组件包括Logger、Handler、Formatter和Filter。使用basicConfig可快速配置，而复杂场景可通过自定义Logger和Handler将日志输出到控制台、文件或滚动文件。相比print，logging支持级别控制（DEBUG、INFO、WARNING、ERROR、CRITICAL），可灵活配置输出目标与格式，适用于调试、监控和生产环境。通过FileHandler写入文件，RotatingFileHandler按大小滚动，TimedRotatingFileHandler按时间滚动，实现高效日志管理。

Python中的日志记录，核心在于通过logging模块建立一套结构化的信息捕获、处理和输出机制。它不仅仅是打印消息那么简单，更是一种系统性的管理，让你能够精细控制哪些信息在何时、何地、以何种形式被记录下来，这对于程序的调试、监控和后期维护至关重要。它提供了一种比print语句强大得多的方式来理解你的代码在做什么。

解决方案

要配置和使用Python的日志记录，你需要理解几个核心组件：Logger（记录器）、Handler（处理器）、Formatter（格式器）和Filter（过滤器）。

最基础的用法，可以直接通过logging.basicConfig()来快速配置，这对于简单的脚本或开发环境非常方便：

import logging

# 配置基本日志，将INFO级别及以上的消息输出到控制台
logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s')

logging.debug('这是一条调试信息') # 不会显示，因为级别低于INFO
logging.info('程序启动了')
logging.warning('检测到潜在问题')
logging.error('发生了一个错误')
logging.critical('系统崩溃！')

当你需要更复杂的控制时，比如将日志同时输出到文件和控制台，或者自定义不同的日志级别和格式，就需要手动创建和配置Logger、Handler和Formatter：

import logging

# 1. 获取一个记录器实例
logger = logging.getLogger('my_app')
logger.setLevel(logging.DEBUG) # 设置记录器最低处理级别为DEBUG

# 2. 创建一个文件处理器，用于将日志写入文件
file_handler = logging.FileHandler('app.log', encoding='utf-8')
file_handler.setLevel(logging.INFO) # 文件处理器只处理INFO及以上级别的日志

# 3. 创建一个控制台处理器，用于将日志输出到控制台
console_handler = logging.StreamHandler()
console_handler.setLevel(logging.DEBUG) # 控制台处理器处理DEBUG及以上级别的日志

# 4. 定义日志的格式
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')

# 5. 将格式器添加到处理器
file_handler.setFormatter(formatter)
console_handler.setFormatter(formatter)

# 6. 将处理器添加到记录器
logger.addHandler(file_handler)
logger.addHandler(console_handler)

# 现在可以使用logger来记录日志了
logger.debug('这条调试信息会出现在控制台')
logger.info('这条信息会出现在文件和控制台')
logger.warning('这是一个警告，也会出现在两处')

try:
    1 / 0
except ZeroDivisionError:
    logger.exception('除零错误发生！') # exception会自动记录堆栈信息

这段代码展示了如何细致地控制日志流向和内容。getLogger可以获取一个具名的记录器，这在大型应用中区分不同模块的日志非常有用。通过为不同的Handler设置不同的级别，我们可以实现日志分流，比如调试信息只在控制台显示，而重要的错误信息则同时写入文件。

为什么Python的logging模块比简单的print语句更具优势？

说实话，刚开始写Python脚本时，谁不是满屏的print()？快速、直接，看一眼就知道结果。但很快你就会发现，当程序规模稍微大一点，或者需要部署到生产环境时，print()的局限性就暴露无遗了。logging模块之所以是标准库，自有其道理。

首先，它提供了日志级别。DEBUG, INFO, WARNING, ERROR, CRITICAL，这些级别让你能够区分信息的轻重缓急。你可以设置一个全局的阈值，比如在开发时显示所有DEBUG信息，而到了生产环境，只记录INFO或WARNING及以上的内容。print()可没这功能，它就是一股脑儿地输出。

其次，输出目标多样化。print()只能往标准输出（通常是控制台）打印。但logging可以通过不同的Handler将日志发送到文件、网络（TCP/UDP）、邮件、HTTP服务器，甚至操作系统的日志系统。这在分布式系统或需要集中式日志管理的场景下，是print()望尘莫及的。想象一下，你的程序崩溃了，日志信息自动发送到你的邮箱，这比你盯着控制台找错误要高效得多。

再者，格式化输出。logging.Formatter让你能自定义日志消息的格式，包含时间戳、日志级别、模块名、文件名、行号、函数名等等。这使得日志信息更具可读性和可追溯性。print()要实现这些，你得手动拼接字符串，既麻烦又容易出错。而且，logging还能自动处理多线程环境下的日志同步，避免输出混乱。

最后，也是我认为最关键的一点，logging提升了代码的可维护性和专业性。它强制你思考日志的用途和重要性，而不是随意地插入打印语句。当你的程序出现问题时，一份结构良好、信息丰富的日志远比一堆无序的print输出更能帮助你快速定位问题。它就像是程序运行的“黑匣子”，记录下关键的飞行数据，以便事后分析。

Python日志级别有哪些，如何选择合适的级别？

Python的logging模块定义了五个标准的日志级别，它们代表了事件的不同严重程度。理解这些级别并正确使用它们，是有效日志记录的关键。

1. DEBUG (10)：这是最低的级别，用于详细的调试信息。通常只在开发阶段或需要深入排查问题时启用。比如，某个变量的值在特定代码点是什么，某个函数被调用时传入了什么参数。

   logger.debug("处理用户请求，用户ID: %s", user_id)

2. INFO (20)：用于确认程序按预期运行的事件。这些是程序正常运行时的“里程碑”信息，可以用来了解程序的整体流程。

   logger.info("数据库连接成功")
   logger.info("任务调度器启动")

3. WARNING (30)：表示发生了意外或将来可能出现问题的情况，但程序仍然能够正常运行。这通常是一些需要注意但不是致命的问题。

   logger.warning("配置文件未找到，使用默认设置")
   logger.warning("缓存刷新失败，将尝试重试")

4. ERROR (40)：由于某个严重的问题，程序无法执行某些功能。这通常意味着某个操作失败了，但整个应用程序可能还没有完全崩溃。

   logger.error("文件写入失败：%s", file_path)
   logger.error("API调用返回错误状态码：%d", status_code)

5. CRITICAL (50)：这是最高的级别，表示发生了非常严重的错误，导致程序本身或系统组件无法继续运行。通常需要立即采取行动。

   logger.critical("数据库服务不可用，应用程序即将退出")
   logger.critical("内存溢出，系统崩溃！")

如何选择合适的级别？

选择日志级别更像是一种艺术，而非严格的科学。我的经验是，从目的出发。

• 开发阶段：我会把记录器级别设为DEBUG，甚至DEBUG以下（如果有自定义级别的话），这样我能看到所有细节。每一个分支、每一个变量的变化，都可能成为我调试的线索。
• 测试环境：通常会设为INFO或DEBUG，根据测试的深度和对日志量的容忍度来决定。目标是捕获所有潜在问题，同时避免日志文件过大。
• 生产环境：这是最需要谨慎的地方。通常将记录器级别设为INFO或WARNING。INFO用于记录关键业务流程的进展，WARNING用于提示潜在风险。ERROR和CRITICAL是必须捕获的，它们是系统健康状况的晴雨表。在生产环境，DEBUG级别的日志通常会被禁用，因为它会产生巨大的日志量，影响性能，并可能暴露敏感信息。

一个好的实践是，“宁滥勿缺”地记录，但“按需过滤”地输出。也就是说，在代码中，你可以在任何你觉得有用的地方打上debug或info日志。但在实际运行中，通过配置Handler的级别来控制最终输出的日志量。这样，当你需要深入调试时，只需调整配置，就能获得更详细的信息，而不需要修改代码。

如何将日志输出到文件或滚动文件？

将日志输出到文件是日志记录最常见的需求之一，因为它提供了持久化的记录，便于事后分析和故障排查。而“滚动文件”机制则解决了日志文件无限增长的问题，避免占用过多磁盘空间。

1. 输出到单个文件 (FileHandler)

最直接的方式是使用logging.FileHandler。它会将所有日志写入一个指定的文件。

import logging

logger = logging.getLogger('file_logger')
logger.setLevel(logging.DEBUG)

# 创建一个文件处理器，指定日志文件路径和编码
# 默认是'a'模式（追加），如果文件不存在则创建
file_handler = logging.FileHandler('my_application.log', encoding='utf-8')
file_handler.setLevel(logging.INFO) # 文件中只记录INFO及以上级别的日志

formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
file_handler.setFormatter(formatter)

logger.addHandler(file_handler)

logger.debug("这条调试信息不会写入文件，因为文件处理器级别是INFO")
logger.info("程序正常运行")
logger.warning("磁盘空间可能不足")
logger.error("致命错误发生")

这里需要注意的是，FileHandler默认以追加模式（'a'）打开文件。如果你希望每次程序启动都清空旧日志并重新开始，可以将mode='w'作为参数传递给FileHandler。

2. 输出到滚动文件 (RotatingFileHandler和TimedRotatingFileHandler)

当你的应用程序长时间运行，或者产生大量日志时，一个日志文件会变得非常大，这不仅难以管理，也可能耗尽磁盘空间。RotatingFileHandler和TimedRotatingFileHandler就是为解决这个问题而设计的。

• RotatingFileHandler：按文件大小滚动

  这个处理器会在日志文件达到指定大小时，将其重命名（通常是加上.1, .2等后缀），然后创建一个新的空文件继续写入日志。它会保留指定数量的旧日志文件。

  import logging
  from logging.handlers import RotatingFileHandler
  import time
  
  logger = logging.getLogger('rotating_logger')
  logger.setLevel(logging.DEBUG)
  
  # 创建一个滚动文件处理器
  # filename: 日志文件名
  # maxBytes: 单个日志文件最大字节数，例如 10 * 1024 * 1024 (10MB)
  # backupCount: 保留的旧日志文件数量
  rotating_handler = RotatingFileHandler(
      'app_rotated.log', maxBytes=10 * 1024 * 1024, backupCount=5, encoding='utf-8'
  )
  rotating_handler.setLevel(logging.INFO)
  
  formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
  rotating_handler.setFormatter(formatter)
  
  logger.addHandler(rotating_handler)
  
  for i in range(1000): # 模拟写入大量日志
      logger.info(f"这是第 {i} 条日志消息，程序正在正常运行。")
      time.sleep(0.01) # 稍微暂停，以便观察文件滚动

  当app_rotated.log达到10MB时，它会被重命名为app_rotated.log.1，然后创建一个新的app_rotated.log。当新的app_rotated.log再次达到10MB时，app_rotated.log.1会被重命名为app_rotated.log.2，app_rotated.log变为app_rotated.log.1，再创建一个新的app_rotated.log。这个过程会持续，直到达到backupCount的限制，最旧的文件会被删除。

• TimedRotatingFileHandler：按时间间隔滚动

  如果你更希望日志文件按天、按小时或按分钟滚动，TimedRotatingFileHandler是更好的选择。

  import logging
  from logging.handlers import TimedRotatingFileHandler
  import time
  
  logger = logging.getLogger('timed_rotating_logger')
  logger.setLevel(logging.DEBUG)
  
  # 创建一个按时间滚动的处理器
  # filename: 日志文件名
  # when: 滚动周期，例如 'h' (小时), 'd' (天), 'midnight' (每天午夜)
  # interval: 滚动间隔，例如 when='h', interval=1表示每小时滚动一次
  # backupCount: 保留的旧日志文件数量
  timed_rotating_handler = TimedRotatingFileHandler(
      'app_timed.log', when='midnight', interval=1, backupCount=7, encoding='utf-8'
  )
  timed_rotating_handler.setLevel(logging.INFO)
  
  formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
  timed_rotating_handler.setFormatter(formatter)
  
  logger.addHandler(timed_rotating_handler)
  
  # 模拟日志写入
  for i in range(50):
      logger.info(f"这是第 {i} 条定时滚动日志消息。")
      time.sleep(0.5)

  when参数可以设置为：

  • 's'：秒
  • 'm'：分钟
  • 'h'：小时
  • 'd'：天
  • 'w0' - 'w6'：每周的某一天（w0=周一）
  • 'midnight'：每天午夜

  使用滚动文件处理器是生产环境中日志管理的标准做法。它既保证了日志的完整性，又有效地控制了磁盘使用，是应用程序稳定运行不可或缺的一部分。

好了，本文到此结束，带大家了解了《Python日志配置与使用全解析》，希望本文对你有所帮助！关注golang学习网公众号，给大家分享更多文章知识！