Skip to content

Endpoint: pprof

YoyoFx edited this page Dec 9, 2020 · 3 revisions

pprof 支持

在 golang 官方包中有一个 pprof 包专门用来做性能分析; 该工具能方便的对我们的程序进行 内存,goroutine,cpu 进行分析; 使用该包时会有几个 http 接口暴露出来; 为了接入方便,YoyoGo框架已经进行了封装,通过配置文件即可开启或关闭性能分析接口。

快速使用

YoyoGo.CreateDefaultBuilder(func(rb router.IRouterBuilder) {
        Endpoints.UsePprof(rb)

	rb.GET("/info", func (ctx *context.HttpContext) {
		ctx.JSON(200, context.M{"info": "ok"})
	})
}).Build().Run()

功能开启后,我们启动项目,可以通过访问 http://127.0.0.1:8080/debug/pprof/ 来查看性能分析页面; 通过 go tool 工具还能将相关的性能指标生成 svg 查看;

分析接口

生成 svg

通过如下命令可以将 cpu 分析结果保持到一个 svg 文件中

go tool pprof -svg -output ./cpu.svg http://127.0.0.1.1:8080/debug/pprof/profile

另外,也可以将相应的分析结果源文件保存到本地后进行svg生成,以实现自动化程序调用等功能。 例如,我们将 http://127.0.0.1.1:8080/debug/pprof/profile 地址请求到的文件保存到本地 ./profile 文件,然后我们可以通过如下命令来转换成 svg 格式

go tool pprof -svg -output ./profile .svg ./profile 

Use the pprof tool

Then use the pprof tool to look at the heap profile:

go tool pprof http://localhost:8080/debug/pprof/heap

Or to look at a 30-second CPU profile:

go tool pprof http://localhost:8080/debug/pprof/profile

Or to look at the goroutine blocking profile, after calling runtime.SetBlockProfileRate in your program:

go tool pprof http://localhost:8080/debug/pprof/block

Or to collect a 5-second execution trace:

wget http://localhost:8080/debug/pprof/trace?seconds=5