Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/arl/statsviz

🚀 Visualise your Go program runtime metrics in real time in the browser
https://github.com/arl/statsviz

garbage-collector go golang golang-library hacktoberfest live metrics monitoring plots runtime stats visualization

Last synced: about 2 months ago
JSON representation

🚀 Visualise your Go program runtime metrics in real time in the browser

Lists

README 

        
[![go.dev reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white&style=round-square)](https://pkg.go.dev/github.com/arl/statsviz)

[![Latest tag](https://img.shields.io/github/tag/arl/statsviz.svg)](https://github.com/arl/statsviz/tag/)

[![Mentioned in Awesome Go](https://awesome.re/mentioned-badge.svg)](https://github.com/avelino/awesome-go)



[![Test Actions Status](https://github.com/arl/statsviz/workflows/Tests-linux/badge.svg)](https://github.com/arl/statsviz/actions)

[![Test Actions Status](https://github.com/arl/statsviz/workflows/Tests-others/badge.svg)](https://github.com/arl/statsviz/actions)

[![codecov](https://codecov.io/gh/arl/statsviz/branch/main/graph/badge.svg)](https://codecov.io/gh/arl/statsviz)



# Statsviz





  Statsviz Gopher Logo

  statsviz ui







Visualize real time plots of your Go program runtime metrics, including heap, objects, goroutines, GC pauses, scheduler and more, in your browser.






- [Statsviz](#statsviz)

  - [Install](#install)

  - [Usage](#usage)

  - [Advanced Usage](#advanced-usage)

  - [How Does That Work?](#how-does-that-work)

  - [Documentation](#documentation)

    - [Go API](#go-api)

    - [User interface](#user-interface)

    - [Plots](#plots)

    - [User Plots](#user-plots)

  - [Examples](#examples)

  - [Questions / Troubleshooting](#questions--troubleshooting)

  - [Contributing](#contributing)

  - [Changelog](#changelog)

  - [License: MIT](#license-mit)



## Install



Download the latest version:



```

go get github.com/arl/statsviz@latest

```



Please note that, as new metrics are added to the `/runtime/metrics` package, new plots are added to Statsviz.

This also means that the presence of some plots on the dashboard depends on the Go version you're using.



When in doubt, use the latest ;-)



## Usage



Register `Statsviz` HTTP handlers with your application `http.ServeMux`.



```go

mux := http.NewServeMux()

statsviz.Register(mux)



go func() {

    log.Println(http.ListenAndServe("localhost:8080", mux))

}()

```



Open your browser at http://localhost:8080/debug/statsviz



## Advanced Usage



If you want more control over Statsviz HTTP handlers, examples are:

 - you're using some HTTP framework

 - you want to place Statsviz handler behind some middleware



then use `statsviz.NewServer` to obtain a `Server` instance. Both the `Index()` and `Ws()` methods return `http.HandlerFunc`.



```go

srv, err := statsviz.NewServer(); // Create server or handle error

srv.Index()                       // UI (dashboard) http.HandlerFunc

srv.Ws()                          // Websocket http.HandlerFunc

```



Please look at examples of usage in the [Examples](_example) directory.



## How Does That Work?



`statsviz.Register` registers 2 HTTP handlers within the given `http.ServeMux`:



- the `Index` handler serves Statsviz user interface at `/debug/statsviz` at the address served by your program.



- The `Ws` serves a Websocket endpoint. When the browser connects to that endpoint, [runtime/metrics](https://pkg.go.dev/runtime/metrics) are sent to the browser, once per second.



Data points are in a browser-side circular-buffer.



## Documentation



### Go API



Check out the API reference on [pkg.go.dev](https://pkg.go.dev/github.com/arl/statsviz#section-documentation).



### User interface



Controls at the top of the page act on all plots:



menu



- the groom shows/hides the vertical lines representing garbage collections.

- the time range selector defines the visualized time span.

- the play/pause icons stops and resume the refresh of the plots.

- the light/dark selector switches between light and dark modes.



On top of each plot there are 2 icons:



menu



- the camera downloads a PNG image of the plot.

- the info icon shows details about the metrics displayed.



### Plots



Depending on your go version, some plots may not be available.



#### Heap (global)



heap-global



#### Heap (details)



heap-details



#### Live Objects in Heap



live-objects



#### Live Bytes in Heap



live-bytes



#### MSpan/MCache



mspan-mcache



#### Memory classes



memory-classes



#### Goroutines



goroutines



#### Size Classes



size-classes



#### GC Scan



gc-scan



#### GC Cycles



gc-cycles



#### Stop-the-world Pause Latencies



gc-pauses



#### CPU Classes (GC)



cpu-classes-gc



#### Time Goroutines Spend in 'Runnable' state



runnable-time



#### Time Goroutines Spend Blocked on Mutexes



mutex-wait



#### Starting Size of Goroutines Stacks



gc-stack-size



#### Goroutine Scheduling Events



sched-events



#### CGO Calls



cgo



### User Plots



Since `v0.6` you can add your own plots to Statsviz dashboard, in order to easily

visualize your application metrics next to runtime metrics.



Please see the [userplots example](_example/userplots/main.go).



## Examples



Check out the [\_example](./_example/README.md) directory to see various ways to use Statsviz, such as:



- use of `http.DefaultServeMux` or your own `http.ServeMux`

- wrap HTTP handler behind a middleware

- register the web page at `/foo/bar` instead of `/debug/statsviz`

- use `https://` rather than `http://`

- register Statsviz handlers with various Go HTTP libraries/frameworks:

  - [echo](https://github.com/labstack/echo/)

  - [fasthttp](https://github.com/valyala/fasthttp)

  - [fiber](https://github.com/gofiber/fiber/)

  - [gin](https://github.com/gin-gonic/gin)

  - and many others thanks to many contributors!



## Questions / Troubleshooting



Either use GitHub's [discussions](https://github.com/arl/statsviz/discussions) or come to say hi and ask a live question on [#statsviz channel on Gopher's slack](https://gophers.slack.com/archives/C043DU4NZ9D).



## Contributing



Please use [issues](https://github.com/arl/statsviz/issues/new/choose) for bugs and feature requests.  

Pull-requests are always welcome!  

More details in [CONTRIBUTING.md](CONTRIBUTING.md).



## Changelog



See [CHANGELOG.md](./CHANGELOG.md).



## License: MIT



See [LICENSE](LICENSE)