# README

Statsviz

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

Statsviz

Install

Get the latest version:

go get github.com/arl/statsviz@latest

Usage

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 http://localhost:8080/debug/statsviz

Examples

If you check any of the boxes below:

you use some HTTP framework
you want Statsviz to be located at /my/path/to/statsviz rather than /debug/statsviz
you want Statsviz under https:// rather than http://
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 func

Examples for the following cases, and more, are found in the _example directory:

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
- fasthttp
- fiber
- gin
- and many others thanks to many contributors!

How Does That Work?

Statsviz is made of two parts:

The Ws serves 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 Index http handler serves Statsviz user interface at /debug/statsviz at the address served by your program. When served, the UI connects to the Websocket endpoint and starts receiving data points.