bcicen / grmon Goto Github PK

View Code? Open in Web Editor NEW

1.9K 35.0 61.0 38 KB

Command line monitoring for goroutines

License: MIT License

Go 97.55% Makefile 2.45%

golang go command-line cli developer-tools top

grmon's Introduction

grmon

Command line monitoring for goroutines

Install

go get -u github.com/bcicen/grmon

Usage

Simply import and call grmon.Start() somewhere in your code:

import "github.com/bcicen/grmon/agent"
...
grmon.Start()

alternatively, you may just start the pprof server directly:

import (
	"net/http"
	_ "net/http/pprof"
)
...
go http.ListenAndServe(":1234", nil)

now grmon can connect to the running program:

grmon

By default, grmon will automatically refresh every 5s. Pause automatic refresh(p) to enable the cursor and expand the full trace for a selected goroutine(<enter>).

Keybindings

Key	Action
r	manually refresh
p	pause/unpause automatic updates
s	toggle sort column and refresh
f	filter by keyword
<up>,<down>,j,k	move cursor position
<enter>,o	expand trace under cursor
t	open trace in full screen mode
q	exit grmon

Options

Option	Description	Default
-i	time in seconds between refresh, 0 to disable	5
-host	target host	localhost:1234
-endpoint	target endpoint path	/debug/pprof

Roadmap

Hierarchal/tree display

grmon's People

Contributors

Stargazers

Watchers

grmon's Issues

Just an idiomatic thought.

My first impulse (right after, I could have really used this 3 weeks ago lol) is to "Yuck dep" but instead...

if you put cli in cmd/grmon

One could simply

go get github.com/bcicen/grmon
go install github.com/bcicen/grmon/cmd/grmon

No make or dep required (turns out I don't have dep installed, and I'm happy with that state of affairs 😁 )

You could still have a makefile and use dep, but the cmd/executable is more idiomatic

Under macos iterm2 there is no highlight on selecting goroutine.

Using macos iterm2 with grmon latest, but there is no hightlighting for selected goroutine.

Besides that everything works great, and I managed to find a goroutine leak after using grmon for 3 minutes.

Great tool!

Is that possible to publish a release?

We want to add this tool into hd-home which is a GitHub release asset tool. But there's no release found.

how can i know which goroutine consumes most cpu time ?

i'm running Kubernetes and try to figure out which goroutine / what code consumes most cpu time.

movement keys aren't working

Possibly a terminal mismatch issue, not sure yet, but the movement keys aren't working for me. I can hit 't' and get the trace for the item, but I can't really see which item I've selected.

Neat tool!

error occured when make install

Platform: mac os
Terminal: Iterm2
Error Msg:

% make install                                                                    
make build
dep ensure
make[1]: dep: No such file or directory
make[1]: *** [build] Error 1
make: *** [install] Error 2

invalid memory address or nil pointer dereference

When running grmon I'm getting this error. Any ideas why this is happening?

panic: runtime error: invalid memory address or nil pointer dereference
[signal SIGSEGV: segmentation violation code=0x1 addr=0x28 pc=0x1385f7c]

goroutine 1 [running]:
main.ReadRoutines(0xc000228000, 0xa1, 0x200, 0x10, 0xff, 0x0, 0x0, 0x0)
	/Users/me/go/src/github.com/bcicen/grmon/parse.go:76 +0x19c
main.poll(0x105a2f0, 0x0, 0xc0000f9ec0, 0xc0001ae000, 0x0)
	/Users/me/go/src/github.com/bcicen/grmon/client.go:38 +0x17c
main.Refresh()
	/Users/me/go/src/github.com/bcicen/grmon/main.go:38 +0x26
main.main()
	/Users/me/go/src/github.com/bcicen/grmon/main.go:202 +0xe7

Why the github.com/bcicen/grmon import?

Why can't grmon not just parse the output of /debug/pprof/goroutine?debug=1?

This would make things a lot easier as the program you want to monitor doesn't have to add another dependency.