Python的logging模块是标准库中用于实现日志记录的核心工具,它提供了灵活的日志级别控制、多输出渠道支持以及可自定义的格式化能力,能够满足从简单脚本到复杂项目的各类日志需求。

Python日志模块核心组件
logging模块主要由四个核心组件构成,理解这些组件的作用才能灵活配置日志系统:
- Logger:日志的记录器,是开发者直接调用的接口,用于生成不同级别的日志消息。
- Handler:日志的处理器,负责将日志消息发送到指定的输出位置,比如控制台、文件、网络等。
- Formatter:日志的格式化器,用于定义日志消息的输出格式,比如时间、级别、内容等信息的排列规则。
- Filter:日志的过滤器,用于对日志消息做进一步的筛选,控制哪些日志可以被输出。
基础配置方法
对于简单的使用场景,可以直接使用logging模块的基础配置函数快速搭建日志系统,最常用的就是logging.basicConfig方法。
基础配置示例
以下代码演示了将日志同时输出到控制台和文件的基础配置:
import logging
# 基础配置,设置日志级别、输出格式、输出文件
logging.basicConfig(
level=logging.INFO, # 设置日志级别,低于该级别的日志不会被记录
format='%(asctime)s - %(name)s - %(levelname)s - %(message)s', # 日志格式
handlers=[
logging.StreamHandler(), # 控制台输出处理器
logging.FileHandler('app.log', encoding='utf-8') # 文件输出处理器,指定编码避免中文乱码
]
)
# 获取Logger实例
logger = logging.getLogger(__name__)
# 记录不同级别的日志
logger.debug('这是调试级别的日志,不会输出')
logger.info('这是信息级别的日志')
logger.warning('这是警告级别的日志')
logger.error('这是错误级别的日志')
上述代码中,日志级别设置为INFO,因此DEBUG级别的日志不会被输出。运行后控制台和app.log文件中都会记录INFO及以上级别的日志,格式包含时间、Logger名称、日志级别和日志内容。
高级自定义配置
当项目需求更复杂时,比如需要按时间分割日志文件、不同模块使用不同的日志配置,就需要手动组装各个核心组件。
按大小分割日志文件示例
使用RotatingFileHandler可以实现日志文件按大小自动分割,避免单个日志文件过大:
import logging
from logging.handlers import RotatingFileHandler
# 创建Logger实例
logger = logging.getLogger('my_app')
logger.setLevel(logging.DEBUG) # 设置Logger的全局级别
# 避免日志重复输出
if not logger.handlers:
# 创建控制台处理器
console_handler = logging.StreamHandler()
console_handler.setLevel(logging.INFO) # 控制台只输出INFO及以上级别
# 创建按大小分割的文件处理器,单个文件最大1MB,最多保留3个备份文件
file_handler = RotatingFileHandler(
'my_app.log',
maxBytes=1024 * 1024,
backupCount=3,
encoding='utf-8'
)
file_handler.setLevel(logging.DEBUG) # 文件记录DEBUG及以上级别
# 创建格式化器
formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(module)s - %(message)s')
# 给处理器设置格式化器
console_handler.setFormatter(formatter)
file_handler.setFormatter(formatter)
# 给Logger添加处理器
logger.addHandler(console_handler)
logger.addHandler(file_handler)
# 测试日志输出
logger.debug('调试信息,会写入文件但不会输出到控制台')
logger.info('普通信息,控制台和文件都会记录')
logger.error('错误信息,两个输出位置都会记录')
按时间分割日志文件示例
如果需要按时间周期分割日志,比如每天生成一个新的日志文件,可以使用TimedRotatingFileHandler:
import logging
from logging.handlers import TimedRotatingFileHandler
logger = logging.getLogger('time_rotate_app')
logger.setLevel(logging.INFO)
# 创建按时间分割的处理器,每天凌晨分割日志,保留7天的备份
time_handler = TimedRotatingFileHandler(
'time_app.log',
when='midnight',
interval=1,
backupCount=7,
encoding='utf-8'
)
time_handler.setFormatter(logging.Formatter('%(asctime)s - %(message)s'))
logger.addHandler(time_handler)
logger.info('按时间分割的日志记录测试')
常用日志级别说明
logging模块定义了5个标准日志级别,级别从低到高依次为:
| 级别名称 | 对应数值 | 适用场景 |
|---|---|---|
| DEBUG | 10 | 详细的调试信息,用于开发阶段定位问题 |
| INFO | 20 | 程序正常运行的确认信息,比如服务启动成功 |
| WARNING | 30 | 潜在的问题提示,程序仍可正常运行,比如内存占用过高 |
| ERROR | 40 | 程序运行出现错误,部分功能无法正常运行 |
| CRITICAL | 50 | 严重的错误,可能导致程序崩溃 |
注意事项
- 不要在多个地方重复给同一个Logger添加Handler,否则会导致日志重复输出。
- 如果使用FileHandler,建议指定编码为utf-8,避免中文日志出现乱码。
- 生产环境建议将日志级别设置为INFO及以上,避免大量DEBUG日志占用存储空间。
- Logger的名称建议使用模块名或者项目名,方便后续按模块筛选日志。