Weaver：Go程序的深度追踪利器

请注意！ Weaver目前正在进行重大重构，以利用libbpf替代bcc，这将带来许多其他重要改进。当前版本的功能和错误修复可能暂时被搁置，直至重构完成。重构进度可在"refactor"分支中查看。

Weaver是一个命令行工具，专为Go程序员设计，它让你能够追踪程序执行，洞察特定函数接收的参数值。这个强大的工具基于eBPF技术，并附加到uprobes上。

快速启动

有两种操作模式：一种是通过“函数文件”，另一种是从已编译的二进制文件中提取符号表并按Go包过滤。

函数文件模式

以以下示例程序为例：

package main

//go:noinline
func test_function(int, [2]int) {}

//go:noinline
func other_test_function(rune, int64) {}

func main() {
    test_function(3, [2]int{1, 2})
    other_test_function('a', 33)
}

如果想在运行时了解test_function和other_test_function的传入参数，只需创建一个文件列出要跟踪的函数：

functions_to_trace.txt

main.test_function(int, [2]int)
main.other_test_function(rune, int64)

注意，必须指定参数数据类型。（你可以使用weaver --types查看支持的数据类型。）

现在就可以调用weaver了：

sudo weaver -f /path/to/functions_to_trace.txt /path/to/test-prog-binary

当test-prog运行且上述函数被调用时，Weaver将静默等待并输出信息。

{"functionName":"main.other_test_function","args":[{"type":"RUNE","value":"a"},{"type":"INT64","value":"33"}],"procInfo":{"pid":43300,"ppid":42754,"comm":"test-prog-binar"}}
{"functionName":"main.test_function","args":[{"type":"INT","value":"3"},{"type":"INT_ARRAY","value":"1, 2"}],"procInfo":{"pid":43300,"ppid":42754,"comm":"test-prog-binar"}}

包模式

对于相同的Go程序，可以选择不指定函数文件。命令如下所示：

sudo weaver /path/to/test-prog-binary

默认情况下，只跟踪main包中的函数。但可以使用--packages标志指定逗号分隔的包列表（通常是形式如github.com/x/y）。

在这种模式下，输出仍包括参数值。

{"functionName":"main.main","procInfo":{"pid":44411,"ppid":42754,"comm":"test-prog-binar"}}
{"functionName":"main.test_function","procInfo":{"pid":44411,"ppid":42754,"comm":"test-prog-binar"}}

支持的数据类型

目前，Weaver支持基本数据类型，但扩展支持自定义类型是首要任务，包括标准库或用户定义的结构体和接口。工作正在展开！

系统依赖

• bcc 或 bcc-devel
• Linux内核版本大于4.14（若你的内核版本无法运行，请报告问题）

构建

运行make会在bin/weaver目录下编译Weaver二进制文件（同时会创建smoke测试二进制文件和print-stack实用程序）

遇到构建问题？请创建问题报告！

路线图

请参阅问题列表，查看当前跟踪的任务。如有问题，欢迎提交bug报告。

短期目标包括：

• 测试
• 输出选项
• 从二进制文件中检测参数数据类型，而非在函数文件中显式指定
• CI/CD基础设施建设

图片由Ashley McNamara依据Renee French的作品修改而成，原始作品授权于CC BY-NC-SA 4.0。

Weaver作为一款独特的Go代码调试工具，具备强大的潜力，能帮助开发者深入理解程序行为，提高调试效率。无论是新手还是经验丰富的开发人员，我们都强烈推荐尝试并加入Weaver的社区，一起打造更出色的Go编程体验。