metrics
package
This package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
- Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
- Tagged version
Modules with tagged versions give importers more predictable builds.
- Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Open Source Insights
Documentation¶
Overview¶
Package metrics contains expvar & Prometheus types and code used byTailscale for monitoring.
Index¶
- func CurrentFDs() int
- func LabelString(k any) string
- type Histogram
- type KeyValue
- type LabelMap
- func (m *LabelMap) Add(key string, delta int64)
- func (m *LabelMap) Get(key string) *expvar.Int
- func (m *LabelMap) GetFloat(key string) *expvar.Float
- func (m *LabelMap) GetIncrFunc(key string) func(delta int64)
- func (m *LabelMap) GetShardedInt(key string) *syncs.ShardedInt
- func (m *LabelMap) SetInt64(key string, v int64)
- type MultiLabelMap
- func (v *MultiLabelMap[T]) Add(key T, delta int64)
- func (v *MultiLabelMap[T]) AddFloat(key T, delta float64)
- func (v *MultiLabelMap[T]) Delete(key T)
- func (v *MultiLabelMap[T]) Do(f func(KeyValue[T]))
- func (v *MultiLabelMap[T]) Get(key T) expvar.Var
- func (v *MultiLabelMap[T]) Init() *MultiLabelMap[T]
- func (v *MultiLabelMap[T]) ResetAllForTest()
- func (v *MultiLabelMap[T]) Set(key T, val expvar.Var)
- func (v *MultiLabelMap[T]) SetFloat(key T, val float64)
- func (v *MultiLabelMap[T]) SetInt(key T, val int64)
- func (v *MultiLabelMap[T]) String() string
- func (v *MultiLabelMap[T]) WritePrometheus(w io.Writer, name string)
- type Set
Constants¶
This section is empty.
Variables¶
This section is empty.
Functions¶
funcCurrentFDs¶added inv1.16.0
func CurrentFDs()int
CurrentFDs reports how many file descriptors are currently open.
It only works on Linux. It returns zero otherwise.
funcLabelString¶added inv1.74.0
LabelString returns a Prometheus-formatted label string for the given key.k must be a struct type with scalar fields, as required by MultiLabelMap,if k is not a struct, it will panic.
Types¶
typeHistogram¶added inv1.46.0
type Histogram struct {// contains filtered or unexported fields}Histogram is a histogram of values.It should be created with NewHistogram.
funcNewHistogram¶added inv1.46.0
NewHistogram returns a new histogram that reports to the givenexpvar map under the given name.
The buckets are the boundaries of the histogram buckets, inincreasing order. The last bucket is +Inf.
func (*Histogram)PromExport¶added inv1.46.0
PromExport writes the histogram to w in Prometheus exposition format.
typeKeyValue¶added inv1.64.0
type KeyValue[Tcomparable] struct {Key TValueexpvar.Var}
KeyValue represents a single entry in aMultiLabelMap.
typeLabelMap¶
LabelMap is a string-to-Var map variable that satisfies theexpvar.Var interface.
Semantically, this is mapped by tsweb's Prometheus exporter as acollection of variables with the same name, with a varying labelvalue. Use this to export things that are intuitively breakdownsinto different buckets.
func (*LabelMap)Add¶added inv1.80.0
Add adds delta to the any int-like value stored under the given map key.
func (*LabelMap)Get¶
Get returns a direct pointer to the expvar.Int for key, creating itif necessary.
func (*LabelMap)GetFloat¶added inv1.0.0
GetFloat returns a direct pointer to the expvar.Float for key, creating itif necessary.
func (*LabelMap)GetIncrFunc¶added inv1.46.0
GetIncrFunc returns a function that increments the expvar.Int named by key.
Most callers should not need this; it exists to satisfy aninterface elsewhere.
func (*LabelMap)GetShardedInt¶added inv1.80.0
func (m *LabelMap) GetShardedInt(keystring) *syncs.ShardedInt
GetShardedInt returns a direct pointer to the syncs.ShardedInt for key,creating it if necessary.
typeMultiLabelMap¶added inv1.64.0
type MultiLabelMap[Tcomparable] struct {Typestring// optional Prometheus type ("counter", "gauge")Helpstring// optional Prometheus help string// contains filtered or unexported fields}
MultiLabelMap is a struct-value-to-Var map variable that satisfies theexpvar.Var interface but also allows for multiple Prometheus labels to beassociated with each value.
T must be a struct type with scalar fields. The struct field names(lowercased) are used as the labels, unless a "prom" struct tag is present.The struct fields must all be strings, and the string values must be validPrometheus label values without requiring quoting.
funcNewMultiLabelMap¶added inv1.64.0
func NewMultiLabelMap[Tcomparable](namestring, promType, helpTextstring) *MultiLabelMap[T]
NewMultiLabelMap creates and publishes (via expvar.Publish) a newMultiLabelMap[T] variable with the given name and returns it.
func (*MultiLabelMap[T])Add¶added inv1.64.0
func (v *MultiLabelMap[T]) Add(key T, deltaint64)
Add adds delta to the *expvar.Int value stored under the given map key,creating it if it doesn't exist yet.It does nothing if key exists but is of the wrong type.
func (*MultiLabelMap[T])AddFloat¶added inv1.64.0
func (v *MultiLabelMap[T]) AddFloat(key T, deltafloat64)
Add adds delta to the *expvar.Float value stored under the given map key,creating it if it doesn't exist yet.It does nothing if key exists but is of the wrong type.
func (*MultiLabelMap[T])Delete¶added inv1.64.0
func (v *MultiLabelMap[T]) Delete(key T)
Delete deletes the given key from the map.
This is not optimized for highly concurrent usage; it's presumed to only beused rarely, at startup.
func (*MultiLabelMap[T])Do¶added inv1.64.0
func (v *MultiLabelMap[T]) Do(f func(KeyValue[T]))
Do calls f for each entry in the map.The map is locked during the iteration,but existing entries may be concurrently updated.
func (*MultiLabelMap[T])Get¶added inv1.64.0
func (v *MultiLabelMap[T]) Get(key T)expvar.Var
Get returns the expvar for the given key, or nil if it doesn't exist.
func (*MultiLabelMap[T])Init¶added inv1.64.0
func (v *MultiLabelMap[T]) Init() *MultiLabelMap[T]
Init removes all keys from the map.
Think of it as "Reset", but it's named Init to match expvar.Map.Init.
func (*MultiLabelMap[T])ResetAllForTest¶added inv1.76.0
func (v *MultiLabelMap[T]) ResetAllForTest()
ResetAllForTest resets all values for metrics to zero.Should only be used in tests.
func (*MultiLabelMap[T])Set¶added inv1.64.0
func (v *MultiLabelMap[T]) Set(key T, valexpvar.Var)
Set sets key to val.
This is not optimized for highly concurrent usage; it's presumed to only beused rarely, at startup.
func (*MultiLabelMap[T])SetFloat¶added inv1.74.0
func (v *MultiLabelMap[T]) SetFloat(key T, valfloat64)
SetFloat sets val to the *expvar.Float value stored under the given map key,creating it if it doesn't exist yet.It does nothing if key exists but is of the wrong type.
func (*MultiLabelMap[T])SetInt¶added inv1.74.0
func (v *MultiLabelMap[T]) SetInt(key T, valint64)
SetInt sets val to the *expvar.Int value stored under the given map key,creating it if it doesn't exist yet.It does nothing if key exists but is of the wrong type.
func (*MultiLabelMap[T])String¶added inv1.64.0
func (v *MultiLabelMap[T]) String()string
func (*MultiLabelMap[T])WritePrometheus¶added inv1.64.0
func (v *MultiLabelMap[T]) WritePrometheus(wio.Writer, namestring)
WritePrometheus writes v to w in Prometheus exposition format.The name argument is the metric name.
typeSet¶
Set is a string-to-Var map variable that satisfies the expvar.Varinterface.
Semantically, this is mapped by tsweb's Prometheus exporter as acollection of unrelated variables exported with a common prefix.
This lets us have tsweb recognize *expvar.Map for differentpurposes in the future. (Or perhaps all uses of expvar.Map willrequire explicit types like this one, declaring how we want tswebto export it to Prometheus.)
Source Files