README
¶
Statsviz
Instant live visualization of your Go application runtime statistics (GC, MemStats, etc.).
- Import
import "github.com/arl/statsviz" - Register statsviz HTTP handlers
- Start your program
- Open your browser at
http://host:port/debug/statsviz - Enjoy...
Usage
go get -u github.com/arl/statsviz
Either Register statsviz HTTP handlers with the http.ServeMux you're using (preferred method):
mux := http.NewServeMux()
statsviz.Register(mux)
Or register them with the http.DefaultServeMux:
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 func() {
log.Println(http.ListenAndServe("localhost:6060", nil))
}()
The handled path is /debug/statsviz/.
Then open your browser at http://localhost:6060/debug/statsviz/
Examples
Using http.DefaultServeMux:
Using your own http.ServeMux:
Using gorilla/mux Router:
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
Contributing
Pull-requests are welcome! More details in CONTRIBUTING.md
Roadmap
- add stop-the-world duration heatmap
- increase data retention
- light/dark mode selector
- plot image export
Changelog
-
v0.1.1 / 2020-10-12
- Bugfix: do not leak timer in sendStats
-
v0.1.0 / 2020-10-10
- First released version
License
Documentation
¶
Overview ¶
Package statsviz serves via its HTTP server an HTML page displaying live visualization of the application runtime statistics.
The package is typically only imported for the side effect of registering its HTTP handler. The handled path is /debug/statsviz/.
To use statsviz, link this package into your program:
import _ "github.com/arl/statsviz"
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 func() {
log.Println(http.ListenAndServe("localhost:6060", nil))
}()
If you are not using DefaultServeMux, you will have to register handlers with the mux you are using.
Then open your browser at http://localhost:6060/debug/statsviz/
Index ¶
Constants ¶
This section is empty.
Variables ¶
var Index = http.StripPrefix(RootDir, http.FileServer(assets))
Index responds to a request for /debug/statsviz with the statsviz HTML page which shows a live visualization of the statistics sent by the application over the websocket handler Ws.
The package initialization registers it as /debug/statsviz/.
var (
RootDir = "/debug/statsviz/"
)
Functions ¶
func RegisterDefault ¶
func RegisterDefault()
RegisterDefault registers statsviz HTTP handlers on the default serve mux.
Note this is not advised on a production server, unless it only serves on localhost.
func SetRootDir ¶
func SetRootDir(prefix string)
func Ws ¶
func Ws(w http.ResponseWriter, r *http.Request)
Ws upgrades the HTTP server connection to the WebSocket protocol and sends application statistics every second.
If the upgrade fails, an HTTP error response is sent to the client. The package initialization registers it as /debug/statsviz/ws.
Types ¶
This section is empty.
Source Files
Directories