History

Tonis Tiigi c1c3eefadc util: add profiling helpers for binaries Signed-off-by: Tonis Tiigi <tonistiigi@gmail.com>		2017-07-12 20:05:07 -07:00
..
LICENSE	util: add profiling helpers for binaries	2017-07-12 20:05:07 -07:00
README.md	util: add profiling helpers for binaries	2017-07-12 20:05:07 -07:00
mutex.go	util: add profiling helpers for binaries	2017-07-12 20:05:07 -07:00
mutex17.go	util: add profiling helpers for binaries	2017-07-12 20:05:07 -07:00
profile.go	util: add profiling helpers for binaries	2017-07-12 20:05:07 -07:00
trace.go	util: add profiling helpers for binaries	2017-07-12 20:05:07 -07:00
trace16.go	util: add profiling helpers for binaries	2017-07-12 20:05:07 -07:00

README.md

profile

Simple profiling support package for Go

installation

go get github.com/pkg/profile

usage

Enabling profiling in your application is as simple as one line at the top of your main function

import "github.com/pkg/profile"

func main() {
    defer profile.Start().Stop()
    ...
}

options

What to profile is controlled by config value passed to profile.Start. By default CPU profiling is enabled.

import "github.com/pkg/profile"

func main() {
    // p.Stop() must be called before the program exits to
    // ensure profiling information is written to disk.
    p := profile.Start(profile.MemProfile, profile.ProfilePath("."), profile.NoShutdownHook)
    ...
}

Several convenience package level values are provided for cpu, memory, and block (contention) profiling.

For more complex options, consult the documentation.

contributing

We welcome pull requests, bug fixes and issue reports.

Before proposing a change, please discuss it first by raising an issue.