Gin 框架中使用 pprof

【导读】go 语言 web 框架 gin 中如何便捷引入 pprof 观察性能？本文做了详细介绍。

Go 语言内置了获取程序运行数据的工具，包括以下两个标准库：

• runtime/pprof: 采集工具型应用运行数据进行分析
• net/http/pprof: 采集服务型应用运行时数据进行分析

pprof 开启后，每隔一段时间 (10ms) 就会收集当前的堆栈信息，获取各个函数占用的 CPU 以及内存资源，然后通过对这些采样数据进行分析，形成一个性能分析报告。

性能优化主要有一下几个方面：

• CPU Profile：报告程序的 CPU 使用情况，按照一定频率去采集应用程序在 CPU 和寄存器上面的数据。
• Memory Profile（Heap Profile）: 报告程序的内存使用情况。
• Block Profiling: 报告 goroutines 不在运行状态的情况，可以用来分析和查找死锁等性能瓶颈。
• Goroutine Profiling: 报告 goroutines 的使用情况，有哪些 roroutines，它们的调用关系是怎样的。

注意：我们只应该在性能测试的时候才在代码中引入 pprof

下载 Gin 框架专用 pprof 包并在项目中添加

go get https://github.com/gin-contrib/pprof

添加 pprof 之后的代码如下：

package main

import (
    "net/http"

    "github.com/gin-contrib/pprof"
    "github.com/gin-gonic/gin"
)

func main() {
    app := gin.Default()

    pprof.Register(app) // 性能

    app.GET("/test", func(c *gin.Context) {
        c.String(http.StatusOK, "test")
    })
    app.Run(":3000")
}

编译并运行代码。代码运行之后可以看到系统自动增加了很多/debug/pprof的 API。通过这些 API 我们可以看到需要的数据。

在浏览器里访问/debug/pprof, 通过这个页面我们可以看到我们需要的所有数据：

使用 go tool pprof 采集数据

再新建一个终端窗口输入以下命令，获取当前协程的堆栈信息：

go tool pprof --seconds 20 http://localhost:3000/debug/pprof/goroutine

或者采用如下写法

go tool pprof http://localhost:3000/debug/pprof/goroutine?second=20

上述命令的意思是采集协程数据并持续 20S。执行结果如下：

现在已经进入了命令行模式，在最后一行的pprof后输入web, 会自动打开本地浏览器并访问相关页面，当然这只限于图形化界面系统，如 MacOS，Ubuntu Desktop，Windows 等。如果不是，比如说使用的云服务器就可能会是如下结果：

在这种情况，我们可以使用数据采集的结果文件创建新的 web 服务，以用来在客户端浏览。请注意采集数据时的Saved profile一行，这便是我们需要的数据文件。启动新的终端窗口，输入如下命令：

go tool pprof -http://0.0.0.0:3001 /home/ubuntu/pprof/pprof.rumgo.goroutine.001.pb.gz

直接在浏览器里访问http://ip:3001, 如果没有安装graphviz，会出现Could not execute dot；may need to install graphviz。安装 graphviz 的方式如下：

brew install graphviz # for macos

apt-get install graphviz # for ubuntu

yum install graphviz # for centos

注：graphviz 一定是安装在服务器上的哦

在浏览器中我们可以看到图形化的函数调用堆栈信息。右上角的VIEW栏有一些选项，可以点开查看，Flame Graph就是传说中的火焰图。

go tool pprof 命令行交互界面

go tool pprof只通过命令行也可以实现强大的功能，在上一节里我们遇到了一个命令，就是web，接下来再介绍几个常用的命令。

top

top默认查看程序中占用 cpu 前 10 位的函数。

top 3 可以查看程序中占用 CPU 前三位的函数。

最后一列为函数名称，其他各项内容意义如下：

• flat: 当前函数占用 CPU 的耗时
• flat%: 当前函数占用 CPU 的耗时百分比
• sum%: 函数占用 CPU 的累积耗时百分比
• cum：当前函数+调用当前函数的占用 CPU 总耗时
• cum%: 当前函数+调用当前函数的占用 CPU 总耗时百分比

list

我们还可以使用list 函数名命令查看具体的函数分析，例如：

pdf

pdf命令可以生成可视化的 pdf 文件。

help

help命令可以提供所有 pprof 支持的命令说明。