Documentation ¶
Overview ¶
Package profile provides a simple way to manage runtime/pprof profiling of your Go application.
Index ¶
- Constants
- func BlockProfile(p *Profile)
- func CPUProfile(p *Profile)
- func MemProfile(p *Profile)
- func MemProfileRate(rate int) func(*Profile)
- func MutexProfile(p *Profile)
- func NoShutdownHook(p *Profile)
- func ProfilePath(path string) func(*Profile)
- func Quiet(p *Profile)
- func Start(options ...func(*Profile)) interface{ ... }
- func TraceProfile(p *Profile)
- type Profile
Constants ¶
const DefaultMemProfileRate = 4096
DefaultMemProfileRate is the default memory profiling rate. See also http://golang.org/pkg/runtime/#pkg-variables
Variables ¶
This section is empty.
Functions ¶
func BlockProfile ¶
func BlockProfile(p *Profile)
BlockProfile enables block (contention) profiling. It disables any previous profiling settings.
func CPUProfile ¶
func CPUProfile(p *Profile)
CPUProfile enables cpu profiling. It disables any previous profiling settings.
func MemProfile ¶
func MemProfile(p *Profile)
MemProfile enables memory profiling. It disables any previous profiling settings.
func MemProfileRate ¶
MemProfileRate enables memory profiling at the preferred rate. It disables any previous profiling settings.
func MutexProfile ¶
func MutexProfile(p *Profile)
MutexProfile enables mutex profiling. It disables any previous profiling settings.
Mutex profiling is a no-op before go1.8.
func NoShutdownHook ¶
func NoShutdownHook(p *Profile)
NoShutdownHook controls whether the profiling package should hook SIGINT to write profiles cleanly. Programs with more sophisticated signal handling should set this to true and ensure the Stop() function returned from Start() is called during shutdown.
func ProfilePath ¶
ProfilePath controls the base path where various profiling files are written. If blank, the base path will be generated by ioutil.TempDir.
func Start ¶
func Start(options ...func(*Profile)) interface { Stop() }
Start starts a new profiling session. The caller should call the Stop method on the value returned to cleanly stop profiling.
func TraceProfile ¶
func TraceProfile(p *Profile)
Trace profile controls if execution tracing will be enabled. It disables any previous profiling settings.