README
¶
pprofit
Libraries and utilities for pprof, written in Go.
Overview
The Golang profiling tools are a pain to get set up in Windows, and they're quite dated compared to the tools available in IDEs like Visual Studio nowadays.
The over-ambitious goal of this is to start building a cross platform toolkit for the profiling of the performance of Go programs using Go itself and web browsers as the IDE. Being able to recreate the results from http://blog.golang.org/profiling-go-programs would be expecially nice.
The largest problem may end up being that there is currently no debugging information available on the Windows platform. Until that issue is resolved somehow, a lot of the most detailed information in the blog may be unavailable on Windows, but we can still make the tools that are available more accessible.
Goals
- Automated profiling of production cloud based golang systems
- Easy, dependency free local profiling tools
Current Status
2013/12/05 13:31:12 Starting profile collection (this will take ~30 secs)
2013/12/05 13:31:42 Done collecting profile
2013/12/05 13:31:42 Grinding callstack
Profile with 2996 samples
runtime.goexit 100.00% (0.00%)
runtime.main 100.00% (0.00%)
main.main 100.00% (0.00%)
main.HttpProfileServer 100.00% (0.00%)
main.DoWork 100.00% (0.00%)
main.ShortRunningFunction 95.53% (9.68%)
math.Sqrt 85.85% (85.85%)
main.LongRunningFuncion 4.47% (0.10%)
math.Sinh 4.37% (0.27%)
math.Exp 4.11% (4.11%)
Usage
go build github.com/Redundancy/pprofit/pprofit
<run program to profile for > 30 sec, running the http pprof module>
pprofit f -p 6060
Local testing
go build github.com/Redundancy/pprofit/sampleapp github.com/Redundancy/pprofit/integrationtest
Running integrationtest should execute sampleapp and interrogate it to generate a profile, get other symbol information and then shut it down.
This is currently being developed on Windows, but there shouldn't be anything particularly special about that. I will look into getting a CI loop set up on Travis or some other service.
Milestones
- ☑ Backend code is able to interrogate a sample application using net/http/pprof and obtain a profile
- ☑ Profile can be interpreted using http://google-perftools.googlecode.com/svn/trunk/doc/cpuprofile-fileformat.html
- ☑ Function pointers can be interpreted
- ☑ Callgraph structure can be built from the samples
- ☐ Simple web-app running displaying some information
- ☐ Bootstap / D3 / AngularJS evaluated and potentially integrated
Documentation
¶
Overview ¶
Package pprofit is a collection of libraries and utilities for working with pprof profiles using Go code exclusively
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package callgrinder takes lists of samples and constructs a callgraph, with exclusive and inclusive function costs Currently WIP
|
Package callgrinder takes lists of samples and constructs a callgraph, with exclusive and inclusive function costs Currently WIP |
|
This package implements an interface to interact with the http server behind net/http/pprof We don't need to worry too much about the implementation on the backend, just the interface to it TODO worry about timeouts on long profiles TODO allow the http fetcher to run profiles for different lengths of time
|
This package implements an interface to interact with the http server behind net/http/pprof We don't need to worry too much about the implementation on the backend, just the interface to it TODO worry about timeouts on long profiles TODO allow the http fetcher to run profiles for different lengths of time |
|
integration test is designed to run the sample app and extract information from it.
|
integration test is designed to run the sample app and extract information from it. |
|
This package is designed to read the pprof format as described: http://google-perftools.googlecode.com/svn/trunk/doc/cpuprofile-fileformat.html
|
This package is designed to read the pprof format as described: http://google-perftools.googlecode.com/svn/trunk/doc/cpuprofile-fileformat.html |
|
This is a very simple sample application for generating data to use against the profile tool To start with the profile tool is intended to consume data from the net/http/pprof module This application also has an alternative way to run it that can generate a pprof file (which could be useful for tests)
|
This is a very simple sample application for generating data to use against the profile tool To start with the profile tool is intended to consume data from the net/http/pprof module This application also has an alternative way to run it that can generate a pprof file (which could be useful for tests) |