expvar

Documentation

Overview

expvarパッケージは、サーバー内の操作カウンターなどの公開変数に対する標準化されたインターフェースを提供します。 これらの変数は、/debug/varsでJSON形式でHTTP経由で公開されます。

これらの公開変数を設定または変更する操作はアトミックです。

このパッケージはHTTPハンドラを追加するだけでなく、以下の変数も登録します：

cmdline   os.Args
memstats  runtime.Memstats

このパッケージは、HTTPハンドラと上記の変数を登録する副作用のためだけに インポートされることがあります。このように使用するには、 このパッケージをプログラムにリンクします：

import _ "expvar"

Index

• func Do(f func(KeyValue))
• func Handler() http.Handler
• func Publish(name string, v Var)
• type Float
  • func NewFloat(name string) *Float
  • func (v *Float) Add(delta float64)
  • func (v *Float) Set(value float64)
  • func (v *Float) String() string
  • func (v *Float) Value() float64
• type Func
  • func (f Func) String() string
  • func (f Func) Value() any
• type Int
  • func NewInt(name string) *Int
  • func (v *Int) Add(delta int64)
  • func (v *Int) Set(value int64)
  • func (v *Int) String() string
  • func (v *Int) Value() int64
• type KeyValue
• type Map
  • func NewMap(name string) *Map
  • func (v *Map) Add(key string, delta int64)
  • func (v *Map) AddFloat(key string, delta float64)
  • func (v *Map) Delete(key string)
  • func (v *Map) Do(f func(KeyValue))
  • func (v *Map) Get(key string) Var
  • func (v *Map) Init() *Map
  • func (v *Map) Set(key string, av Var)
  • func (v *Map) String() string
• type String
  • func NewString(name string) *String
  • func (v *String) Set(value string)
  • func (v *String) String() string
  • func (v *String) Value() string
• type Var
  • func Get(name string) Var

Functions

func Do

func Do(f func(KeyValue))

Doは、各エクスポートされた変数に対してfを呼び出します。 イテレーション中はグローバル変数マップがロックされますが、 既存のエントリは並行して更新される可能性があります。

func Handler

func Handler() http.Handler

Handlerは、expvarのHTTPハンドラを返します。

これは、ハンドラを非標準の場所にインストールする必要がある場合のみ必要です。

func Publish

func Publish(name string, v Var)

Publishは、名前付きのエクスポート変数を宣言します。これは、パッケージが Varsを作成するときのinit関数から呼び出されるべきです。もし名前がすでに 登録されている場合、これは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は、vにdeltaを加えます。

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インターフェースを満たす文字列から Var へのマップ変数です。

func NewMap

func NewMap(name string) *Map

func (*Map) Add

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

Addは、指定されたマップキーの下に格納された*Int 値にdeltaを加えます。

func (*Map) AddFloat

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

AddFloatは、指定されたマップキーの下に格納された*Float 値にdeltaを加えます。

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() string
}

Varは、すべてのエクスポートされた変数のための抽象型です。

func Get

func Get(name string) Var

Getは、名前付きのエクスポート変数を取得します。名前が 登録されていない場合、nilを返します。