Go程序出问题了？有pprof！

什么情况下会关注程序的问题？

一是没事儿的时候

二是真有问题的时候

哈哈哈，今天我们就来一起了解一下Go程序的排查工具，可以说即简单又优雅，它就是pprof。

在 Go 中，pprof 工具提供了一种强大而灵活的机制来分析 Go 程序。pprof是 Go 中"profile"的缩写，是一种用于收集和分析 Go 程序运行时配置文件的工具。它提供了各种类型的配置文件，包括 CPU 分析、内存分析、goroutine 分析等。

程序中打开pprof的默认主页：

Go 语言 pprof 工具支持分享的指标：

(1) allocs: 所有过去内存分配的采样。

(2) block: 导致在同步原语上阻塞的堆栈跟踪。

(3) cmdline: 当前程序的命令行调用。

(4) goroutine: 所有当前 goroutine 的堆栈跟踪。使用 debug=2 作为查询参数可以以与未恢复的 panic 相同的格式导出。

(5) heap: 活跃对象的内存分配的采样。你可以指定 gc GET 参数来在采集堆样本之前运行 GC（垃圾回收）。

(6) mutex: 有争用的互斥锁持有者的堆栈跟踪。

(7) profile: CPU 分析文件。你可以指定 seconds GET 参数来指定分析的持续时间。获取到分析文件后，使用 go tool pprof 命令来调查分析。

(8) threadcreate: 导致创建新的 OS 线程的堆栈跟踪。

(9) trace: 当前程序的执行跟踪。你可以指定 seconds GET 参数来指定跟踪的持续时间。获取到跟踪文件后，使用 go tool trace 命令来调查跟踪。

其实总结下来，我们在日常使用pprof主要分析三个方面：

• CPU 性能分析： CPU 分析允许开发人员分析在 Go 程序中执行不同功能所花费的时间。这有助于识别消耗大量 CPU 时间的函数，并且可以进行优化以提高性能。
• 内存分析： 内存分析有助于识别 Go 程序中的内存泄漏、内存分配过多和内存使用效率低下。它提供了对内存分配模式的见解，使开发人员能够优化内存使用并防止与内存相关的问题。
• goroutine分析：goroutine 分析提供有关 Go 程序中 goroutine 的创建、阻止和销毁的信息。这有助于识别可能影响性能的问题，例如过多的 goroutine 创建或阻止操作。

使用pprof

要使用 pprof，我们需要在Go程序中导入 net/http/pprof，当然除了Go语言自带的分析工具，也有其他的三方工具帮助我们进行程序性能分析，比如github.com/mkevac/debugcharts，我们同pprof一样的方式进行导入。

除此之外，我们在程序中还提供了两个方法，并能够通过http进行访问：

• manyGo：增加程序运行中的goruntine数量
• memoryLeak：增加程序运行中的内存

下面是具体的代码：

package main

import (
	"fmt"
	"net/http"
	"time"

	_ "github.com/mkevac/debugcharts" // 添加后可以查看几个实时图表数据
	_ "net/http/pprof"
)

func memoryLeak() {
	var s [][]int
	for i := 0; i < 1000; i++ {
		s = append(s, make([]int, 1000))
	}
}

func main() {
	http.HandleFunc("/manyGo", func(writer http.ResponseWriter, request *http.Request) {
		fmt.Println("manyGo...")
		go func() {
			time.Sleep(30 * time.Minute)
		}()
		_, _ = writer.Write([]byte("Hello"))
	})
	http.HandleFunc("/memoryLeak", func(writer http.ResponseWriter, request *http.Request) {
		fmt.Println("memoryLeak...")
		memoryLeak()
		_, _ = writer.Write([]byte("Hello"))
	})
	_ = http.ListenAndServe(":8001", nil)
}

启动服务后我们先看下当前的状态：

首先看下pprof（http://localhost:8001/debug/pprof）

再看下插件显示的：

然后我们使用jmeter进行HTTP接口的多线程测试：

（1）使用10*10个线程访问http://localhost:8001/manyGo接口：

观察goruntine情况：

图表观察：

（2）使用100*10个线程访问http://localhost:8001/memoryLeak接口：

观察堆内存情况：

图表观察：

对比程序找出问题

我们再看下具体的goruntine信息http://localhost:8001/debug/pprof/goroutine?debug=1，会发现goruntine出现在哪一行代码

然后我们还可以使用Go自带的pprof查看工具来看一下：

go tool pprof -seconds=10 -http=:9999 http://localhost:8001/debug/pprof/heap

然后我们打开http://localhost:9999/ui:

就会发现这个工具会在网页端以源码的方式展示出内存使用和比例信息等，可以帮助我们深入的分析。

总结

通过上面对pprof工具的使用，发现其在Go程序分析中具有重要作用。具体来说，pprof通过收集程序运行时的信息，生成可视化的报告，帮助开发者理解程序的行为，并找出代码中的性能问题。

其他相关博客推荐：

https://colobu.com/2019/08/28/go-memory-leak-i-dont-think-so/

https://medium.com/@danielmalagurti/managing-memory-leaks-in-go-a-practical-guide-54d3c8d6487d

https://www.cnblogs.com/aquester/p/14344975.html

https://blog.xizhibei.me/2021/06/27/golang-heap-profiling/