https://github.com/becheran/roumon

Universal goroutine monitor using pprof and termui
https://github.com/becheran/roumon

golang goroutines monitoring pprof termui tui

Last synced: 3 months ago
JSON representation

Universal goroutine monitor using pprof and termui

• Host: GitHub
• URL: https://github.com/becheran/roumon
• Owner: becheran
• License: mit
• Created: 2021-03-02T18:02:41.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-07-20T19:18:53.000Z (4 months ago)
• Last Synced: 2024-07-20T20:30:22.737Z (4 months ago)
• Topics: golang, goroutines, monitoring, pprof, termui, tui
• Language: Go
• Homepage:
• Size: 226 KB
• Stars: 178
• Watchers: 5
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-go-extra - roumon - 03-02T18:02:41Z|2022-08-23T20:42:33Z| (Go Tools / Routers)

README

        
# roumon

![Build Status](https://github.com/becheran/roumon/workflows/CI/badge.svg)

[![Go Report Card][go-report-image]][go-report-url]

[![PRs Welcome][pr-welcome-image]][pr-welcome-url]

[![License][license-image]][license-url]

[![Go Reference](https://pkg.go.dev/badge/github.com/becheran/roumon.svg)](https://pkg.go.dev/github.com/becheran/roumon)

[![Coverage Status](https://coveralls.io/repos/github/becheran/roumon/badge.svg?branch=main)](https://coveralls.io/github/becheran/roumon?branch=main)

[license-url]: https://github.com/becheran/roumon/blob/main/LICENSE

[license-image]: https://img.shields.io/badge/License-MIT-brightgreen.svg

[go-report-image]: https://goreportcard.com/badge/github.com/becheran/roumon

[go-report-url]: https://goreportcard.com/report/github.com/becheran/roumon

[pr-welcome-image]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg

[pr-welcome-url]: https://github.com/becheran/roumon/blob/main/CONTRIBUTING.md

A go**rou**tine **mon**itor to keep track of active routines from within your favorite shell.

![screenshot](doc/Screenshot.png)

## Features

* Track live state of all active goroutines

* Terminal user interface written with [termui](https://github.com/gizak/termui) 🤓

* Simple to integrate [pprof server](https://golang.org/pkg/net/http/pprof/) for live monitoring

* Dynamic history of goroutine count

* Full-text filtering

* Overview of routine states

## Installation

```sh

go install github.com/becheran/roumon@latest

```

Or download the pre-compiled binaries from the [releases page](https://github.com/becheran/roumon/releases).

## Usage

Before starting roumon, the go app which shall be monitored needs to be prepared to export pprof infos via http.

### pprof

The program which shall be monitored needs to run a [pprof server](https://golang.org/pkg/net/http/pprof/).

Import pprof into you program:

``` go

import _ "net/http/pprof"

```

Run a webserver which will listen on a specific port:

``` go

go func() {

    log.Println(http.ListenAndServe("localhost:6060", nil))

}()

```

Start your program and check that the `pprof` site is available in you web-browser:  `http://localhost:6060/debug/pprof`

### roumon

Start *roumon* in from your command line interface. Use optional arguments if needed.

For example `roumon -debug=logfile -host=192.168.10.1 -port=8081` will start the routine monitor for the *pprof profiles* exposed to `192.168.10.1:8081` and write a debug logfile to `./logfile`.

Run *roumon* with `-h` or `--help` to see all commandline argument options:

``` txt

Usage of roumon:

  -debug string

        Path to debug file 

  -host string

        The pprof server IP or hostname (default "localhost")

  -port int

        The pprof server port (default 6060)

```

From within the *Terminal User Interface (TUI)* hit `F1` for help `F10` or `ctrl-c` to stop the application.

## Contributing

Pull requests and issues [are welcome](./CONTRIBUTING.md)!