pprof工具的使用笔记

pprof是Go语言的性能分析工具，可以帮助我们分析程序的性能瓶颈。pprof可以生成CPU、内存、阻塞等多种性能分析报告。

通常，我们直接加入如下代码即可开启pprof功能：

main.go

package main

import (
    _ "runtime/pprof"
    "log/slog"
)

func main() {
    // ... 你的代码 ...
    
    go func() {
	    err := http.ListenAndServe(":6060", nil) // 假设监听端口是6060
	    if err != nil {
            slog.Error("启动pprof失败", "error", err)
        }
	}
	
	// ... 你的代码 ...
}

然后我们可以通过访问http://localhost:6060/debug/pprof来查看pprof的相关信息。

在页面中我们可以看到pprof支持的功能，例如allocs表示对过去的内存分配的采样，对应的地址就是http://localhost:6060/debug/pprof/allocs。

需要注意的是，profile和trace功能需要在地址之后加上?seconds=30参数，指定采样的秒数。

---

那么如何将这些数据可视化呢？我们可以使用go tool pprof命令来实现。格式如下：

go tool pprof -http=0.0.0.0:8848 http://localhost:6060/debug/pprof/profile?seconds=30

这个就代表获取CPU的性能30秒分析数据，并在8848端口上进行可视化。然后访问http://localhost:8848即可查看可视化的结果。go tool pprof命令后面的地址可以换成上述任意你想要的功能对应的地址。

如果不加-http=0.0.0.0:8848参数，就会在终端中进入pprof的交互模式，你可以在其中输入命令来查看性能数据。

易错点

有一个可能踩坑的地方，执行上述命令时有可能会报错：zsh: no matches found。如果你是在zsh终端中执行这个命令，因为命令中url后面恰好含有?符号，zsh会将其当作通配符处理，导致出错。将最后的url加个引号就可以解决。

注意

可视化需要一些图形库，例如graphviz，如果没有安装，访问http://localhost:8848时会报错：

Failed to execute dot. Is Graphviz installed?
exec: "dot": executable file not found in $PATH

直接使用例如yum、apt等工具安装即可。

如果只是查看火焰图，则不需要安装graphviz，忽略上面的报错，直接访问http://localhost:8848/ui/flamegraph即可。

在执行上述命令后，会有提示：

Fetching profile over HTTP from http://localhost:6060/debug/pprof/profile?seconds=30
Saved profile in path/to/file

注意红字部分，这个path/to/file是保存的文件路径。下次你可以直接使用这个文件，查看当时的性能数据，不再需要重新拉取了：

go tool pprof -http=0.0.0.0:8848 path/to/file