Documentation
¶
Index ¶
- Constants
- func BlockProfile(p *Profile)
- func CPUProfile(p *Profile)
- func MemProfile(p *Profile)
- func MemProfileRate(rate int) func(*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
Examples ¶
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.
Example ¶
package main
import (
"github.com/zxfonline/misc/profile"
)
func main() {
// CPU profiling is the default profiling mode, but you can specify it
// explicitly for completeness.
defer profile.Start(profile.CPUProfile).Stop()
}
Output:
func MemProfile ¶
func MemProfile(p *Profile)
MemProfile enables memory profiling. It disables any previous profiling settings.
Example ¶
package main
import (
"github.com/zxfonline/misc/profile"
)
func main() {
// use memory profiling, rather than the default cpu profiling.
defer profile.Start(profile.MemProfile).Stop()
}
Output:
func MemProfileRate ¶
MemProfileRate enables memory profiling at the preferred rate. It disables any previous profiling settings.
Example ¶
package main
import (
"github.com/zxfonline/misc/profile"
)
func main() {
// use memory profiling with custom rate.
defer profile.Start(profile.MemProfileRate(2048)).Stop()
}
Output:
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.
Example ¶
package main
import (
"github.com/zxfonline/misc/profile"
)
func main() {
// disable the automatic shutdown hook.
defer profile.Start(profile.NoShutdownHook).Stop()
}
Output:
func ProfilePath ¶
ProfilePath controls the base path where various profiling files are written. If blank, the base path will be generated by ioutil.TempDir.
Example ¶
package main
import (
"os"
"github.com/zxfonline/misc/profile"
)
func main() {
// set the location that the profile will be written to
defer profile.Start(profile.ProfilePath(os.Getenv("HOME")))
}
Output:
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.
Example ¶
package main
import (
"github.com/zxfonline/misc/profile"
)
func main() {
// start a simple CPU profile and register
// a defer to Stop (flush) the profiling data.
defer profile.Start().Stop()
}
Output:
Example (WithFlags) ¶
package main
import (
"flag"
"github.com/zxfonline/misc/profile"
)
func main() {
// use the flags package to selectively enable profiling.
mode := flag.String("profile.mode", "", "enable profiling mode, one of [cpu, mem, block]")
flag.Parse()
switch *mode {
case "cpu":
defer profile.Start(profile.CPUProfile).Stop()
case "mem":
defer profile.Start(profile.MemProfile).Stop()
case "block":
defer profile.Start(profile.BlockProfile).Stop()
default:
// do nothing
}
}
Output:
func TraceProfile ¶
func TraceProfile(p *Profile)
Trace profile controls if execution tracing will be enabled. It disables any previous profiling settings.
Source Files