使用 expvar 暴露 Go 程序运行指标
Pull 与 Push
与监控系统对接方式有两种,一种是 Pull(拉取),另外一种 Push(推送)。
以 Prometheus 为例,应用程序通过暴露出 HTTP 接口,让 Prometheus 周期性地通过该接口抓取指标,这就是 Pull。而 Push 是应用程序主动将指标推送给 PushGateway, Prometheus 则去 PushGateway 抓取数据。
Go 标准库中有一个名为 expvar 的包,它的名字由 exp 和 var 两部分组合而成,意味着导出变量。
expvar 为公共变量提供了标准化的接口,并通过 HTTP 以 Json 的格式将这些变量暴露出去,很适合采用 Pull 的方式与监控系统进行对接。
使用 expvar 库
expvar 是标准库,意味着我们并不要额外的依赖,并且它还提供了一些开箱即用的指标。下面我们来学习一下该库的使用。
当引用了 expvar 库(<code style="font-size: 14px;word-wrap: break-word;padding: 2px 4px;border-radius: 4px;margin: 0 2px;background-color: rgba(27,31,35,.05);font-family: Operator Mono, Consolas, Monaco, Menlo, monospace;word-break: break-all;color: #000000;background: rgba(14, 210, 247, 0.15);"><span style="font-size: 15px;">import "expvar"</span>
import "expvar"),以下 init 函数将被自动调用。
func init() { http.HandleFunc("/debug/vars", expvarHandler) Publish("cmdline", Func(cmdline)) Publish("memstats", Func(memstats)) }
该函数为我们注册了 /debug/vars 路径的 HTTP 服务,访问该路径将得到 Json 格式的指标。
因此,我们还需要调用 ListenAndServe 绑定端口,并开始服务 HTTP 请求。
http.ListenAndServe(":8080", nil)
完整代码如下
package main import ( _ "expvar" "net/http" ) func main() { http.ListenAndServe(":8080", nil) }
将程序运行起来后,通过 curl 请求,得到以下结果
$ curl localhost:8080/debug/vars { "cmdline": ["/var/folders/xk/gn46n46d503dsztbc6_9qb2h0000gn/T/go-build1657217338/b001/exe/main"], "memstats": {"Alloc":278880,"TotalAlloc":278880,"Sys":8735760,"Lookups":0,"Mallocs":1169,"Frees":87,"HeapAlloc":278880,"HeapSys":3866624,"HeapIdle":2949120,"HeapInuse":917504,"HeapReleased":2899968,"HeapObjects":1082,"StackInuse":327680,"StackSys":327680,"MSpanInuse":28696,"MSpanSys":32640,"MCacheInuse":9600,"MCacheSys":15600,"BuckHashSys":3875,"GCSys":3826448,"OtherSys":662893,"NextGC":4194304,"LastGC":0,"PauseTotalNs":0,"PauseNs":[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],"PauseEnd":[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],"NumGC":0,"NumForcedGC":0,"GCCPUFraction":0,"EnableGC":true,"DebugGC":false,"BySize":[{"Size":0,"Mallocs":0,"Frees":0},{"Size":8,"Mallocs":41,"Frees":0},{"Size":16,"Mallocs":496,"Frees":0},{"Size":24,"Mallocs":63,"Frees":0},{"Size":32,"Mallocs":28,"Frees":0},{"Size":48,"Mallocs":134,"Frees":0},{"Size":64,"Mallocs":50,"Frees":0},{"Size":80,"Mallocs":17,"Frees":0},{"Size":96,"Mallocs":17,"Frees":0},{"Size":112,"Mallocs":6,"Frees":0},{"Size":128,"Mallocs":9,"Frees":0},{"Size":144,"Mallocs":9,"Frees":0},{"Size":160,"Mallocs":18,"Frees":0},{"Size":176,"Mallocs":6,"Frees":0},{"Size":192,"Mallocs":0,"Frees":0},{"Size":208,"Mallocs":37,"Frees":0},{"Size":224,"Mallocs":6,"Frees":0},{"Size":240,"Mallocs":0,"Frees":0},{"Size":256,"Mallocs":12,"Frees":0},{"Size":288,"Mallocs":7,"Frees":0},{"Size":320,"Mallocs":2,"Frees":0},{"Size":352,"Mallocs":13,"Frees":0},{"Size":384,"Mallocs":1,"Frees":0},{"Size":416,"Mallocs":30,"Frees":0},{"Size":448,"Mallocs":1,"Frees":0},{"Size":480,"Mallocs":2,"Frees":0},{"Size":512,"Mallocs":0,"Frees":0},{"Size":576,"Mallocs":5,"Frees":0},{"Size":640,"Mallocs":5,"Frees":0},{"Size":704,"Mallocs":3,"Frees":0},{"Size":768,"Mallocs":0,"Frees":0},{"Size":896,"Mallocs":6,"Frees":0},{"Size":1024,"Mallocs":8,"Frees":0},{"Size":1152,"Mallocs":10,"Frees":0},{"Size":1280,"Mallocs":3,"Frees":0},{"Size":1408,"Mallocs":1,"Frees":0},{"Size":1536,"Mallocs":0,"Frees":0},{"Size":1792,"Mallocs":7,"Frees":0},{"Size":2048,"Mallocs":2,"Frees":0},{"Size":2304,"Mallocs":3,"Frees":0},{"Size":2688,"Mallocs":2,"Frees":0},{"Size":3072,"Mallocs":0,"Frees":0},{"Size":3200,"Mallocs":0,"Frees":0},{"Size":3456,"Mallocs":0,"Frees":0},{"Size":4096,"Mallocs":8,"Frees":0},{"Size":4864,"Mallocs":1,"Frees":0},{"Size":5376,"Mallocs":1,"Frees":0},{"Size":6144,"Mallocs":2,"Frees":0},{"Size":6528,"Mallocs":0,"Frees":0},{"Size":6784,"Mallocs":0,"Frees":0},{"Size":6912,"Mallocs":0,"Frees":0},{"Size":8192,"Mallocs":2,"Frees":0},{"Size":9472,"Mallocs":8,"Frees":0},{"Size":9728,"Mallocs":0,"Frees":0},{"Size":10240,"Mallocs":0,"Frees":0},{"Size":10880,"Mallocs":0,"Frees":0},{"Size":12288,"Mallocs":0,"Frees":0},{"Size":13568,"Mallocs":0,"Frees":0},{"Size":14336,"Mallocs":0,"Frees":0},{"Size":16384,"Mallocs":0,"Frees":0},{"Size":18432,"Mallocs":0,"Frees":0}]} }
可以看到,expvar 默认已提供了两项指标,分别是程序执行命令(os.Args)和运行时内存分配(runtime.Memstats)信息。
expvar 库重点内容
expvar 中最重要的是 Publish 函数和 Var 接口。
func Publish(name string, v Var) {}
Publish 函数签名中需要两个参数,name 是我们指定的指标名。例如在上文 expvar 的 init 函数下 <span style="font-size: 15px;">Publish("cmdline", Func(cmdline))</span>
<span style="font-size: 15px;">Publish("cmdline", Func(cmdline))</span>
<span style="font-size: 15px;">cmdline</span>
代码行,其中</span>cmdline<code style="font-size: 14px;word-wrap: break-word;padding: 2px 4px;border-radius: 4px;margin: 0 2px;background-color: rgba(27,31,35,.05);font-family: Operator Mono, Consolas, Monaco, Menlo, monospace;word-break: break-all;color: #000000;background: rgba(14, 210, 247, 0.15);"><span style="font-size: 15px;">Func(cmdline)</span>
就是指标名,而</p>Func(cmdline)<p data-tool="mdnice编辑器" style="padding-top: 8px;padding-bottom: 8px;margin: 0;line-height: 26px;color: black;font-size: 17px;word-spacing: 3px;letter-spacing: 1px;">
则是实现了 Var 接口的 expvar.Func 类型变量。
// Var is an abstract type for all exported variables. type Var interface { // String returns a valid JSON value for the variable. // Types with String methods that do not return valid JSON // (such as time.Time) must not be used as a Var. String() string }
为了方便使用,expvar 库中提供了五种导出变量类型,它们均实现了 Var 接口。
type Int struct { i int64 } type Float struct { f uint64 } type Map struct { m sync.Map // map[string]Var keysMu sync.RWMutex keys []string // sorted } type String struct { s atomic.Value // string } type Func func() any
我们分别通过调用 expvar.NewXXX 函数即可完成前四种类型的变量创建与指标注册。
intVar = expvar.NewInt(“metricName”) floatVar = expvar.NewFloat(“metricName”) mapVar = expvar.NewMap(“metricName”) stringVar = expvar.NewString(“metricName”)
例如 expvar.NewInt 函数,它会内部调用 Publish 方法完成指标名与 expvar.Int 类型变量的绑定。
func NewInt(name string) *Int { v := new(Int) Publish(name, v) return v }
而 expvar.Func 类型,其实是为了让我们可以自定义导出类型。
例如,假如我们想要暴露以下定义的结构体
type MyStruct struct { Field1 string Field2 int Field3 float64 }
首先需要创建一个数据生成函数。它用于在每次调用 HTTP 服务路径时,通过该函数导出这里面的数据。
func MyStructData() interface{} { return MyStruct{ Field1: "Gopher", Field2: 22, Field3: 19.99, } }
最后,通过 Publish 函数注册指标名即可。
expvar.Publish("metricName", expvar.Func(MyStructData))
完整示例
下面,我们给出一个覆盖五种导出变量类型的完整示例。
package main import ( "expvar" "github.com/shirou/gopsutil/v3/host" "github.com/shirou/gopsutil/v3/load" "github.com/shirou/gopsutil/v3/mem" "net/http" "time" ) type Load struct { Load1 float64 Load5 float64 Load15 float64 } func AllLoadAvg() interface{} { return Load{ Load1: LoadAvg(1), Load5: LoadAvg(5), Load15: LoadAvg(15), } } func LoadAvg(loadNumber int) float64 { avg, _ := load.Avg() switch loadNumber { case 5: return avg.Load5 case 15: return avg.Load15 default: return avg.Load1 } } func main() { var ( aliveOfSeconds = expvar.NewInt("aliveOfSeconds") hostID = expvar.NewString("hostID") lastLoad = expvar.NewFloat("lastLoad") virtualMemory = expvar.NewMap("virtualMemory") ) expvar.Publish("allLoadAvg", expvar.Func(AllLoadAvg)) h, _ := host.HostID() hostID.Set(h) go http.ListenAndServe(":8080", nil) for { aliveOfSeconds.Add(1) vm, _ := mem.VirtualMemory() lastLoad.Set(LoadAvg(1)) virtualMemory.Add("active", int64(vm.Active)) virtualMemory.Add("buffer", int64(vm.Buffers)) time.Sleep(1 * time.Second) } }
在上述示例中,我们通过 gopsutil 库(介绍可见还在自己写 Go 系统监控函数吗一文)获取了一些系统信息,并展示了如何通过 expvar 中的各种变量类型将这些信息进行导出。
curl 访问 localhost:8080/debug/vars 结果如下
$ curl localhost:8080/debug/vars { "aliveOfSeconds": 1, "allLoadAvg": {"Load1":1.69580078125,"Load5":1.97412109375,"Load15":1.90283203125}, "cmdline": ["/var/folders/xk/gn46n46d503dsztbc6_9qb2h0000gn/T/go-build3566019824/b001/exe/main"], "hostID": "7a1a74f2-30fc-5bc1-b439-6b7aef22e58d", "lastLoad": 1.69580078125, "memstats": {"Alloc":256208,"TotalAlloc":256208,"Sys":8735760,"Lookups":0,"Mallocs":1089,"Frees":48,"HeapAlloc":256208,"HeapSys":3866624,"HeapIdle":2891776,"HeapInuse":974848,"HeapReleased":2859008,"HeapObjects":1041,"StackInuse":327680,"StackSys":327680,"MSpanInuse":19992,"MSpanSys":32640,"MCacheInuse":9600,"MCacheSys":15600,"BuckHashSys":3905,"GCSys":3851120,"OtherSys":638191,"NextGC":4194304,"LastGC":0,"PauseTotalNs":0,"PauseNs":[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],"PauseEnd":[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],"NumGC":0,"NumForcedGC":0,"GCCPUFraction":0,"EnableGC":true,"DebugGC":false,"BySize":[{"Size":0,"Mallocs":0,"Frees":0},{"Size":8,"Mallocs":35,"Frees":0},{"Size":16,"Mallocs":415,"Frees":0},{"Size":24,"Mallocs":71,"Frees":0},{"Size":32,"Mallocs":37,"Frees":0},{"Size":48,"Mallocs":141,"Frees":0},{"Size":64,"Mallocs":52,"Frees":0},{"Size":80,"Mallocs":20,"Frees":0},{"Size":96,"Mallocs":23,"Frees":0},{"Size":112,"Mallocs":14,"Frees":0},{"Size":128,"Mallocs":7,"Frees":0},{"Size":144,"Mallocs":7,"Frees":0},{"Size":160,"Mallocs":18,"Frees":0},{"Size":176,"Mallocs":6,"Frees":0},{"Size":192,"Mallocs":1,"Frees":0},{"Size":208,"Mallocs":42,"Frees":0},{"Size":224,"Mallocs":3,"Frees":0},{"Size":240,"Mallocs":0,"Frees":0},{"Size":256,"Mallocs":9,"Frees":0},{"Size":288,"Mallocs":8,"Frees":0},{"Size":320,"Mallocs":5,"Frees":0},{"Size":352,"Mallocs":13,"Frees":0},{"Size":384,"Mallocs":3,"Frees":0},{"Size":416,"Mallocs":33,"Frees":0},{"Size":448,"Mallocs":0,"Frees":0},{"Size":480,"Mallocs":2,"Frees":0},{"Size":512,"Mallocs":1,"Frees":0},{"Size":576,"Mallocs":4,"Frees":0},{"Size":640,"Mallocs":8,"Frees":0},{"Size":704,"Mallocs":3,"Frees":0},{"Size":768,"Mallocs":1,"Frees":0},{"Size":896,"Mallocs":6,"Frees":0},{"Size":1024,"Mallocs":8,"Frees":0},{"Size":1152,"Mallocs":9,"Frees":0},{"Size":1280,"Mallocs":3,"Frees":0},{"Size":1408,"Mallocs":1,"Frees":0},{"Size":1536,"Mallocs":1,"Frees":0},{"Size":1792,"Mallocs":9,"Frees":0},{"Size":2048,"Mallocs":1,"Frees":0},{"Size":2304,"Mallocs":2,"Frees":0},{"Size":2688,"Mallocs":2,"Frees":0},{"Size":3072,"Mallocs":0,"Frees":0},{"Size":3200,"Mallocs":1,"Frees":0},{"Size":3456,"Mallocs":0,"Frees":0},{"Size":4096,"Mallocs":5,"Frees":0},{"Size":4864,"Mallocs":0,"Frees":0},{"Size":5376,"Mallocs":1,"Frees":0},{"Size":6144,"Mallocs":1,"Frees":0},{"Size":6528,"Mallocs":0,"Frees":0},{"Size":6784,"Mallocs":0,"Frees":0},{"Size":6912,"Mallocs":0,"Frees":0},{"Size":8192,"Mallocs":1,"Frees":0},{"Size":9472,"Mallocs":8,"Frees":0},{"Size":9728,"Mallocs":0,"Frees":0},{"Size":10240,"Mallocs":0,"Frees":0},{"Size":10880,"Mallocs":0,"Frees":0},{"Size":12288,"Mallocs":0,"Frees":0},{"Size":13568,"Mallocs":0,"Frees":0},{"Size":14336,"Mallocs":0,"Frees":0},{"Size":16384,"Mallocs":0,"Frees":0},{"Size":18432,"Mallocs":0,"Frees":0}]}, "virtualMemory": {"active": 1957449728, "buffer": 0} }
总结
标准库 expvar 为需要导出的公共变量提供了一个标准化的接口,使用比较简单。
expvar 包内部定义的几种基础类型都相应给出了并发安全的操作方法,我们不需要去重复实现一遍,能够开箱即用。
但是, 在 https://go.dev/ 上统计的公共项目,该库的 import 数量还不足 1万。
相比于其他标准库的 import 数量而言,expvar 的存在感太低了。
以上是使用 expvar 暴露 Go 程序运行指标的详细内容。更多信息请关注PHP中文网其他相关文章!

热AI工具

Undresser.AI Undress
人工智能驱动的应用程序,用于创建逼真的裸体照片

AI Clothes Remover
用于从照片中去除衣服的在线人工智能工具。

Undress AI Tool
免费脱衣服图片

Clothoff.io
AI脱衣机

AI Hentai Generator
免费生成ai无尽的。

热门文章

热工具

记事本++7.3.1
好用且免费的代码编辑器

SublimeText3汉化版
中文版,非常好用

禅工作室 13.0.1
功能强大的PHP集成开发环境

Dreamweaver CS6
视觉化网页开发工具

SublimeText3 Mac版
神级代码编辑软件(SublimeText3)

热门话题

开发中,我们经常会有热开关的需求,即特定功能在程序运行中的适当时候对它进行打开或关闭。例如性能分析中使用的 pprof 采样,就是一种典型的热开关。本文将讨论如何将这种热开关做得更酷。

获取应用程序的运行指标,可以让我们更好地了解它的实际状况。将这些指标对接到 prometheus、zabbix 等监控系统,能够对应用程序持续检测,发现异常可以及时告警并得到处理。

Go是一种受欢迎的编程语言,与其他编程语言相比,Go的编译速度较快,内存消耗较少。但是,有时候我们的Go程序会因为缺少依赖而导致编译失败。那么,为什么会发生这种情况呢?首先,我们需要了解一下Go编译的原理。Go是静态编译型语言,即在编译时就将程序翻译成机器码,然后直接运行。与动态编译型语言相比,Go的编译过程更为复杂,因为在编译之前,需要将所有要使用的包都转

最近,越来越多的人开始使用GoQUIC来构建网络应用。由于其高效的传输性能和可靠性,GoQUIC已经成为许多项目的首选。但是,在实际使用过程中,一些开发者发现他们的Go程序无法正确使用GoQUIC库。下面,我们就来分析一下可能导致Go程序无法正常使用GoQUIC库的原因。1.版本问题首先,你需要确定你的GoQUIC版本是否是最新的。GoQUIC经常更新,如果

在公司的不断发展中,一开始大多是大单体,改造慢了,一个仓库会有使用十几年的情况,仓库的规模基本是不断增大的过程。

Go是一种高效的编程语言,提供了内存管理方面的特殊机制。然而,即使在使用这种语言的时候也有可能出现一些问题,比如“outofmemory”错误。那么,为什么我的Go程序会出现这种错误呢?内存泄漏内存泄漏是一种常见的问题,它在Go语言中同样存在。当你的Go程序分配了大量的内存,并在执行某些操作后没有彻底释放这些内存时,就会出现内存泄漏问题。如果出现内存泄漏

Golang(Go)是一门语言,它非常擅长处理错误和异常情况。与其他语言不同,Go通过简单而有效的错误处理机制来处理异常情况。尽管Go的错误处理机制非常强大和灵活,但某些程序员在程序中实现错误处理时仍会遇到麻烦。这篇文章旨在帮助解决关于为什么Go程序中的异常处理无效的问题,以及如何正确地处理异常情况。在Go中无效的异常处理通常是因为程序员未正确处理错误或者误

在使用Go语言进行开发过程中,难免会遇到各种各样的错误。其中一种常见的错误就是“coredumped”,这个错误消息可能令一些开发者很困惑。本文将讲解这个错误的原因以及如何解决它。“coredumped”的含义在Linux操作系统中,“coredumped”是一种错误消息,它表示一个进程在执行过程中意外退出,并且已经生成了一个所谓的“core”文件。这
