golang性能工具pprof的使用

pprof是google出品的,可用于对golang程序性能调优的一个工具。通过这个工具,可以精准的定位到内存、cpu等问题

pprof是go语言内置就有的,无须我们再额外安装包

1、环境准备

我这边是用的mac电脑对gin框架做的测试,配置如下,当然,也可以用其他的配置跑如下的用例
1、16G mac电脑
2、M1芯片
3、gin框架工程目录

2、用例准备

我这边的主代码逻辑如下,这个GetNum方法中,进行无限循环计算,然后把自增的i,追加到sum切片中,这种会导致sum切片的内存,无限扩大
Math.go

package service

import (
    "fmt"
)

var Heap = new(heap)

var sum = []int{}

type heap struct {
}

func (h *heap) GetNum() {
    i := h.sum()
    for {
        i++
        sum = append(sum, i)
        if i%1000000 == 0 {
            //time.Sleep(time.Second * 1)
            fmt.Println(i)
        }
    }
}

func (h *heap) sum() int {
    num := 0
    for i := 0; i < 100000; i++ {
        num += i
    }
    return num
}

route.go以下是对应的路由配置,这边主要是对pprof路由进行了配置

package app

import (
    "github.com/gin-gonic/gin"
    "net/http/pprof"
    "pay/app/controller"
)

func RegistRoute(engine *gin.Engine) {
    Heap := engine.Group("/heap")
    {
        Heap.GET("/log", controller.Heap.Log)
    }

    systemPprof(engine)
}

// pprof系统性能分析
func systemPprof(engine *gin.Engine) {
    pprofAPI := engine.Group("/pprof")
    {
        pprofAPI.GET("/", gin.WrapF(pprof.Index))
        pprofAPI.GET("/cmdline", gin.WrapF(pprof.Cmdline))
        pprofAPI.GET("/profile", gin.WrapF(pprof.Profile))
        pprofAPI.Any("/symbol", gin.WrapF(pprof.Symbol))
        pprofAPI.GET("/trace", gin.WrapF(pprof.Trace))
        pprofAPI.GET("/allocs", gin.WrapH(pprof.Handler("allocs")))
        pprofAPI.GET("/block", gin.WrapH(pprof.Handler("block")))
        pprofAPI.GET("/goroutine", gin.WrapH(pprof.Handler("goroutine")))
        pprofAPI.GET("/heap", gin.WrapH(pprof.Handler("heap")))
        pprofAPI.GET("/mutex", gin.WrapH(pprof.Handler("mutex")))
        pprofAPI.GET("/threadcreate", gin.WrapH(pprof.Handler("threadcreate")))
    }
}

这边是heap控制器,是对Math.go的代码逻辑进行执行调用

package controller

import (
    "github.com/gin-gonic/gin"
    "pay/service"
)

var Heap = new(heap)

type heap struct {
}

func (h *heap) Log(ctx *gin.Context) {
    service.Heap.GetNum()
}

3、使用pprof进行排查

对用例进行内存排查和定位,可以用如下的命令

go tool pprof http://localhost:8001/pprof/heap  

如下代表是连接成功


image.png

注意到这上图的红色提示了吗?

Saved profile in /Users/yilian/pprof/pprof.___go_build_pay.alloc_objects.alloc_space.inuse_objects.inuse_space.002.pb.gz

这个实际是读取的pprof服务提供的一个.pb.gz文件,它是一个通过 gzip 压缩的 protocol buffer 数据

回到上面的命令执行,输入top可以列出当前占用内存较高的几条数据,top后面可以跟上数字,代表要列出几条

4、web可视化分析

在实际生产环境中,面对复杂业务逻辑的话,内存的分析往往需要结合可视化进行分析,单从上方的命令行数据来看的话,往往无法精准定位到问题所在

a、安装graphviz

可以使用如下命令进行安装

brew install graphviz 

也可以去graphviz官网去找到对应的平台的安装方式
https://graphviz.gitlab.io/download/

b、使用graphviz

继续回到刚刚的命令行中执行web命令,如下


image.png

这时候这个行为会产生一个svg文件,并且调用我们系统设置的默认浏览器并且打开它,如下


企业微信截图_d3fe00eb-315b-4d05-ba6d-67ba9491446b.png
c、分析

红色的区域是需要警惕和关注的数据,从上图中,可以看到GetNum是我们写的业务代码,这里已经帮我们定位到是这个方法导致的内存泄露
从电脑的监控来看,确实这个__go_build_pay进程占用了大量的内存,总共占用了9.68G


企业微信截图_27c595e4-e80c-4596-a449-450e722d5305.png
d、实际生产环境如何使用

考虑到很多分布式系统中,可能一个应用服务器有多台,需要定位某一台服务器的内存泄露问题,我们可以先把这个服务器的内存heap文件下载到本地,再通过本地执行pprof加载heap文件来进行分析

为啥不通过域名来访问呢?比如 go tool pprof http://www.xxx.com/pprof/heap
因为实际线上环境,www.xxx.com只是域名解析,但是后面的应用服务器具有多台,可能请求会被调度到a服务器,也可能被调度到b服务器、c服务器等等,这样就容易影响我们分析的结果。可以采用内网ip的访问,把heap文件下载到本地,再进行分析,如下

curl -o local_heap http://10.112.60.195/pprof/heap //把内存数据保存到local_heap 文件中
go tool pprof local_heap  //使用pprof加载这个内存文件数据

5、其他使用

上面是对内存泄露进行的定位测试,当然也可以针对cpu、gc等定位和排查,数据内容如下

allocs 内存分配情况的采样信息
blocks 阻塞操作情况的采样信息
cmdline 显示程序启动命令及参数
goroutine 当前所有协程的堆栈信息
heap 堆上内存使用情况的采样信息
mutex 锁争用情况的采样信息
profile CPU 占用情况的采样信息
threadcreate 系统线程创建情况的采样信息

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,386评论 6 479
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,939评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,851评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,953评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,971评论 5 369
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,784评论 1 283
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,126评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,765评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,148评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,744评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,858评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,479评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,080评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,053评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,278评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,245评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,590评论 2 343