每日一库之124:statsviz(可视化性能监控) - 图1

    今天跟大家介绍一款实时可视化 Go 程序运行时数据统计的工具 statsviz
    它的图形化展现对于我们了解 Go 程序的 GC 行为,以及内存开销等很有用!

    使用也很简单:

    1. go get github.com/arl/statsviz

    在你的 http.ServeMux 上注册

    1. mux := http.NewServeMux()
    2. statsviz.Register(mux)

    或者使用默认 http 注册:

    1. statsviz.RegisterDefault()

    如果你的程序不是一个 http 应用程序,那么你可以添加以下代码来启动

    1. go func() {
    2. log.Println(http.ListenAndServe("localhost:6060", nil))
    3. }()

    这段代码,我相信大家都非常熟悉了吧~
    当我们将启动之后,我们可以直接在浏览器中打开:
    http://localhost:6060/debug/statsviz/
    每日一库之124:statsviz(可视化性能监控) - 图2
    每日一库之124:statsviz(可视化性能监控) - 图3
    看起来酷炫高大上,其实主要还是依赖于 Go 为我们提供的 runtime stats

    具体我们来看看它的一些代码:

    1. // NewWsHandler returns a handler that upgrades the HTTP server connection to the WebSocket
    2. // protocol and sends application statistics at the given frequency.
    3. //
    4. // If the upgrade fails, an HTTP error response is sent to the client.
    5. func NewWsHandler(frequency time.Duration) http.HandlerFunc {
    6. return func(w http.ResponseWriter, r *http.Request) {
    7. var upgrader = websocket.Upgrader{
    8. ReadBufferSize: 1024,
    9. WriteBufferSize: 1024,
    10. }
    11. ws, err := upgrader.Upgrade(w, r, nil)
    12. if err != nil {
    13. return
    14. }
    15. defer ws.Close()
    16. // Explicitly ignore this error. We don't want to spam standard output
    17. // each time the other end of the websocket connection closes.
    18. _ = sendStats(ws, frequency)
    19. }
    20. }
    1. sendStats

      1. // sendStats indefinitely send runtime statistics on the websocket connection.
      2. func sendStats(conn *websocket.Conn, frequency time.Duration) error {
      3. tick := time.NewTicker(frequency)
      4. defer tick.Stop()
      5. var (
      6. stats stats
      7. err error
      8. )
      9. for range tick.C {
      10. runtime.ReadMemStats(&stats.Mem)
      11. stats.NumGoroutine = runtime.NumGoroutine()
      12. if err = conn.WriteJSON(stats); err != nil {
      13. break
      14. }
      15. }
      16. return err
      17. }
    2. 其实这个项目比较核心的代码是前端 JavaScript 代码:

      1. m.pushData = function (ts, allStats) {
      2. data.times.push(ts); // timestamp
      3. const memStats = allStats.Mem;
      4. data.gcfraction.push(memStats.GCCPUFraction);
      5. data.goroutines.push(allStats.NumGoroutine);
      6. data.heap[idxHeapAlloc].push(memStats.HeapAlloc);
      7. data.heap[idxHeapSys].push(memStats.HeapSys);
      8. data.heap[idxHeapIdle].push(memStats.HeapIdle);
      9. data.heap[idxHeapInuse].push(memStats.HeapInuse);
      10. data.heap[idxHeapNextGC].push(memStats.NextGC);
      11. data.mspanMCache[idxMSpanMCacheMSpanInUse].push(memStats.MSpanInuse);
      12. data.mspanMCache[idxMSpanMCacheMSpanSys].push(memStats.MSpanSys);
      13. data.mspanMCache[idxMSpanMSpanMSCacheInUse].push(memStats.MCacheInuse);
      14. data.mspanMCache[idxMSpanMSpanMSCacheSys].push(memStats.MCacheSys);
      15. data.objects[idxObjectsLive].push(memStats.Mallocs - memStats.Frees);
      16. data.objects[idxObjectsLookups].push(memStats.Lookups);
      17. data.objects[idxObjectsHeap].push(memStats.HeapObjects);
      18. for (let i = 0; i < memStats.BySize.length; i++) {
      19. const size = memStats.BySize[i];
      20. data.bySize[i].push(size.Mallocs - size.Frees);
      21. }
      22. updateLastGC(memStats);
      23. }

      渲染效果是通过 https://github.com/arl/statsviz/blob/master/static/plotly-basic.min.js 渲染所得。
      Plotly.js 简介:它是一款开源的 JavaScript 图表库,它基于 d3.js 和 stack.gl 。是一个高层次的、描述性的图表库。plotly.js 带来 20 种图表类型,包括 3D 图表,统计图表,和 SVG 地图。

    我们来看一个官网示例,很酷炫😎
    每日一库之124:statsviz(可视化性能监控) - 图4
    我们再来看看 statsviz 在 GitHub 仓库上提供的一些 demo 示意图(方便大家来直观的感受 statsviz):
    每日一库之124:statsviz(可视化性能监控) - 图5
    每日一库之124:statsviz(可视化性能监控) - 图6
    每日一库之124:statsviz(可视化性能监控) - 图7
    每日一库之124:statsviz(可视化性能监控) - 图8
    每日一库之124:statsviz(可视化性能监控) - 图9
    每日一库之124:statsviz(可视化性能监控) - 图10
    文章来源:
    https://mp.weixin.qq.com/s/gaQhIo544VHYeGcKq34GIw