go-runtime/pprof

软件包 pprof主要功能是可视化工具所期望的格式写入运行时的分析数据

• 获取所有已知profile的切片，按名称排序
• 开启/关闭 当前进程CPU profile
• 如何将当前进程的堆栈信息写入文件中
• 新建profile
• 将当前栈添加到分析中
• 获取当前执行栈的数量
• 从该分析中移除与值value相关联的执行栈
• 将profile写入到文件中
• 通过名称查找profile

开始之前先下载性能文件分析工具，下载地址: http://www.graphviz.org/download/

获取所有已知profile的切片，按名称排序

func Profiles() []*Profile

type Profile struct {
    // 内含隐藏或非导出字段
}

Profile是一个调用栈踪迹的集合，显示导致特定事件（如内存分配）的实例的调用栈序列。包可以创建并维护它们自己的profile；它一般用于跟踪必须被显式关闭的资源，例如文件或网络连接 一个Profile的方法可被多个Go程同时调用

package main

import (
    "runtime/pprof"
    "fmt"
)

func main() {
 profiles :=  pprof.Profiles()
 for _,profile := range profiles{
     fmt.Println(profile.Name())
     fmt.Println(profile.Count())
 }
}

image.png

通过pprof.Profiles 我们获取到了main方法的堆栈信息

goroutine - 当前Go所有程的调用栈踪迹 heap - 所有堆分配的采样 threadcreate - 导致新的OS线程创建的调用栈踪迹 block - 导致同步原语水平的阻塞的调用栈踪迹`

开启cpu profile

func StartCPUProfile(w io.Writer) error func StopCPUProfile()

package main

import (
  "os"
  "runtime/pprof"
  "time"
  )

func main() {
  // 程序结束时关闭  
  defer pprof.StopCPUProfile()
  // 开启cpu性能检测
  file,_:= os.Create("/Users/xujie/go/src/awesomeProject/main/profile.pprof")
  pprof.StartCPUProfile(file)
  time.Sleep(time.Second)
}

如何将当前堆栈信息写入文件中去

package main

import (
    "os"
    "runtime/pprof"
    "fmt"
)

func main() {

 file,_:= os.Open("/Users/xujie/go/src/awesomeProject/main/profile.pprof")
 error := pprof.WriteHeapProfile(file)
 if error != nil{
     fmt.Println(error)
 }
}

通过上面代码我们已经将当前进程的数据写入文件中了，接下来我们使用命令查看一下

go tool pprof /Users/xujie/go/src/awesomeProject/main/profile.pprof

image.png

新建profile

func (p *Profile) Add(value interface{}, skip int)

将当前栈添加到分析中

func (p *Profile) Add(value interface{}, skip int) Add 将当前的执行栈添加到该分析中，并与value关联。Add在一个内部映射中存储值，因此value必须适于用作映射键，且在对应的Remove调用之前不会被垃圾收集。

若分析的映射中已经存在value键，Add就会引发panic。

获取当前执行栈的数量

func (p *Profile) Count() int Count返回该Profile中当前执行栈的数量。

从该分析中移除与值value相关联的执行栈

func (p *Profile) Remove(value interface{}) Remove从该分析中移除与值value相关联的执行栈。若值value不在此分析中，则不做操作。

将profile写入到文件中

func (p *Profile) WriteTo(w io.Writer, debug int) error 函数将pprof格式的profile快照写入w中。若一个向w的写入返回一个错误，WriteTo就会返回该错误；否则会返回nil。

debug 参数用于开启附加的输出。如果debug=0，只会打印pprof所需要的十六进制地址；如果debug=1，会将地址翻译为函数名和行号并添加注释，以便让程序员无需工具阅读分析报告。 预定义Profile为其它debug值赋予了含义。例如，当打印“Go程”的分析报告时，debug=2意为：由于不可恢复的恐慌而濒临崩溃时，使用与Go程序相同的格式打印Go程的堆栈信息。

通过名字查找profile

func Lookup(name string) *Profile

下面我们演示一下

import (
    "runtime/pprof"
    "os"
    "fmt"
)
func main() {
 file,_ := os.Create("/Users/xujie/go/src/awesomeProject/main/profile.pro")
 profile := pprof.NewProfile("main") // 1.新建
 profile.Add("analyse",1) //2
 error := profile.WriteTo(file,1) // debug=1，会将地址翻译为函数名和行号并添加注释
 fmt.Println(error)
}

profile.pro 文件内容

image.png

软件包 pprof主要功能是可视化工具所期望的格式写入运行时的分析数据

• 获取所有已知profile的切片，按名称排序
• 开启/关闭 当前进程CPU profile
• 如何将当前进程的堆栈信息写入文件中
• 新建profile
• 将当前栈添加到分析中
• 获取当前执行栈的数量
• 从该分析中移除与值value相关联的执行栈
• 将profile写入到文件中
• 通过名称查找profile

开始之前先下载性能文件分析工具，下载地址: http://www.graphviz.org/download/

获取所有已知profile的切片，按名称排序

func Profiles() []*Profile

type Profile struct {
    // 内含隐藏或非导出字段
}

Profile是一个调用栈踪迹的集合，显示导致特定事件（如内存分配）的实例的调用栈序列。包可以创建并维护它们自己的profile；它一般用于跟踪必须被显式关闭的资源，例如文件或网络连接 一个Profile的方法可被多个Go程同时调用

package main

import (
    "runtime/pprof"
    "fmt"
)

func main() {
 profiles :=  pprof.Profiles()
 for _,profile := range profiles{
     fmt.Println(profile.Name())
     fmt.Println(profile.Count())
 }
}

image.png

通过pprof.Profiles 我们获取到了main方法的堆栈信息

goroutine - 当前Go所有程的调用栈踪迹 heap - 所有堆分配的采样 threadcreate - 导致新的OS线程创建的调用栈踪迹 block - 导致同步原语水平的阻塞的调用栈踪迹`

开启cpu profile

func StartCPUProfile(w io.Writer) error func StopCPUProfile()

package main

import (
  "os"
  "runtime/pprof"
  "time"
  )

func main() {
  // 程序结束时关闭  
  defer pprof.StopCPUProfile()
  // 开启cpu性能检测
  file,_:= os.Create("/Users/xujie/go/src/awesomeProject/main/profile.pprof")
  pprof.StartCPUProfile(file)
  time.Sleep(time.Second)
}

如何将当前堆栈信息写入文件中去

package main

import (
    "os"
    "runtime/pprof"
    "fmt"
)

func main() {

 file,_:= os.Open("/Users/xujie/go/src/awesomeProject/main/profile.pprof")
 error := pprof.WriteHeapProfile(file)
 if error != nil{
     fmt.Println(error)
 }
}

通过上面代码我们已经将当前进程的数据写入文件中了，接下来我们使用命令查看一下

go tool pprof /Users/xujie/go/src/awesomeProject/main/profile.pprof

image.png

新建profile

func (p *Profile) Add(value interface{}, skip int)

将当前栈添加到分析中

func (p *Profile) Add(value interface{}, skip int) Add 将当前的执行栈添加到该分析中，并与value关联。Add在一个内部映射中存储值，因此value必须适于用作映射键，且在对应的Remove调用之前不会被垃圾收集。

若分析的映射中已经存在value键，Add就会引发panic。

获取当前执行栈的数量

func (p *Profile) Count() int Count返回该Profile中当前执行栈的数量。

从该分析中移除与值value相关联的执行栈

func (p *Profile) Remove(value interface{}) Remove从该分析中移除与值value相关联的执行栈。若值value不在此分析中，则不做操作。

将profile写入到文件中

func (p *Profile) WriteTo(w io.Writer, debug int) error 函数将pprof格式的profile快照写入w中。若一个向w的写入返回一个错误，WriteTo就会返回该错误；否则会返回nil。

debug 参数用于开启附加的输出。如果debug=0，只会打印pprof所需要的十六进制地址；如果debug=1，会将地址翻译为函数名和行号并添加注释，以便让程序员无需工具阅读分析报告。 预定义Profile为其它debug值赋予了含义。例如，当打印“Go程”的分析报告时，debug=2意为：由于不可恢复的恐慌而濒临崩溃时，使用与Go程序相同的格式打印Go程的堆栈信息。

通过名字查找profile

func Lookup(name string) *Profile

下面我们演示一下

import (
    "runtime/pprof"
    "os"
    "fmt"
)
func main() {
 file,_ := os.Create("/Users/xujie/go/src/awesomeProject/main/profile.pro")
 profile := pprof.NewProfile("main") // 1.新建
 profile.Add("analyse",1) //2
 error := profile.WriteTo(file,1) // debug=1，会将地址翻译为函数名和行号并添加注释
 fmt.Println(error)
}

profile.pro 文件内容

image.png