bpftrace日志系统重构：从混乱到规范

背景介绍

bpftrace作为一款强大的Linux动态追踪工具，其内部日志系统长期以来存在使用不规范的问题。开发团队近期对日志系统进行了全面重构，旨在建立统一的日志规范，提升代码可维护性和用户体验。

原有日志系统的问题

在重构前，bpftrace代码中存在多种日志级别混用的情况：

1. 日志级别定义不清晰：DEBUG、INFO、WARNING、ERROR、FATAL、BUG等6种级别存在交叉使用
2. 行为不一致：ERROR有时用作警告，有时直接导致程序退出
3. 输出渠道混乱：混合使用std::cout、std::cerr和专用日志宏
4. 条件日志处理不一致：部分日志通过bt_verbose条件判断输出

这些问题导致代码难以维护，也给用户理解日志信息带来困难。

重构方案设计

经过多次讨论，团队确定了新的日志规范：

日志级别定义

1. DEBUG：开发调试信息，包含文件名和行号，无条件输出
2. VERBOSE：仅在启用详细日志(-v)时输出的信息
3. WARNING：可能影响程序行为但允许继续运行的警告信息
4. ERROR：用户输入错误导致的异常情况（不立即退出）
5. FATAL：用户错误导致的程序终止
6. BUG：内部逻辑错误导致的程序终止

关键设计决策

1. 简化冗余级别：移除了冗余的bt_verbose2和-vv选项
2. 明确退出行为：区分可恢复错误(ERROR)和致命错误(FATAL/BUG)
3. 统一前缀规范：为不同级别添加标准前缀（如"WARNING:"）
4. 异常处理改进：避免在日志宏中直接退出，改为抛出异常

技术实现细节

重构过程中，团队特别注意了以下技术点：

1. 语义分析器兼容：保持原有收集多个错误后统一报告的能力
2. 单元测试支持：确保错误场景测试不受日志退出影响
3. API边界清晰：区分用户错误和内部错误的不同处理方式
4. 输出一致性：统一所有日志的输出格式和渠道

最佳实践建议

基于重构经验，团队总结出以下日志使用规范：

1. 用户可见信息使用VERBOSE级别
2. 可恢复错误使用ERROR并收集所有问题
3. 致命用户错误使用FATAL并立即退出
4. 内部逻辑错误使用BUG并附加详细上下文
5. 调试信息使用DEBUG并包含必要定位信息

总结

bpftrace的日志系统重构建立了清晰的日志级别规范和行为准则，解决了原有系统中的混乱问题。这一改进不仅提升了代码质量，也为后续的功能开发和问题排查奠定了良好基础。统一的日志规范将使开发者和用户都能更清晰地理解程序行为，提升整体使用体验。