pprof

README

Use the pprof tool

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

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

Or to look at a 30-second CPU profile:

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

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

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

Or to collect a 5-second execution trace:

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

Trace and upload profile data

curl -X POST --data '{"debug": 0, "gc": 1, "seconds": 10, "profiles": ["profile", "allocs", "heap", "block", "mutex", "goroutine", "threadcreate"], "target": "http://127.0.0.1:9999/debug/pprof/receive"}' http://127.0.0.1:9999/debug/pprof/start

Documentation

Index

• Variables
• type Config
  • func DefaultConfig() *Config
  • func StdConfig() *Config
  • func (c *Config) Build() *PProf
  • func (c *Config) Path() string
• type PProf
  • func (pp *PProf) Name() string
  • func (pp *PProf) Serve(ctx context.Context) error
  • func (pp *PProf) Shutdown(ctx context.Context) error
  • func (pp *PProf) Start(ctx *ginserver.Context)
• type StartReq

Variables

var (
	Default = StdConfig().Build()
)

Types

type Config

type Config struct {
}

func DefaultConfig

func DefaultConfig() *Config

func StdConfig

func StdConfig() *Config

func (*Config) Build

func (c *Config) Build() *PProf

func (*Config) Path

func (c *Config) Path() string

type PProf

type PProf struct {
	// contains filtered or unexported fields
}

func (*PProf) Name

func (pp *PProf) Name() string

func (*PProf) Serve

func (pp *PProf) Serve(ctx context.Context) error

func (*PProf) Shutdown

func (pp *PProf) Shutdown(ctx context.Context) error

func (*PProf) Start

func (pp *PProf) Start(ctx *ginserver.Context)

type StartReq

type StartReq struct {
	// post pprof file to the target
	Target string `json:"target" binding:"required"`

	// pprof command
	Profiles []string `form:"profiles" binding:"required"`

	// debug=N (all profiles): response format: N = 0: binary (default), N > 0: plaintext
	Debug *int `form:"debug"`

	// gc=N (heap profile): N > 0: run a garbage collection cycle before profiling
	GC *int `form:"gc"`

	// seconds=N (allocs, block, goroutine, heap, mutex, threadcreate profiles): return a delta profile
	// seconds=N (cpu (profile), trace profiles): profile for the given duration
	Seconds *int `form:"seconds"`
}