package expvar

import "expvar"

Package expvar 提供了访问公开变量(例如服务器中的操作计数器)的标准接口。 它以 JSON 格式通过 HTTP 在 /debug/vars 上暴露这些变量。从 Go 1.22 起, 对 /debug/vars 的请求必须使用 GET。

对这些公开变量的设置或修改操作是原子的。

除了添加 HTTP 处理器之外,本包还会注册以下变量:

cmdline   os.Args
memstats  runtime.Memstats

有时导入本包只是为了获得注册其 HTTP 处理器和上述变量的副作用。 若要以这种方式使用它,请将该包链接到你的程序中:

import _ "expvar"

Index

Functions

func Do

func Do(f func(KeyValue))

Do 对每个导出变量调用 f。 迭代期间全局变量映射会被锁定, 但已存在的条目可能会被并发更新。

func Handler

func Handler() http.Handler

Handler 返回 expvar 的 HTTP Handler。

仅在需要将处理器安装到非标准位置时才需要它。

func Publish

func Publish(name string, v Var)

Publish 声明一个具名的导出变量。应当在包的 init 函数中创建其 Var 时调用。若该名称已被注册,则会触发 log.Panic。

Types

type Float

type Float struct {
	// contains filtered or unexported fields
}

Float 是一个满足 Var 接口的 64 位浮点数变量。

func NewFloat
func NewFloat(name string) *Float
func (*Float) Add
func (v *Float) Add(delta float64)

Add 将 delta 加到 v 上。

func (*Float) Set
func (v *Float) Set(value float64)

Set 将 v 设置为 value。

func (*Float) String
func (v *Float) String() string
func (*Float) Value
func (v *Float) Value() float64

type Func

type Func func() any

Func 通过调用该函数并使用 JSON 格式化其返回值 来实现 Var。

func (Func) String
func (f Func) String() string
func (Func) Value
func (f Func) Value() any

type Int

type Int struct {
	// contains filtered or unexported fields
}

Int 是一个满足 Var 接口的 64 位整数变量。

func NewInt
func NewInt(name string) *Int
func (*Int) Add
func (v *Int) Add(delta int64)
func (*Int) Set
func (v *Int) Set(value int64)
func (*Int) String
func (v *Int) String() string
func (*Int) Value
func (v *Int) Value() int64

type KeyValue

type KeyValue struct {
	Key   string
	Value Var
}

KeyValue 表示 Map 中的单个条目。

type Map

type Map struct {
	// contains filtered or unexported fields
}

Map 是一个满足 Var 接口的 string 到 Var 的映射变量。

func NewMap
func NewMap(name string) *Map
func (*Map) Add
func (v *Map) Add(key string, delta int64)

Add 将 delta 加到存储在给定映射键下的 *Int 值上。

func (*Map) AddFloat
func (v *Map) AddFloat(key string, delta float64)

AddFloat 将 delta 加到存储在给定映射键下的 *Float 值上。

func (*Map) Delete
func (v *Map) Delete(key string)

Delete 从映射中删除给定的键。

func (*Map) Do
func (v *Map) Do(f func(KeyValue))

Do 对映射中的每个条目调用 f。 迭代期间映射会被锁定, 但已存在的条目可能会被并发更新。

func (*Map) Get
func (v *Map) Get(key string) Var
func (*Map) Init
func (v *Map) Init() *Map

Init 移除映射中的所有键。

func (*Map) Set
func (v *Map) Set(key string, av Var)
func (*Map) String
func (v *Map) String() string

type String

type String struct {
	// contains filtered or unexported fields
}

String 是一个字符串变量,并且满足 Var 接口。

func NewString
func NewString(name string) *String
func (*String) Set
func (v *String) Set(value string)
func (*String) String
func (v *String) String() string

String 实现 Var 接口。若要获取未加引号的字符串, 请使用 String.Value。

func (*String) Value
func (v *String) Value() string

type Var

type Var interface {
	// String 返回该变量的合法 JSON 值。
	// String 方法不返回合法 JSON 的类型
	// (例如 time.Time)不得用作 Var。
	String() string
}

Var 是所有导出变量的抽象类型。

func Get
func Get(name string) Var

Get 获取一个具名的导出变量。若该名称尚未注册, 则返回 nil。