在线时间:8:00-16:00
迪恩网络APP
随时随地掌握行业动态
扫描二维码
关注迪恩网络微信公众号
在计算机性能调试领域里,profiling 是指对应用程序的画像,画像就是应用程序使用 CPU 和内存的情况。 Go语言是一个对性能特别看重的语言,因此语言中自带了 profiling 的库,这篇文章就要讲解怎么在 golang 中做 profiling。 Go性能优化Go语言项目中的性能优化主要有以下几个方面:
采集性能数据Go语言内置了获取程序的运行数据的工具,包括以下两个标准库:
pprof开启后,每隔一段时间(10ms)就会收集下当前的堆栈信息,获取格格函数占用的CPU以及内存资源;最后通过对这些采样数据进行分析,形成一个性能分析报告。 注意,我们只应该在性能测试的时候才在代码中引入pprof。 工具型应用如果你的应用程序是运行一段时间就结束退出类型。那么最好的办法是在应用退出的时候把 profiling 的报告保存到文件中,进行分析。对于这种情况,可以使用
CPU性能分析开启CPU性能分析:
停止CPU性能分析:
应用执行结束后,就会生成一个文件,保存了我们的 CPU profiling 数据。得到采样数据之后,使用 内存性能优化记录程序的堆栈信息
得到采样数据之后,使用
服务型应用如果你的应用程序是一直运行的,比如 web 应用,那么可以使用 如果使用了默认的 import _ "net/http/pprof" 如果你使用自定义的 Mux,则需要手动注册一些路由规则:
如果你使用的是gin框架,那么推荐使用 不管哪种方式,你的 HTTP 服务都会多出
go tool pprof命令不管是工具型应用还是服务型应用,我们使用相应的pprof库获取数据之后,下一步的都要对这些数据进行分析,我们可以使用
go tool pprof [binary] [source] 其中:
注意事项: 获取的 Profiling 数据是动态的,要想获得有效的数据,请保证应用处于较大的负载(比如正在生成中运行的服务,或者通过其他工具模拟访问压力)。否则如果应用处于空闲状态,得到的结果可能没有任何意义。 具体示例首先我们来写一段有问题的代码: // runtime_pprof/main.go package main import ( "flag" "fmt" "os" "runtime/pprof" "time" ) // 一段有问题的代码 func logicCode() { var c chan int for { select { case v := <-c: fmt.Printf("recv from chan, value:%v\n", v) default: } } } func main() { var isCPUPprof bool var isMemPprof bool flag.BoolVar(&isCPUPprof, "cpu", false, "turn cpu pprof on") flag.BoolVar(&isMemPprof, "mem", false, "turn mem pprof on") flag.Parse() if isCPUPprof { file, err := os.Create("./cpu.pprof") if err != nil { fmt.Printf("create cpu pprof failed, err:%v\n", err) return } pprof.StartCPUProfile(file) defer pprof.StopCPUProfile() } for i := 0; i < 8; i++ { go logicCode() } time.Sleep(20 * time.Second) if isMemPprof { file, err := os.Create("./mem.pprof") if err != nil { fmt.Printf("create mem pprof failed, err:%v\n", err) return } pprof.WriteHeapProfile(file) file.Close() } } 通过flag我们可以在命令行控制是否开启CPU和Mem的性能分析。 将上面的代码保存并编译成 ./runtime_pprof -cpu 等待30秒后会在当前目录下生成一个 命令行交互界面我们使用go工具链里的 go tool pprof cpu.pprof 执行上面的代码会进入交互界面如下: runtime_pprof $ go tool pprof cpu.pprof Type: cpu Time: Jun 28, 2019 at 11:28am (CST) Duration: 20.13s, Total samples = 1.91mins (568.60%) Entering interactive mode (type "help" for commands, "o" for options) (pprof) 我们可以在交互界面输入 (pprof) top3 Showing nodes accounting for 100.37s, 87.68% of 114.47s total Dropped 17 nodes (cum <= 0.57s) Showing top 3 nodes out of 4 flat flat% sum% cum cum% 42.52s 37.15% 37.15% 91.73s 80.13% runtime.selectnbrecv 35.21s 30.76% 67.90% 39.49s 34.50% runtime.chanrecv 22.64s 19.78% 87.68% 114.37s 99.91% main.logicCode 其中:
在大多数的情况下,我们可以通过分析这五列得出一个应用程序的运行情况,并对程序进行优化。 我们还可以使用 (pprof) list logicCode Total: 1.31mins ROUTINE ======================== main.logicCode in E:\go\project\src\go_dev\go_performance_optimisation\pprof.go 17.07s 1.30mins (flat, cum) 99.27% of Total . . 11:// 一段有问题的代码 . . 12:func logicCode() { . . 13: var c chan int . . 14: for { . . 15: select { 17.07s 1.30mins 16: case v := <-c: . . 17: fmt.Printf("recv from chan, value:%v\n", v) . . 18: default: . . 19: . . 20: } . . 21: } 通过分析发现大部分CPU资源被17行占用,我们分析出select语句中的default没有内容会导致上面的 图形化或者可以直接输入web,通过svg图的方式查看程序中详细的CPU占用情况。 想要查看图形化的界面首先需要安装graphviz图形化工具。 Mac: brew install graphviz Windows: 下载graphviz 将 关于图形的说明: 每个框代表一个函数,理论上框的越大表示占用的CPU资源越多。 方框之间的线条代表函数之间的调用关系。 线条上的数字表示函数调用的次数。 方框中的第一行数字表示当前函数占用CPU的百分比,第二行数字表示当前函数累计占用CPU的百分比。 go-torch和火焰图火焰图(Flame Graph)是 Bredan Gregg 创建的一种性能分析图表,因为它的样子近似 ????而得名。上面的 profiling 结果也转换成火焰图,如果对火焰图比较了解可以手动来操作,不过这里我们要介绍一个工具: 安装go-touchgo get -v github.com/uber/go-torch 火焰图 svg 文件可以通过浏览器打开,它对于调用图的最优点是它是动态的:可以通过点击每个方块来 zoom in 分析它上面的内容。 火焰图的调用顺序从下到上,每个方块代表一个函数,它上面一层表示这个函数会调用哪些函数,方块的大小代表了占用 CPU 使用的长短。火焰图的配色并没有特殊的意义,默认的红、黄配色是为了更像火焰而已。 go-torch 工具的使用非常简单,没有任何参数的话,它会尝试从
安装 FlameGraph要生成火焰图,需要事先安装 FlameGraph工具,这个工具的安装很简单(需要perl环境支持),只要把对应的可执行文件加入到环境变量中即可。
// GenerateFlameGraph runs the flamegraph script to generate a flame graph SVG. func GenerateFlameGraph(graphInput []byte, args ...string) ([]byte, error) { flameGraph := findInPath(flameGraphScripts) if flameGraph == "" { return nil, errNoPerlScript } if runtime.GOOS == "windows" { return runScript("perl", append([]string{flameGraph}, args...), graphInput) } return runScript(flameGraph, args, graphInput) } 压测工具wrk推荐使用https://github.com/wg/wrk 或 https://github.com/adjust/go-wrk 使用go-torch使用wrk进行压测: 然后我们使用浏览器打开 pprof与性能测试结合
我们还可以选择将pprof与性能测试相结合,比如: 比如下面执行测试的同时,也会执行 CPU profiling,并把结果保存在 cpu.prof 文件中: go test -bench . -cpuprofile=cpu.prof 比如下面执行测试的同时,也会执行 Mem profiling,并把结果保存在 cpu.prof 文件中: go test -bench . -memprofile=./mem.prof 需要注意的是,Profiling 一般和性能测试一起使用,这个原因在前文也提到过,只有应用在负载高的情况下 Profiling 才有意义。 补充:gin使用pprof |
请发表评论