分享每一天-【golang工具】实时可视化 Go 程序运行时数据统计的工具 statsviz,超赞的库！

【golang工具】实时可视化 Go 程序运行时数据统计的工具 statsviz,超赞的库！

GoLang 819 0 创建时间：2022-11-10 10:29:29

go runtime-运行时指标数据数据统计的工具 statsviz

## 实时可视化 Go 程序运行时数据统计的工具 statsviz

在Web浏览器中可以实时可视化Go程序的runtime-运行时指标数据：堆、对象、goroutine、GC暂停、调度器等。如何监控 Go Runtime？
![](https://www.seedblog.cn/uploads/article/2022-11-10/mdKEljXWpfiJw09mcIRpwpUdDTT2qRD5WrLiWzln.png)
![](https://www.seedblog.cn/uploads/article/2022-11-10/gjajFJk46rFGQbT0jJx71dTHLVBwJ2liyczs9YKo.png)
#### 安装
```go
go get github.com/arl/statsviz@latest
```

#### 举例：
可以在HTTP服务 http.ServeMux注册statsviz
```go
mux := http.NewServeMux()
statsviz.Register(mux)
```
或者使用 http.DefaultServeMux注册：

```go
statsviz.RegisterDefault()
```
默认情况下statsviz的服务路由地址是在 /debug/statsviz/下。

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

```go
//没有提供 HTTP 服务的项目
go func() {
  statsviz.RegisterDefault()
  log.Println(http.ListenAndServe("localhost:8080", nil))
}()

```

2.http 应用程序实例：
```go
package main

import (
 "log"
 "net/http"

"github.com/arl/statsviz"
)

func main() {
 statsviz.RegisterDefault()
 log.Println(http.ListenAndServe(":6060", nil))
}
```

3.基于兼容 net/http 的框架

因为兼容 net/http 框架，因此可以直接将 statsviz 的 Handler 集成进去。比如对于 gorilla/mux 库，可以这么做：
```go
r := mux.NewRouter() 
r.Methods("GET").Path("/debug/statsviz/ws").Name("GET /debug/statsviz/ws").HandlerFunc(statsviz.Ws)
r.Methods("GET").PathPrefix("/debug/statsviz/").Name("GET /debug/statsviz/").Handler(statsviz.Index)

mux := http.NewServeMux()
mux.Handle("/", r)
http.ListenAndServe(":8080", mux)
```
这里主要是 statsviz.Ws 和 statsviz.Index，因为 gorilla/mux 库兼容 net/http，所以可以这么做。

4.不兼容 net/http 的框架

比如集成进 Gin 框架。做法就是和“没有提供 HTTP 服务的项目”一样，另开一个 HTTP 端口。

```go
go func() {
  statsviz.RegisterDefault() 
  log.Println(http.ListenAndServe("localhost:8080", nil))
}()
```

#### UI页面介绍
服务启动成功，我们可以访问http://localhost:6060/debug/statsviz/
，看到如下页面，可以看出如下的图表信息：
- 堆栈信息
- 堆栈中存活的对象和字节数
- mspan和mcache信息
- 不同大小级别对象的信息
- STW的延迟
- 在runnable状态中的goroutine花费的时间

#### statsviz是如何运作的呢？
那么你想知道statsviz是怎么工作的呢？让我们来一探究竟。

Statsviz 主要有 2 个 HTTP 接口服务：

- 第一个 ( /debug/statsviz) 是提供带有 statsviz 用户界面的网页，最初显示是一页空白的图。
- 第二个 HTTP 处理程序 ( /debug/statsviz/ws) 是监听的WebSocket 连接，该连接会在 statsviz 网页加载到您的浏览器后立即启动。

程序会每隔一秒将所有运行时/指标 数据指标信息发送到网页。数据存储在浏览器中的循环缓冲区中，该缓冲区只会保存预先设置的数量的数据信息。

#### statsviz如何集成到各不同的web框架中呢？

假如你也想接入statsviz，用的不是标准库，也可以看下statsviz在各个web框架和标准库中编写的例子，https://github.com/arl/statsviz/blob/v0.5.1/_example/README.md 。如没有你用的框架的实例，你也可以按需编写。这儿我们简单看一下常用web框架gin的例子
```go
package main

import (
 "fmt"

"github.com/gin-gonic/gin"

"github.com/arl/statsviz"
 example "github.com/arl/statsviz/_example"
)

func main() {
 // Force the GC to work to make the plots "move".
 go example.Work()

fmt.Println("Point your browser to http://localhost:8085/debug/statsviz/\n\n")

router := gin.New()
 router.GET("/debug/statsviz/*filepath", func(context *gin.Context) {
  if context.Param("filepath") == "/ws" {
   statsviz.Ws(context.Writer, context.Request)
   return
  }
  statsviz.IndexAtRoot("/debug/statsviz").ServeHTTP(context.Writer, context.Request)
 })
 router.Run(":8085")
}
```
例子中可以看出，主要实现了/debug/statsviz/路由下的GET请求，并实现了websocket的监听处理，另外后台强制开启了一个GC的工作任务。

#### 原理说明
该库使用 WebSocket 协议，定时将系统的 runtime 数据发送给浏览器，浏览器接收到之后，利用 JS 绘制图表，展示出来。Go 核心代码如下：
```go
// sendStats indefinitely send runtime statistics on the websocket connection. 
func sendStats(conn *websocket.Conn) error { 
 tick := time.NewTicker(defaultSendPeriod) 
 defer tick.Stop() 
 
 var stats stats 
 for { 
  select { 
  case <-tick.C: 
   runtime.ReadMemStats(&stats.Mem) 
   stats.NumGoroutine = runtime.NumGoroutine() 
   if err := conn.WriteJSON(stats); err != nil { 
    return err 
   } 
  } 
 } 
} 
```

#### github地址：
github.com/arl/statsviz

【golang工具】实时可视化 Go 程序运行时数据统计的工具 statsviz,超赞的库！

商品推荐

广告推荐

推荐文章