用 Python 的 logging 模块替换 print:一次小项目的日志改造记录
我们组有一个跑在服务器上的数据同步脚本,最初几百行代码里调试信息全靠 print。脚本出问题时,大家只能翻 nohup.out,里面既没有时间戳,也分不清哪些是正常输出、哪些是报错。上个月一次同步失败,我们花了一个多小时才定位到是哪一批数据出了问题。之后决定把 print 全部换成 logging,这里记录一下改造过程。
一、为什么不用 print
print 只能把文本输出到标准输出,没有级别、没有时间、没有来源模块。想关掉调试信息只能注释代码,想把错误单独存到文件里也很麻烦。logging 提供了级别(DEBUG、INFO、WARNING、ERROR、CRITICAL)、格式化、输出目标三件事,基本覆盖了小项目的全部需求。
二、最小可用配置
在程序入口处调用一次 logging.basicConfig(level=logging.INFO, format="%(asctime)s %(levelname)s %(name)s: %(message)s")。各模块里不要直接用 logging.info,而是先用 logger = logging.getLogger(__name__) 取一个以模块名命名的 logger,再写 logger.info("开始同步第 %s 批数据", batch_id)。这样日志里会带上模块名,一眼就能看出是哪个文件打印的。
三、几个容易踩的坑
- 用 f-string 拼日志:即使 DEBUG 级别没开,f-string 也会先被拼出来。推荐用 %s 占位符,logging 只在真正输出时才格式化。
- 异常吞掉堆栈:在 except 里写
logger.error(e)只会记录一行错误信息。改用logger.exception("同步失败")会自动带上完整堆栈,排查效率完全不同。 - basicConfig 调用无效:如果在它之前某个第三方库已经往根 logger 加过 handler,basicConfig 默认什么都不做。Python 3.8 以后可以传 force=True 强制重新配置。
- 日志文件无限增长:直接用 FileHandler,几个月后日志文件能长到几个 G。换成 RotatingFileHandler 按大小切分,或 TimedRotatingFileHandler 按天切分,并设置 backupCount 保留最近若干份。
四、我们的最终方案
控制台输出 INFO 及以上,方便人工观察;文件输出 DEBUG 及以上,按天切分保留 14 天;ERROR 级别额外写入单独的 error.log,监控脚本只需要盯这个文件。第三方库 urllib3 的日志比较啰嗦,单独把它的级别调到 WARNING。
五、效果
改造完成后,再遇到同步失败,直接 grep error.log 就能看到出错的批次号和完整堆栈,定位时间从一小时缩短到几分钟。整个改造只改动了几十行代码,却让脚本从"能跑"变成了"出了问题也能查"。如果你的脚本还在靠 print 调试,可以从 basicConfig 这几行开始试试。
- 点赞
- 收藏
- 关注作者
评论(0)