Skip to content

ZhiqinYang/gom

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

gom GoDoc

A visual interface to work with runtime profiling data from Go programs.

gom screenshot

Installation

go get github.com/rakyll/gom/cmd/gom

The program you're willing to profile should import the github.com/rakyll/gom/http package. The http package will register several handlers to provide information about your program during runtime.

import _ "github.com/rakyll/gom/http"

// If your application is not already running an http server, you need to start one.
log.Println(http.ListenAndServe("localhost:6060", nil))

Now, you are ready to launch gom.

$ gom
  • :c loads the CPU profile.
  • :h loads the heap profile (default profile on launch).
  • :r refreshes the current profile.
  • :s toggles the cumulative sort and resorts the items.
  • ↓ and ↑ to paginate.
  • :f=<regex> filters the profile with the provided regex.

Goals

  • Building a lightweight tool that works well with runtime profiles is a necessity. Over the time, I recognized that a lot of people around me delayed to use the existing pprof tools because it's a tedious experience.
  • gom has no ambition to provide the features at the granularity of the features of the command line tools. Users should feel free to fallback to go tool pprof if they need more sophisticated features.
  • Allow users to filter, hide and ignore by symbol names.
  • Increase the awareness around profiling tools and packages in Go.
  • Provide additional lightweight stats where possible.

Minor Goals

  • gom should provide interfaces to let the users to export their profile data and continue to work with the go tool.
  • Allow users to work with their custom user profiles.
  • Make it easier to generate pprof graphical output.

About

A visual interface to work with runtime profiling data for Go

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Go 100.0%