https://github.com/bcicen/grmon

Command line monitoring for goroutines
https://github.com/bcicen/grmon

cli command-line developer-tools go golang top

Last synced: 7 days ago
JSON representation

Command line monitoring for goroutines

• Host: GitHub
• URL: https://github.com/bcicen/grmon
• Owner: bcicen
• License: mit
• Created: 2018-02-26T02:36:08.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-07-18T07:29:14.000Z (over 1 year ago)
• Last Synced: 2024-11-29T08:08:00.523Z (14 days ago)
• Topics: cli, command-line, developer-tools, go, golang, top
• Language: Go
• Size: 37.1 KB
• Stars: 1,897
• Watchers: 35
• Forks: 59
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• stars - bcicen/grmon
• my-awesome - bcicen/grmon - line,developer-tools,go,golang,top pushed_at:2023-07 star:1.9k fork:0.1k Command line monitoring for goroutines (Go)
• awesome-go-perf - bcicen/grmon - Command line monitoring for goroutines. (Concurrency)
• go-awesome - grmon - command line monitor showing goroutines (Open source library / Debugging)
• awesome-golang-repositories - grmon

README

        
# grmon

Command line monitoring for goroutines



## Install

```bash

go get -u github.com/bcicen/grmon

```

## Usage

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

```go

import "github.com/bcicen/grmon/agent"

...

grmon.Start()

```

alternatively, you may just start the pprof server directly:

```go

import (

	"net/http"

	_ "net/http/pprof"

)

...

go http.ListenAndServe(":1234", nil)

```

now `grmon` can connect to the running program:

```bash

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(``).

### Keybindings

Key | Action

--- | ---

r | manually refresh

p | pause/unpause automatic updates

s | toggle sort column and refresh

f | filter by keyword

\,\,j,k | move cursor position

\,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