expvar

4 分钟阅读

原文：https://pkg.go.dev/expvar@go1.23.0

Package expvar provides a standardized interface to public variables, such as operation counters in servers. It exposes these variables via HTTP at /debug/vars in JSON format. As of Go 1.22, the /debug/vars request must use GET.

expvar 包提供了一个标准化的接口，用于公开变量，如服务器中的操作计数器。它通过 HTTP 在 /debug/vars 以 JSON 格式公开这些变量。从 Go 1.22 开始，/debug/vars 请求必须使用 GET 方法。

Operations to set or modify these public variables are atomic.

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

In addition to adding the HTTP handler, this package registers the following variables:

除了添加HTTP处理程序外，这个包还注册了以下变量：

cmdline   os.Args
memstats  runtime.Memstats

The package is sometimes only imported for the side effect of registering its HTTP handler and the above variables. To use it this way, link this package into your program:

这个包有时被导入只是为了注册其HTTP处理程序和上述变量的副作用。要以这种方式使用它，请将这个包链接到您的程序中：

import _ "expvar"

常量

This section is empty.

变量

This section is empty.

函数

func Do

1
func Do(f func(KeyValue))

Do calls f for each exported variable. The global variable map is locked during the iteration, but existing entries may be concurrently updated.

Do为每个导出的变量调用f。在迭代过程中，全局变量图被锁定，但现有的条目可以被同时更新。

func Handler <- go1.8

1
func Handler() http.Handler

Handler returns the expvar HTTP Handler.

Handler返回expvar HTTP Handler。

This is only needed to install the handler in a non-standard location.

只有在将处理程序安装在非标准位置时才需要这样做。

func Publish

1
func Publish(name string, v Var)

Publish declares a named exported variable. This should be called from a package’s init function when it creates its Vars. If the name is already registered then this will log.Panic.

Publish 声明了一个命名的导出变量。这应该从包的init函数中调用，当它创建其Vars时。如果名字已经被注册了，那么这将导致log.Panic。

类型

type Float

1
2
3
type Float struct {
	// contains filtered or unexported fields
}

Float is a 64-bit float variable that satisfies the Var interface.

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

func NewFloat

1
func NewFloat(name string) *Float

(*Float) Add

1
func (v *Float) Add(delta float64)

Add adds delta to v.

Add将delta添加到v中。

(*Float) Set

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

Set sets v to value.

Set 将v设置为值。

(*Float) String

1
func (v *Float) String() string

(*Float) Value <- go1.8

1
func (v *Float) Value() float64

type Func

1
type Func func() any

Func implements Var by calling the function and formatting the returned value using JSON.

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

(Func) String

1
func (f Func) String() string

(Func) Value <- go1.8

1
func (f Func) Value() any

type Int

1
2
3
type Int struct {
	// contains filtered or unexported fields
}

Int is a 64-bit integer variable that satisfies the Var interface.

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

func NewInt

1
func NewInt(name string) *Int

(*Int) Add

1
func (v *Int) Add(delta int64)

(*Int) Set

1
func (v *Int) Set(value int64)

(*Int) String

1
func (v *Int) String() string

(*Int) Value <- go1.8

1
func (v *Int) Value() int64

type KeyValue

1
2
3
4
type KeyValue struct {
	Key   string
	Value Var
}

KeyValue represents a single entry in a Map.

KeyValue代表了一个Map中的一个条目。

type Map

1
2
3
type Map struct {
	// contains filtered or unexported fields
}

Map is a string-to-Var map variable that satisfies the Var interface.

Map是一个满足Var接口的字符串到Var的map变量。

func NewMap

1
func NewMap(name string) *Map

(*Map) Add

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

Add adds delta to the *Int value stored under the given map key.

Add将delta添加到存储在给定map键下的*Int值中。

(*Map) AddFloat

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

AddFloat adds delta to the *Float value stored under the given map key.

AddFloat将delta添加到存储在给定map键下的*Float值。

(*Map) Delete <- go1.12

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

Delete deletes the given key from the map.

Delete 将给定的键从map上删除。

(*Map) Do

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

Do calls f for each entry in the map. The map is locked during the iteration, but existing entries may be concurrently updated.

Do为map中的每个条目调用f。在迭代过程中，map被锁定，但现有的条目可能被同时更新。

(*Map) Get

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

(*Map) Init

1
func (v *Map) Init() *Map

Init removes all keys from the map.

Init会从map上删除所有的键。

(*Map) Set

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

(*Map) String

1
func (v *Map) String() string

type String

1
2
3
type String struct {
	// contains filtered or unexported fields
}

String is a string variable, and satisfies the Var interface.

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

func NewString

1
func NewString(name string) *String

(*String) Set

1
func (v *String) Set(value string)

(*String) String

1
func (v *String) String() string

String implements the Var interface. To get the unquoted string use Value.

String实现了Var接口。要获得未引用的字符串请使用Value。

(*String) Value <- go1.8

1
func (v *String) Value() string

type Var

1
2
3
4
5
6
7
8
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为变量返回一个有效的JSON值。
	// 具有String方法的类型如果不返回有效的JSON值(如time.Time)，则不能作为Var使用。
	String() string
}

Var is an abstract type for all exported variables.

Var是一个抽象类型，用于所有导出的变量。

func Get

1
func Get(name string) Var

Get retrieves a named exported variable. It returns nil if the name has not been registered.

Get 检索一个命名的导出变量。如果这个名字没有被注册，它将返回nil。

最后修改 October 10, 2024: 更新 (a4b8f85)