如何修改Python日志Formatter中的%(name)s仅显示模块名而非完整层级路径
Python日志短模块名配置实现
该需求完全可落地,不需要修改业务代码中获取logger的逻辑,仅通过调整日志初始化配置即可实现。
实现逻辑
默认日志格式中的%(name)s会直接输出logger的全路径标识(如modules.subfolder.modulename),要仅展示末尾模块名,核心是在日志记录输出前,对原始的name字段做分割截取处理,常见两种实现方案:
方案一:自定义过滤器注入短名字段
这种方式灵活性最高,会保留原始的完整logger路径信息,后续需要切换回全路径展示时仅需修改日志格式串即可,不会丢失排查上下文。
实现步骤:
- 编写继承自
logging.Filter的过滤器类,在过滤器处理逻辑中,将日志记录的原始name值按.分割,取最后一段作为自定义短名字段挂载到日志对象上 - 日志格式串中把原来的
%(name)s替换为自定义的短名字段 - 将过滤器绑定到对应的日志处理器上
完整可运行配置示例:
import logging import time class ShortNameFilter(logging.Filter): def filter(self, record): # 按层级分割完整logger名,取最后一段作为短名 record.short_name = record.name.split('.')[-1] return True def run(): logformat = "[%(levelname)s] [%(short_name)s] %(asctime)s | %(message)s" datefmt = "%d-%m %H:%M:%S" logger = logging.getLogger() logger.setLevel(logging.INFO) formatter = logging.Formatter(logformat, datefmt=datefmt) ch = logging.StreamHandler() ch.setLevel(logging.INFO) ch.setFormatter(formatter) # 绑定短名过滤器到日志处理器 ch.addFilter(ShortNameFilter()) logger.addHandler(ch) # 多层级logger测试 module_logger = logging.getLogger("modules.subfolder.test_module") for i in range(1, 10): time.sleep(1) module_logger.info(f'Waiting {i}') if __name__ == '__main__': run()
该配置的实际输出效果:
[INFO] [test_module] 21-02 00:19:48 | Waiting 1 [INFO] [test_module] 21-02 00:19:49 | Waiting 2 ...
如果需要复现提到的“截取最后2位字符”的测试效果,仅需将过滤器中的name处理逻辑替换为record.short_name = record.name[-2:],即可得到示例中[ot]的输出结果。
方案二:自定义Formatter直接替换name值
这种方式改动量最小,不需要修改原有日志格式串,可直接适配现有配置。
实现步骤:
- 编写继承自
logging.Formatter的自定义格式化类,重写format方法,在调用父类格式化逻辑前,直接把日志记录的name值替换为截取后的短名称
自定义格式化类代码:
class ShortNameFormatter(logging.Formatter): def format(self, record): record.name = record.name.split('.')[-1] return super().format(record)
配置时仅需把原有初始化Formatter的代码替换为自定义类即可:
# 原有代码替换前 # formatter = logging.Formatter(logformat, datefmt=datefmt) # 替换为自定义Formatter formatter = ShortNameFormatter(logformat, datefmt=datefmt)
该方案的输出效果和方案一完全一致,适合对现有配置改动要求最小的场景。
内容的提问来源于stack exchange,提问作者Franz
相关产品推荐
相关产品推荐

