# statsviz
**Repository Path**: bxtx/statsviz
## Basic Information
- **Project Name**: statsviz
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-03-23
- **Last Updated**: 2021-03-23
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
[](https://pkg.go.dev/github.com/arl/statsviz)
[](https://github.com/arl/statsviz/actions)
[](https://goreportcard.com/report/github.com/arl/statsviz)
[](https://codecov.io/gh/arl/statsviz)
Statsviz
========
Instant live visualization of your Go application runtime statistics
(GC, MemStats, etc.).
- Import `"github.com/arl/statsviz"`
- Register statsviz HTTP handlers
- Start your program
- Open your browser at `http://host:port/debug/statsviz`
- Enjoy...
How does it work?
-----------------
Statsviz serves 2 HTTP handlers.
The first one (by default `/debug/statsviz`) serves an html/js user interface showing
some initially empty plots.
When you points your browser to statsviz user interface page, it connects to statsviz
second HTTP handler. This second handler then upgrades the connection to the websocket
protocol and starts a goroutine that periodically calls [runtime.ReadMemStats](https://golang.org/pkg/runtime/#ReadMemStats),
sending the result to the user interface, which inturn, updates the plots.
Stats are stored in-browser inside a circular buffer which keep tracks of a predefined number of
datapoints, 60, so one minute-worth of data, by default. You can change the frequency
at which stats are sent by passing [SendFrequency](https://pkg.go.dev/github.com/arl/statsviz@v0.2.1#SendFrequency)
to [Register](https://pkg.go.dev/github.com/arl/statsviz@v0.2.1#Register).
Usage
-----
go get -u github.com/arl/statsviz
Either `Register` statsviz HTTP handlers with the [http.ServeMux](https://pkg.go.dev/net/http?tab=doc#ServeMux) you're using (preferred method):
```go
mux := http.NewServeMux()
statsviz.Register(mux)
```
Or register them with the `http.DefaultServeMux`:
```go
statsviz.RegisterDefault()
```
If your application is not already running an HTTP server, you need to start
one. Add `"net/http"` and `"log"` to your imports and the following code to your
`main` function:
```go
go func() {
log.Println(http.ListenAndServe("localhost:6060", nil))
}()
```
By default the handled path is `/debug/statsviz/`.
Then open your browser at http://localhost:6060/debug/statsviz/
Plots
-----
On the plots where it matters, garbage collections are shown as vertical lines.
### Heap
### MSpans / MCaches
### Size classes heatmap
### Objects
### Goroutines
### GC/CPU fraction
Examples
--------
Using `http.DefaultServeMux`:
- [_example/default/main.go](./_example/default/main.go)
Using your own `http.ServeMux`:
- [_example/mux/main.go](./_example/mux/main.go)
Serve `statsviz` on `/foo/bar` instead of default `/debug/statsviz`:
- [_example/root/main.go](./_example/root/main.go)
Serve on `https` (and `wss` for websocket):
- [_example/https/main.go](./_example/https/main.go)
With [gorilla/mux](https://github.com/gorilla/mux) router:
- [_example/gorilla/main.go](./_example/gorilla/main.go)
Using [labstack/echo](https://github.com/labstack/echo) router:
- [_example/echo/main.go](./_example/echo.go)
With [gin-gonic/gin](https://github.com/gin-gonic/gin) web framework:
- [_example/gin/main.go](./_example/gin/main.go)
With [go-chi/chi](https://github.com/go-chi/chi) router:
- [_example/chi/main.go](./_example/chi/main.go)
Contributing
------------
Pull-requests are welcome!
More details in [CONTRIBUTING.md](CONTRIBUTING.md)
Roadmap
-------
- [ ] add stop-the-world duration heatmap
- [ ] increase data retention
- [ ] light/dark mode selector
- [x] plot image export as png
- [ ] save timeseries to disk
- [ ] load from disk previously saved timeseries
Changelog
---------
See [CHANGELOG.md](./CHANGELOG.md).
License
-------
- [MIT License](LICENSE)