Golang的expvar库如何暴露运行指标 讲解内存统计与自定义指标监控

golang 的 expvar 库可用于暴露程序运行时指标并支持自定义监控。1. 默认指标通过 /debug/vars 路径提供,如内存使用、goroutine 数量等,需启动 http server 访问;2. 可通过 expvar.newint 或 expvar.newstring 添加自定义计数器或字符串变量;3. 指标可通过中间件转换为 prometheus 格式,如使用 expvarmon 或 prometheus/client_golang 中的 expvar_collector;4. 注意路径冲突、版本差异及频繁操作性能影响等问题。

Golang的expvar库如何暴露运行指标 讲解内存统计与自定义指标监控

Golang 的

expvar

库是一个标准库,用于暴露程序运行时的各种指标。它默认提供了一些基本的运行时变量,比如内存使用情况、goroutine 数量等,同时也支持自定义指标。这对于监控服务状态、排查性能问题非常有用。

Golang的expvar库如何暴露运行指标 讲解内存统计与自定义指标监控

下面我们就来看看怎么用

expvar

暴露内存统计信息,以及如何添加自己的监控指标。

Golang的expvar库如何暴露运行指标 讲解内存统计与自定义指标监控


如何查看默认的运行时指标

expvar

默认会在

/debug/vars

路径下暴露一些运行时指标,比如:

立即学习go语言免费学习笔记(深入)”;

  • memstats

    :包括当前内存使用、GC 信息等

  • cmdline

    命令行参数

  • goroutine

    :当前活跃的 goroutine 数量

你可以通过启动一个简单的 HTTP server 来访问这些数据:

Golang的expvar库如何暴露运行指标 讲解内存统计与自定义指标监控

import _ "expvar" import "net/http"  func main() {     go func() {         http.ListenAndServe(":8080", nil)     }()     // 正常业务逻辑... }

然后访问

http://localhost:8080/debug/vars

,你会看到类似如下的 json 数据(部分):

{   "memstats": {     "Alloc": 1234567,     "TotalAlloc": 987654321,     "Sys": 123456789,     ...   },   "goroutine": 12 }

这些数据可以用来做基础监控,比如观察内存增长是否异常,或者 goroutine 是否泄露。


如何添加自定义指标

除了默认的指标,你还可以注册自己的变量,比如计数器、响应时间、请求次数等。

添加一个计数器

import "expvar"  var requestCount = expvar.NewInt("myapp_requests_total")  func handleRequest() {     requestCount.Add(1)     // 处理请求... }

上面这段代码中,我们创建了一个名为

myapp_requests_total

整型变量,并在每次处理请求时加一。这个变量也会自动出现在

/debug/vars

接口里。

添加一个字符串变量

有时候你想记录一些动态配置或状态信息,可以用字符串变量:

var appVersion = expvar.NewString("myapp_version") appVersion.Set("v1.0.0")

这样就可以在接口里看到当前版本号了。


配合 Prometheus 抓取指标

虽然

expvar

提供的是 JSON 格式的数据,但可以通过中间件或者 exporter 转换为 Prometheus 可识别的格式。

如果你不想自己写转换逻辑,可以考虑使用 expvarmon,它能直接读取

expvar

暴露的变量并输出 Prometheus 指标。

当然,也可以用第三方包,比如

prometheus/client_golang

中的

expvar_collector

来集成到你的 Prometheus 抓取流程中。


注意事项与常见坑点

  • 路径冲突:如果你自己注册了
    /debug/vars

    的 handler,可能会和默认的冲突。

  • 并发安全
    expvar

    的变量是线程安全的,可以直接在多个 goroutine 中操作。

  • 字段不全
    memstats

    中有些字段可能在某些 Go 版本中没有,注意版本差异。

  • 性能影响小:一般不会对性能造成明显影响,但如果频繁调用
    .Add()

    或设置字符串,还是要注意控制频率。

基本上就这些。用好

expvar

,可以在不引入额外依赖的前提下快速搭建起服务的基础监控能力。

© 版权声明
THE END
喜欢就支持一下吧
点赞15 分享