Log日志生成太多？自动分开存储吧！python logging

背景

最近在开发过程中，需要对日志进行保存，然而日志存着存着就会超级大，一个txt文件半天打不开，恼火至极，所以对日志保存进行自动开新日志的操作

详解

主要是使用了 logging.handlers 库中的 RotatingFileHandler  函数。

RotatingFileHandler 详解

一、定义与用途

RotatingFileHandler 是 Python 标准库中 logging.handlers 模块的一个类，用于实现日志文件的滚动和管理。在软件开发中，日志记录是非常重要的部分，它可以帮助开发者追踪代码的执行过程、排查错误和了解系统的运行情况。然而，随着时间的推移，日志文件可能会变得非常庞大，处理起来变得困难，甚至可能占用大量的磁盘空间。RotatingFileHandler 正是为了解决这一问题而设计的，它能够根据文件大小或时间自动创建新的日志文件，并删除旧的日志文件，从而保持日志文件的大小和数量在可控范围内。

二、参数说明

RotatingFileHandler 的构造函数接受多个参数，用于控制其行为：

• filename：日志文件的名称，可以包含路径信息。如果指定的文件不存在，则会自动创建。
• mode：日志文件的打开模式，默认为 'a'，即追加模式。如果选择其他模式，如 'w'，则每次启动程序时都会覆盖原有文件。
• maxBytes：单个日志文件的最大大小（以字节为单位），超过这个大小就会触发轮转（即创建新文件）。默认为 0，表示不限制文件大小。
• backupCount：保留的备份日志文件个数。当轮转发生时，如果备份文件个数超过这个值，最老的备份文件会被删除。默认为 0，表示不保留备份文件。
• encoding：文件的编码格式，默认为 None，表示使用系统默认编码。
• delay：是否延迟打开文件，直到第一次写入日志时再打开。默认为 False，即立即打开文件。

三、工作原理

RotatingFileHandler 的工作原理相对简单。当日志文件的大小达到 maxBytes 指定的阈值时，RotatingFileHandler 会自动关闭当前日志文件，并将其重命名为带有扩展名（如 .1、.2 等）的备份文件。然后，它会创建一个新的日志文件用于继续记录日志。如果备份文件的数量超过了 backupCount 指定的值，最老的备份文件将被删除，以释放磁盘空间。

四、使用场景

RotatingFileHandler 适用于需要长时间运行且日志量较大的应用程序。通过合理使用 maxBytes 和 backupCount 参数，开发者可以控制日志文件的大小和数量，从而避免日志文件过大导致的问题。

五、注意事项

• 在使用 RotatingFileHandler 时，需要确保应用程序有权限在指定路径下创建和删除文件。
• 如果 maxBytes 设置为 0，则 RotatingFileHandler 不会触发轮转，日志文件将无限增长。
• 如果 backupCount 设置为 0，则 RotatingFileHandler 不会保留任何备份文件，每次轮转时都会直接覆盖原有文件（如果 mode 不是 'w' 的话）。
• 在某些情况下，如果日志文件被外部程序删除或移动，RotatingFileHandler 可能无法正确识别并处理这种情况。为了解决这个问题，可以考虑使用 WatchedFileHandler，它会在每次写入日志时检查文件是否存在。

六、结论

RotatingFileHandler 是 Python 标准库中一个功能强大的日志处理类，它能够帮助开发者有效地管理日志文件的大小和数量。通过合理配置其参数，开发者可以轻松地实现日志文件的滚动和备份功能，从而提高系统的可维护性和稳定性。

代码示例：

import logging  
from logging.handlers import RotatingFileHandler  
  
# 配置日志  
logger = logging.getLogger('Rotating Log')  
logger.setLevel(logging.DEBUG)  # 设置日志级别  
  
# 创建一个handler，用于写入日志文件，最多保存10MB，备份文件有5个  
handler = RotatingFileHandler('app.log', maxBytes=10*1024*1024, backupCount=5)  
handler.setLevel(logging.DEBUG)  
  
# 创建一个formatter，并将其添加到handler中  
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')  
handler.setFormatter(formatter)  
  
# 将handler添加到logger中  
logger.addHandler(handler)  
  
# 写入一些日志  
logger.debug('这是一个debug级别的日志')  
logger.info('这是一个info级别的日志')  
logger.warning('这是一个warning级别的日志')  
  
# 当'app.log'文件大小超过10MB时，它会自动备份，并创建一个新的'app.log'文件  
# 备份文件的命名方式通常是 app.log.1, app.log.2, ..., app.log.5