Loguru日志库中实现日志记录字段截取的方法

在实际开发中，我们经常需要对日志格式进行定制化处理，特别是当某些字段内容过长时，合理的截取可以显著提高日志的可读性。Loguru作为Python生态中广受欢迎的日志库，提供了灵活的日志格式定制功能。

日志格式定制的基本原理

Loguru的日志格式遵循Python标准库中的字符串格式化语法。在定义日志格式时，我们可以使用{key:format}这样的语法来指定字段的显示格式。例如{level.name:<8}表示将日志级别名称左对齐并填充至8个字符宽度。

然而，标准的字符串格式化语法并不直接支持对字段内容进行切片或子字符串操作。这意味着如果我们想截取函数名的前14个字符，无法直接在格式字符串中实现。

通过record扩展实现字段截取

Loguru提供了一个强大的解决方案：通过record字典的extra字段来存储处理后的数据。具体实现步骤如下：

1. 定义一个处理函数，对原始字段进行处理并存入extra
2. 使用logger.configure(patcher=处理函数)注册这个处理函数
3. 在日志格式字符串中引用extra中的处理结果

示例代码如下：

from loguru import logger
import sys

def process_function_name(record):
    # 截取函数名前14个字符并存入extra
    record["extra"]["short_func"] = record["function"][0:14]

def long_function_name_example():
    logger.info("这是一条日志消息")

if __name__ == "__main__":
    # 配置logger使用我们的处理函数
    logger.configure(patcher=process_function_name)
    
    # 移除默认handler并添加自定义handler
    logger.remove()
    logger.add(sys.stderr, format="{time:YYYY-MM-DD HH:mm:ss} | {extra[short_func]:<15} | {message}")
    
    logger.info("程序启动")
    long_function_name_example()

执行这段代码，输出结果将显示截取后的函数名：

2024-03-30 18:17:19 | <module>       | 程序启动
2024-03-30 18:17:19 | long_function_ | 这是一条日志消息

高级应用场景

这种方法不仅适用于函数名截取，还可以应用于各种需要预处理日志字段的场景：

1. 敏感信息脱敏处理
2. 长路径的简化显示
3. 复杂数据结构的摘要生成
4. 多语言日志内容的翻译

性能考量

虽然这种预处理方式会增加少量的性能开销，但在大多数应用场景中，这种开销是可以忽略不计的。Loguru内部已经对日志记录过程进行了高度优化，确保即使在处理大量日志时也能保持良好的性能。

总结

通过Loguru的record扩展机制，我们可以灵活地预处理日志字段，实现各种复杂的格式化需求。这种方法既保持了日志格式定义的简洁性，又提供了强大的扩展能力，是Loguru日志库设计精妙之处的一个体现。在实际项目中，合理运用这一特性可以显著提升日志系统的可读性和实用性。