Visualize real time plots of your Go program runtime metrics, including heap, objects, goroutines, GC pauses, scheduler and more, in your browser.
Get the latest version:
go get github.com/arl/statsviz@latest
Register Statsviz HTTP handlers with your application http.ServeMux.
mux := http.NewServeMux()
statsviz.Register(mux)
go func() {
log.Println(http.ListenAndServe("localhost:8080", mux))
}()Open your browser at https://localhost:8080/debug/statsviz
If you check any of the boxes below:
- you use some HTTP framework
- you want Statsviz to be located at
/my/path/to/statsvizrather than/debug/statsviz - you want Statsviz under
https://rather thanhttps:// - you want Statsviz behind some middleware
Then you should call statsviz.NewServer() (with or without options depending on your use case) in order to access the Index() and Ws() methods.
srv, err := statsviz.NewServer(); // Create server or handle error
if err != nil { /* handle error */ }
// Do something with the handlers.
srv.Index() // UI (dashboard) handler func
srv.Ws() // Websocket handler funcExamples for the following cases, and more, are found in the _example directory:
- use of
http.DefaultServeMuxor your ownhttp.ServeMux - wrap HTTP handler behind a middleware
- register the web page at
/foo/barinstead of/debug/statsviz - use
https://rather thanhttps:// - register Statsviz handlers with various Go HTTP libraries/frameworks:
Statsviz is made of two parts:
-
The
Wsserves a Websocket endpoint. When a client connects, your program's runtime/metrics are sent to the browser, once per second, via the websocket connection. -
the
Indexhttp handler serves Statsviz user interface at/debug/statsvizat the address served by your program. When served, the UI connects to the Websocket endpoint and starts receiving data points.
Check out the API reference on pkg.go.dev.
Each plot belongs to one or more categories. The category selector allows you to filter the visible plots by categories.
Use the time range selector to define the visualized time span.
Show or hide the vertical lines representing garbage collection events.
Pause or resume the plot updates.
Which plots are visible depends on:
- your Go version,since some plots are only available in newer versions.
- what plot categories are currently selected. By default all plots are shown.
.png)
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.
Either use GitHub's discussions or come to say hi and ask a live question on #statsviz channel on Gopher's slack.
Please use issues for bugs and feature requests.
Pull-requests are always welcome!
More details in CONTRIBUTING.md.
See CHANGELOG.md.
See LICENSE
