Golang学习系列1-pprof性能调优

1. pprof 简述 

一位亦师亦友的话让我记忆犹新，他说“学习一个新事务，应该从三个方面入手what,why,how;且三者的重要程度应该是递减”。所以在本文的第一部分先叙述下pprof的what & why。

1.1 What？

pprof是golang自身提供的一种性能分析可视化工具。pprof开启后，每隔一段时间（10ms）就会收集下当前的堆栈信息，获取各个函数占用的CPU以及内存资源，并通过采样数据的分析形成一个性能分析报告。性能分析报告的核心内容包括：

• CPU Profiling：CPU 分析，按照一定的频率采集所监听的应用程序 CPU（含寄存器）的使用情况，可确定应用程序在主动消耗 CPU 周期时花费时间的位置
• Memory Profiling：内存分析，在应用程序进行堆分配时记录堆栈跟踪，用于监视当前和历史内存使用情况，以及检查内存泄漏
• Block Profiling：阻塞分析，记录 goroutine 阻塞等待同步（包括定时器通道）的位置
• Mutex Profiling：互斥锁分析，报告互斥锁的竞争情况

1.2 Why？

基于以上的分析报告，开发人员可以快速分析，定位和优化性能问题。

2. 案例依赖环境配置

本文基于windows11操作系统完成配置。

• Graph Visualization图可视化工具

官网描述：

Graph visualization is a way of representing structural information as diagrams of abstract graphs and networks. 

译文：

图可视化是一种将结构信息表示为抽象图和网络图的方法。

该工具在本文的作用体现在"案例分析"时对函数间调用关系以及各函数的CPU占用情况，以svg图形式进行可视化描述。

1）官网下载地址：https://www.graphviz.org/download/

2）安装&配置环境变量

• 安装：除了"安装位置"自定义外，其余步骤按照默认值即可。

•  环境变量配置

        在"控制面板"->"系统和安全"->"系统"->"高级系统设置"->"环境变量"->"系统变量"中完成设置

• 验证是否安装配置成功

        Win+R 运行cmd窗口，输入命令'dot -version'查看，显示以下结果表示安装配置成功。

3. 案例分析

这部分就是在讲"How to do it?"的问题啦！

本实战基于Git开源项目"GitHub - wolfogre/go-pprof-practice: go pprof practice.",首先clone项目到本地，然后运行main.go.

3.1 pprof报告预览

在浏览器中访问："http://localhost:6060/debug/pprof/"，就可以看到pprof报告的预览页。

3.2 性能问题排查优化

以排查优化CPU占用问题为例进行描述。内存，协程，锁等问题除需要分析的指标不同外，其余排查优化步骤都与CPU相似，所以后面就不再赘述啦😁。

1）问题表现

        运行main.go后，查看任务管理器，发现该任务的CPU占用几乎为总CPU占用的50%。

2）问题分析

# 采集前10s的数据到文件中，然后进入pprof操作命令行界面
go tool pprof "http://localhost:6060/debug/pprof/profile?seconds=10"

输入'top'查看 CPU占用最多的程序，输出结果如下：

参数说明
参数	描述
flat	当前函数本身的执行耗时【等于0时：表示当前函数中只包含其他函数的调用】
flat%	flat占CPU总时间的比例
sum%	上面每一行flat%的总和
cum	当前函数+调用其他函数的总耗时【等于flat时：表示函数中无其他函数调用】
cum%	cum占CPU总时间的比例

 由上图可见，函数"github.com/wolfogre/go-pprof-practice/animal/felidae/tiger.(*Tiger).Eat"的调用占用了几乎全部的CPU。使用'list Eat'命令查看具体函数的执行时间，以快速地定位到具体代码。

扩展：安装配置完成Graph Visualization可视化工具后，可使用'web'命令可对函数调用关系和资源使用情况进行svg可视化展示。

3）问题解决

通过上一步可定位到具体的问题代码，优化该代码逻辑即可。

注释掉耗时的代码后，再次查看任务管理器的资源消耗情况，可以看到已经完美解决Perfect!!!

func (t *Tiger) Eat() {
	log.Println(t.Name(), "eat")

    //注释掉耗时代码
	//loop := 10000000000
	//for i := 0; i < loop; i++ {
	//	// do nothing
	//}
}

4. 总结

最后，对程序性能问题的排查步骤和核心指标做个简单小结。

核心指标

  

指标类型	描述
profile	CPU占用情况【eg: http://localhost:6060/debug/pprof/profile】
heap	内存占用情况【eg: http://localhost:6060/debug/pprof/heap】
goroutine	协程调度【eg: http://localhost:6060/debug/pprof/goroutine】
mutex	锁竞争情况【eg: http://localhost:6060/debug/pprof/mutex】
block	阻塞情况【eg: http://localhost:6060/debug/pprof/block】

排查步骤

1. 采集数据&运行pprof分析工具

 go tool pprof "http://localhost:6060/debug/pprof/xxx?seconds=5"

2. 运行top指令

利用pprof提供的top指令查看指定指标的top函数。

3. 运行list xxx指令

利用pprof提供的list指令查看指定函数运行详情，定位问题，最后优化具体的代码即可。

参考文章：

pprof性能调优实战｜青训营笔记

地鼠文档-pprof性能调优