goprofiler

Golang profiling utility

Introduction

Simple profiling support package for Go.

Inspired by Dave Cheney's library, with extra functionality and automation.

The library can take CPU, Memory, Block, Mutex and Goroutine profiles. It can either take a single snapshot, or can take snapshots at regular intervals.

Installation

go get github.com/quipo/goprofiler/profiler

Sample usage

package main

import (
	"time"

	"github.com/quipo/goprofiler/profiler"
)

func main() {
	pprofConf := profiler.Config{
		Prefix: "/tmp/myapp.",
		CPU: true,
		Memory: true,
		Block: false,
		Goroutine: false,
		Mutex: false,
		Interval: "15s",      // one snapshot every 15 seconds,
		CPUProfileRate: 100,  // collect 100 CPU profiling samples per second
		MemoryProfileRate: 1, // collect information about all allocations
		MutexProfileRate: 1,  // collect information about all blocking events
	}
	prof := profiler.NewProfiler(pprofConf)
	go prof.Run()
	
	// your app's code here...

	// you can take a snapshot at any point in the code:
	prof.TakeSnapshot()

	// take one last snapshot and clean resources
	prof.Stop()
}

Useful links

• Debugging performance issues in Go programs (intel)
• Intel® Performance Counter Monitor
• runtime/pprof WriteTo
• Description of testing flags
• Monitoring A Production Golang Server With Memstats
• Go performance tales
• Cache coherency primer
• CPU Cache flushing fallacy
• cmd/gc: make liveness ~10x faster
• Go 1.4+ garbage collector YC thread
• Plans for pauseless GC algorithm
• Arena allocator in Go
• Google search for Go arena allocator
• Google search for Go GC flags
• How To Determine Web Application Thread Pool Size
• Go's unsafe.Pointer Pointer Type
• perf Counting
• Mutex profile

FlameGraph links:

• Brendan Gregg's link page
• LISA'13
• FlameGraph github repo, by Brendan Gregg
• Java Flame Graphs
• CPU Flame Graphs
• off-CPU Flame Graphs
• StackGraph command see also
• Go Flame Graphs
• Go-Torch, Stochastic flame graph profiler for Go programs
• Java in Flames

Author

Lorenzo Alberton

• Web: http://alberton.info
• Twitter: @lorenzoalberton
• Linkedin: /in/lorenzoalberton

Copyright

See LICENSE document