pprofile

Documentation

Overview

Package pprofile encapsulates pprof functionality.

Index

• Constants
• Variables
• func Modes() []string
• func Start(ctx context.Context, mode, pprofDir string) (stop func(), err error)

Constants

const (
	ModeOff       = "off"
	ModeCPU       = "cpu"
	ModeMem       = "mem"
	ModeBlock     = "block"
	ModeMutex     = "mutex"
	ModeTrace     = "trace"
	ModeThread    = "thread"
	ModeGoroutine = "goroutine"
)

Available pprof modes.

Variables

var OptMode = options.NewString(
	"debug.pprof",
	&options.Flag{},
	ModeOff,
	validMode,
	"pprof profiling mode",
	`Configure pprof profiling, writing output to SQ_CONFIG/pprof. Allowed modes are:

  `+strings.Join(modes, ", "),
)

Functions

func Modes

func Modes() []string

Modes returns the allowed pprof modes, including ModeNode.

func Start

func Start(ctx context.Context, mode, pprofDir string) (stop func(), err error)

Start starts pprof profiling, writing output to pprofDir, as well as a copy to pprofDir/history. If err is nil, the caller must invoke the returned stop func to stop profiling, typically in a defer.