Python 日志配置详解：使用 RotatingFileHandler 和 TimedRotatingFileHandler

最新推荐文章于 2025-03-10 16:27:01 发布

code-ranger

最新推荐文章于 2025-03-10 16:27:01 发布

阅读量1.6k

点赞数 26

分类专栏： python 文章标签： python

本文链接：https://blog.csdn.net/allnlei/article/details/144725532

版权

python 专栏收录该内容

3 篇文章

订阅专栏

config = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'default': {
            'format': ' %(asctime)s - %(name)s - %(levelname)s - %(message)s',
            'datefmt': "%Y/%m/%d %H:%M:%S"
        }
    },
    'handlers': {
        'rotatingHandler': {
            'class': 'logging.handlers.RotatingFileHandler',
            'filename': logfile,
            'maxBytes': 2*1024*1024,
            'backupCount': 3,
            'formatter': 'default',
            'encoding': 'utf-8'
        },
        'timedHandler': {
            'class': 'logging.handlers.TimedRotatingFileHandler',
            'filename': logfile,
            'when': 'midnight',
            'interval': 1,
            'backupCount': 7,
            'formatter': 'default',
            'encoding': 'utf-8'
        },
    },
    'loggers': {
        'celery': {
            'handlers': ['timedHandler'],
            'level': loglevel_str,
            'propagate': False
        },
    },
    'root': {
        'handlers': ['rotatingHandler'],
        'level': loglevel_str,
        'propagate': False
    },
}

logging.config.dictConfig(config)

1. 配置概述

以上配置通过字典方式定义了日志系统的各个组成部分，包括版本、格式化器、处理器、日志器等。最终通过 logging.config.dictConfig(config) 方法应用该配置。

1.1 版本与现有日志器

version: 配置的版本号，这里设置为 1，表示使用当前版本的配置格式。
disable_existing_loggers: 是否禁用现有的日志器。设置为 False，表示保留已存在的日志器配置。

2. 格式化器（Formatter）

格式化器定义了日志输出的格式。

'formatters': {
    'default': {
        'format': ' %(asctime)s - %(name)s - %(levelname)s - %(message)s',
        'datefmt': "%Y/%m/%d %H:%M:%S"
    }
},

default: 名称为 default 的格式化器。
- format: 定义日志条目的格式，包括时间、日志器名称、日志级别和消息内容。
- datefmt: 定义时间的格式，这里设置为 YYYY/MM/DD HH:MM:SS。

3. 处理器（Handler）

处理器负责将日志记录输出到不同的目的地，如文件、终端等。本文配置中使用了两种文件处理器：RotatingFileHandler 和 TimedRotatingFileHandler。

3.1 RotatingFileHandler

'rotatingHandler': {
    'class': 'logging.handlers.RotatingFileHandler',
    'filename': logfile,
    'maxBytes': 2*1024*1024,
    'backupCount': 3,
    'formatter': 'default',
    'encoding': 'utf-8'
},

class: 指定处理器的类，这里为 RotatingFileHandler。
filename: 日志文件的名称，变量 logfile 需预先定义。
maxBytes: 单个日志文件的最大字节数，超过后进行轮转。此处设置为 2MB。
backupCount: 保留的备份文件数量，设置为 3，意味着会保留最新的三个备份文件。
formatter: 使用之前定义的 default 格式化器。
encoding: 文件编码方式，设置为 utf-8。

工作原理：当日志文件大小超过 maxBytes 时，RotatingFileHandler 会自动将当前日志文件重命名为备份文件，同时新日志继续写入原文件名，最多保留 backupCount 个备份。

3.2 TimedRotatingFileHandler

'timedHandler': {
    'class': 'logging.handlers.TimedRotatingFileHandler',
    'filename': logfile,
    'when': 'midnight',
    'interval': 1,
    'backupCount': 7,
    'formatter': 'default',
    'encoding': 'utf-8'
},

class: 指定处理器的类，这里为 TimedRotatingFileHandler。
filename: 日志文件的名称，变量 logfile 需预先定义。
when: 指定时间轮转的单位，这里设置为 midnight，即每天午夜进行日志轮转。
interval: 轮转的间隔次数，与 when 结合。例如，when='midnight' 和 interval=1 表示每天轮转一次。
backupCount: 保留的备份文件数量，设置为 7，意味着会保留最近七天的日志备份。
formatter: 使用之前定义的 default 格式化器。
encoding: 文件编码方式，设置为 utf-8。

工作原理：TimedRotatingFileHandler 根据时间间隔自动轮转日志文件。比如上述配置每天午夜创建一个新的日志文件，旧日志根据 backupCount 保留七天。

4. 日志器（Logger）

日志器是日志系统的核心，负责接收日志消息并将其传递给相应的处理器。

4.1 Celery 日志器

'loggers': {
    'celery': {
        'handlers': ['timedHandler'],
        'level': loglevel_str,
        'propagate': False
    },
},

celery: 名称为 celery 的日志器，通常用于 Celery 任务队列的日志记录。
- handlers: 该日志器使用 timedHandler，即按时间轮转的处理器。
- level: 日志级别，由变量 loglevel_str 决定（如 DEBUG, INFO 等）。
- propagate: 设置为 False，表示日志不会向上级日志器传播，避免重复记录。

4.2 根日志器（Root Logger）

'root': {
    'handlers': ['rotatingHandler'],
    'level': loglevel_str,
    'propagate': False
},

root: 根日志器，适用于所有未明确指定的日志记录。
- handlers: 使用 rotatingHandler，即按大小轮转的处理器。
- level: 日志级别，同样由 loglevel_str 决定。
- propagate: 设置为 False，避免日志向上级传播。