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

搭建

实例代码：

  1. package main
  3. import (
  4.     "net/http"
  5.     "github.com/gin-contrib/pprof"
  6.     "github.com/gin-gonic/gin"
  7. )
  9. func main() {
  10.     app := gin.Default()
  11.     pprof.Register(app) // 性能
  12.     app.GET("/test", func(c *gin.Context) {
  13.         c.String(http.StatusOK, "test")
  14.     })
  15.     app.Run(":3000")
  16. }
  1. package pprof
  3. import (
  4.     "net/http"
  5.     "net/http/pprof"
  7.     "github.com/gin-gonic/gin"
  8. )
  10. const (
  11.     // DefaultPrefix url prefix of pprof
  12.     DefaultPrefix = "/debug/pprof"
  13. )
  15. func getPrefix(prefixOptions ...string) string {
  16.     prefix := DefaultPrefix
  17.     if len(prefixOptions) > 0 {
  18.         prefix = prefixOptions[0]
  19.     }
  20.     return prefix
  21. }
  23. // Register the standard HandlerFuncs from the net/http/pprof package with
  24. // the provided gin.Engine. prefixOptions is a optional. If not prefixOptions,
  25. // the default path prefix is used, otherwise first prefixOptions will be path prefix.
  26. func Register(r *gin.Engine, prefixOptions ...string) {
  27.     RouteRegister(&(r.RouterGroup), prefixOptions...)
  28. }
  30. // RouteRegister the standard HandlerFuncs from the net/http/pprof package with
  31. // the provided gin.GrouterGroup. prefixOptions is a optional. If not prefixOptions,
  32. // the default path prefix is used, otherwise first prefixOptions will be path prefix.
  33. func RouteRegister(rg *gin.RouterGroup, prefixOptions ...string) {
  34.     prefix := getPrefix(prefixOptions...)
  36.     prefixRouter := rg.Group(prefix)
  37.     {
  38.         prefixRouter.GET("/", pprofHandler(pprof.Index))
  39.         prefixRouter.GET("/cmdline", pprofHandler(pprof.Cmdline))
  40.         prefixRouter.GET("/profile", pprofHandler(pprof.Profile))
  41.         prefixRouter.POST("/symbol", pprofHandler(pprof.Symbol))
  42.         prefixRouter.GET("/symbol", pprofHandler(pprof.Symbol))
  43.         prefixRouter.GET("/trace", pprofHandler(pprof.Trace))
  44.         prefixRouter.GET("/allocs", pprofHandler(pprof.Handler("allocs").ServeHTTP))
  45.         prefixRouter.GET("/block", pprofHandler(pprof.Handler("block").ServeHTTP))
  46.         prefixRouter.GET("/goroutine", pprofHandler(pprof.Handler("goroutine").ServeHTTP))
  47.         prefixRouter.GET("/heap", pprofHandler(pprof.Handler("heap").ServeHTTP))
  48.         prefixRouter.GET("/mutex", pprofHandler(pprof.Handler("mutex").ServeHTTP))
  49.         prefixRouter.GET("/threadcreate", pprofHandler(pprof.Handler("threadcreate").ServeHTTP))
  50.     }
  51. }
  53. func pprofHandler(h http.HandlerFunc) gin.HandlerFunc {
  54.     handler := http.HandlerFunc(h)
  55.     return func(c *gin.Context) {
  56.         handler.ServeHTTP(c.Writer, c.Request)
  57.     }
  58. }

编译并运行代码。代码运行之后可以看到系统自动增加了很多/debug/pprof的API。通过这些API我们可以看到需要的数据。
image.png
在浏览器里访问/debug/pprof, 通过这个页面我们可以看到我们需要的所有数据：
image.png这几个路径表示的是

  • /debug/pprof/profile：访问这个链接会自动进行 CPU profiling，持续 30s，并生成一个文件供下载
  • /debug/pprof/block：Goroutine阻塞事件的记录。默认每发生一次阻塞事件时取样一次。
  • /debug/pprof/goroutines：活跃Goroutine的信息的记录。仅在获取时取样一次。
  • /debug/pprof/heap： 堆内存分配情况的记录。默认每分配512K字节时取样一次。
  • /debug/pprof/mutex: 查看争用互斥锁的持有者。
  • /debug/pprof/threadcreate: 系统线程创建情况的记录。 仅在获取时取样一次。

使用go tool pprof采集数据

  1. go tool pprof http://localhost:3000/debug/pprof/profile?second=30

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

image.png
top命令展示函数的5个数据：

  1. flat: 函数执行时间
  2. flat%: 函数执行时间与总时间的百分比
  3. sum%: 前面每一行flat%的和
  4. cum: 累计量，加入函数调用了其它函数，其它函数的执行时间也会被记入
  5. cum%: 累计量占总量的百分比

image.png