使用 expvar 暴露 Go 程序运行指标

什么是 expvar？

expvar 是 Go 语言中的一个包，可以将 Go 程序运行的指标暴露为变量，以供查询和监控。expvar 的使用非常简单，只需导入包并将需要暴露的变量注册即可。

使用方法

导入包

在 Go 语言中使用 expvar 包非常简单，只需使用 import 关键字导入即可：

import "expvar"

注册变量

注册变量需要使用 expvar 包中的函数 expvar.NewXXX 或 expvar.PublishXXX 函数。

NewXXX 还是 PublishXXX

expvar.NewXXX 适用于创建新的 expvar 变量，而 expvar.PublishXXX 适用于将已存在的变量暴露给 expvar。

对于大多数情况，我们只需使用 PublishXXX 函数即可，因为 Go 语言中的大多数变量已经是 expvar 类型的。

变量的类型有哪些

在 expvar 包中，除了常用的 Int、Float 和 String 等类型外，还有新的类型，例如 Map 和 List，我们可以通过这些类型实现更丰富的指标监控。

示例代码

下面是一个简单的示例代码，演示了如何创建新的 expvar 变量并将其暴露给 expvar 包：

import(
    "expvar"
    "time"
)
func main() {
    var (
        numCalls   = expvar.NewInt("num_calls")
        lastAccess = expvar.NewString("last_access")
    )
    for {
        numCalls.Add(1)
        lastAccess.Set(time.Now().Format(time.UnixDate))
        time.Sleep(1 * time.Second)
    }
}

我们在这个示例代码中创建了两个 expvar 变量，numCalls 是一个 int 类型的计数器变量，记录程序被调用的次数。lastAccess 是一个 string 类型的时间戳变量，记录程序最后一次被调用的时间。

在这个示例代码中，我们使用了 time 包中的 time.Now() 函数获取当前时间，使用 time.UnixDate 格式化时间，然后使用 Set() 函数将其设置给变量 lastAccess。最后通过 Add() 函数将 numCalls 计数器加一。

使用 expvar 进行监控

使用 expvar 可以很容易地进行应用程序指标监控。我们可以使用 expvar.Handler() 函数获取所有已经注册的 expvar 变量信息，并将信息以 JSON 格式输出。

下面是一个简单的 Web 应用程序，使用 expvar 进行监控：

import (
    "expvar"
    "net/http"
)
func main() {
    var (
        numCalls = expvar.NewInt("num_calls")
    )
    // 定义处理函数
    http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
        numCalls.Add(1)
        w.Write([]byte("Hello, World!"))
    })
    // 导出 expvar 变量
    http.HandleFunc("/stats", func(w http.ResponseWriter, r *http.Request) {
        expvar.Do(func(kv expvar.KeyValue) {
            w.Write([]byte(kv.Key + ": " + kv.Value.String() + "\n"))
        })
    })
    // 启动服务器
    http.ListenAndServe(":8080", nil)
}

在这个示例代码中，我们定义了一个处理函数，每次处理请求时将 numCalls 计数器加一。然后我们通过将 Do() 函数传给 http.HandleFunc() 函数，将 expvar 变量以文本形式暴露出去，当我们访问 /stats 路径时，就可以查看计数器 numCalls 的值。

结论

expvar 是 Go 语言中非常方便的一个包，可以很轻松地将程序运行指标暴露为可供查询和监控的变量。我们可以使用 expvar 包中提供的一系列函数来创建、注册和导出 expvar 变量，然后使用 expvar.Handler() 函数获取所有已经注册的 expvar 变量和变量信息。

在实际开发中，我们可以根据需求创建各种类型的 expvar 变量，并将其应用于程序监控和调试等场景。