metrics

package
v1.18.1-qos Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 26, 2025 License: BSD-3-Clause Imports: 0 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var Enabled bool

Enabled tracks whether metrics collection is enabled

Functions

This section is empty.

Types

type Counter 

type Counter interface {
	Inc(int64)
	Dec(int64)
	Clear()
	Count() int64
	Snapshot() Counter
}

Counter is a monotonically increasing counter

type CounterFloat64 

type CounterFloat64 interface {
	Inc(float64)
	Dec(float64)
	Clear()
	Count() float64
	Snapshot() CounterFloat64
}

CounterFloat64 is a float64 counter

type EWMA 

type EWMA interface {
	Rate() float64
	Update(int64)
	Tick()
	Snapshot() EWMA
}

EWMA is an exponentially weighted moving average

type Gauge 

type Gauge interface {
	Update(int64)
	Value() int64
	Snapshot() Gauge
}

Gauge holds an int64 value

type GaugeFloat64 

type GaugeFloat64 interface {
	Update(float64)
	Value() float64
	Snapshot() GaugeFloat64
}

GaugeFloat64 holds a float64 value

type GaugeInfo 

type GaugeInfo interface {
	Update(GaugeInfoValue)
	Value() GaugeInfoValue
	Snapshot() GaugeInfo
}

GaugeInfo holds string information

type GaugeInfoValue 

type GaugeInfoValue map[string]string

GaugeInfoValue represents gauge info

type Healthcheck 

type Healthcheck interface {
	Check()
	Error() error
	Healthy()
	Unhealthy(error)
}

Healthcheck tracks health status

type Histogram 

type Histogram interface {
	Update(int64)
	Count() int64
	Max() int64
	Mean() float64
	Min() int64
	Percentile(float64) float64
	Percentiles([]float64) []float64
	StdDev() float64
	Sum() int64
	Variance() float64
	Snapshot() Histogram
	Clear()
}

Histogram tracks the distribution of values

type Meter 

type Meter interface {
	Mark(int64)
	Count() int64
	Rate1() float64
	Rate5() float64
	Rate15() float64
	RateMean() float64
	Snapshot() Meter
	Stop()
}

Meter measures the rate of events

type NilCounter 

type NilCounter struct{}

Nil implementations for when metrics are disabled

func (NilCounter) Clear 

func (NilCounter) Clear()

func (NilCounter) Count 

func (NilCounter) Count() int64

func (NilCounter) Dec 

func (NilCounter) Dec(int64)

func (NilCounter) Inc 

func (NilCounter) Inc(int64)

NilCounter implementation

func (NilCounter) Snapshot 

func (n NilCounter) Snapshot() Counter

type NilCounterFloat64 

type NilCounterFloat64 struct{}

Nil implementations for when metrics are disabled

func (NilCounterFloat64) Clear 

func (NilCounterFloat64) Clear()

func (NilCounterFloat64) Count 

func (NilCounterFloat64) Count() float64

func (NilCounterFloat64) Dec 

func (NilCounterFloat64) Dec(float64)

func (NilCounterFloat64) Inc 

func (NilCounterFloat64) Inc(float64)

NilCounterFloat64 implementation

func (NilCounterFloat64) Snapshot 

func (n NilCounterFloat64) Snapshot() CounterFloat64

type NilEWMA 

type NilEWMA struct{}

Nil implementations for when metrics are disabled

func (NilEWMA) Rate 

func (NilEWMA) Rate() float64

NilEWMA implementation

func (NilEWMA) Snapshot 

func (n NilEWMA) Snapshot() EWMA

func (NilEWMA) Tick 

func (NilEWMA) Tick()

func (NilEWMA) Update 

func (NilEWMA) Update(int64)

type NilGauge 

type NilGauge struct{}

Nil implementations for when metrics are disabled

func (NilGauge) Snapshot 

func (n NilGauge) Snapshot() Gauge

func (NilGauge) Update 

func (NilGauge) Update(int64)

NilGauge implementation

func (NilGauge) Value 

func (NilGauge) Value() int64

type NilGaugeFloat64 

type NilGaugeFloat64 struct{}

Nil implementations for when metrics are disabled

func (NilGaugeFloat64) Snapshot 

func (n NilGaugeFloat64) Snapshot() GaugeFloat64

func (NilGaugeFloat64) Update 

func (NilGaugeFloat64) Update(float64)

NilGaugeFloat64 implementation

func (NilGaugeFloat64) Value 

func (NilGaugeFloat64) Value() float64

type NilGaugeInfo 

type NilGaugeInfo struct{}

Nil implementations for when metrics are disabled

func (NilGaugeInfo) Snapshot 

func (n NilGaugeInfo) Snapshot() GaugeInfo

func (NilGaugeInfo) Update 

func (NilGaugeInfo) Update(GaugeInfoValue)

NilGaugeInfo implementation

func (NilGaugeInfo) Value 

func (NilGaugeInfo) Value() GaugeInfoValue

type NilHealthcheck 

type NilHealthcheck struct{}

Nil implementations for when metrics are disabled

func (NilHealthcheck) Check 

func (NilHealthcheck) Check()

NilHealthcheck implementation

func (NilHealthcheck) Error 

func (NilHealthcheck) Error() error

func (NilHealthcheck) Healthy 

func (NilHealthcheck) Healthy()

func (NilHealthcheck) Unhealthy 

func (NilHealthcheck) Unhealthy(error)

type NilHistogram 

type NilHistogram struct{}

Nil implementations for when metrics are disabled

func (NilHistogram) Clear 

func (NilHistogram) Clear()

func (NilHistogram) Count 

func (NilHistogram) Count() int64

func (NilHistogram) Max 

func (NilHistogram) Max() int64

func (NilHistogram) Mean 

func (NilHistogram) Mean() float64

func (NilHistogram) Min 

func (NilHistogram) Min() int64

func (NilHistogram) Percentile 

func (NilHistogram) Percentile(float64) float64

func (NilHistogram) Percentiles 

func (NilHistogram) Percentiles([]float64) []float64

func (NilHistogram) Snapshot 

func (n NilHistogram) Snapshot() Histogram

func (NilHistogram) StdDev 

func (NilHistogram) StdDev() float64

func (NilHistogram) Sum 

func (NilHistogram) Sum() int64

func (NilHistogram) Update 

func (NilHistogram) Update(int64)

NilHistogram implementation

func (NilHistogram) Variance 

func (NilHistogram) Variance() float64

type NilMeter 

type NilMeter struct{}

Nil implementations for when metrics are disabled

func (NilMeter) Count 

func (NilMeter) Count() int64

func (NilMeter) Mark 

func (NilMeter) Mark(int64)

NilMeter implementation

func (NilMeter) Rate1 

func (NilMeter) Rate1() float64

func (NilMeter) Rate15 

func (NilMeter) Rate15() float64

func (NilMeter) Rate5 

func (NilMeter) Rate5() float64

func (NilMeter) RateMean 

func (NilMeter) RateMean() float64

func (NilMeter) Snapshot 

func (n NilMeter) Snapshot() Meter

func (NilMeter) Stop 

func (NilMeter) Stop()

type NilResettingTimer 

type NilResettingTimer struct{}

Nil implementations for when metrics are disabled

func (NilResettingTimer) Count 

func (NilResettingTimer) Count() int64

func (NilResettingTimer) Mean 

func (NilResettingTimer) Mean() float64

func (NilResettingTimer) Percentiles 

func (NilResettingTimer) Percentiles([]float64) []float64

func (NilResettingTimer) Snapshot 

func (n NilResettingTimer) Snapshot() ResettingTimer

func (NilResettingTimer) Time 

func (NilResettingTimer) Time(func())

NilResettingTimer implementation

func (NilResettingTimer) Update 

func (NilResettingTimer) Update(int64)

func (NilResettingTimer) UpdateSince 

func (NilResettingTimer) UpdateSince(int64)

func (NilResettingTimer) Values 

func (NilResettingTimer) Values() []int64

type NilSample 

type NilSample struct{}

Nil implementations for when metrics are disabled

func (NilSample) Clear 

func (NilSample) Clear()

NilSample implementation

func (NilSample) Count 

func (NilSample) Count() int64

func (NilSample) Max 

func (NilSample) Max() int64

func (NilSample) Mean 

func (NilSample) Mean() float64

func (NilSample) Min 

func (NilSample) Min() int64

func (NilSample) Percentile 

func (NilSample) Percentile(float64) float64

func (NilSample) Percentiles 

func (NilSample) Percentiles([]float64) []float64

func (NilSample) Size 

func (NilSample) Size() int

func (NilSample) Snapshot 

func (n NilSample) Snapshot() Sample

func (NilSample) StdDev 

func (NilSample) StdDev() float64

func (NilSample) Sum 

func (NilSample) Sum() int64

func (NilSample) Update 

func (NilSample) Update(int64)

func (NilSample) Values 

func (NilSample) Values() []int64

func (NilSample) Variance 

func (NilSample) Variance() float64

type NilTimer 

type NilTimer struct{}

Nil implementations for when metrics are disabled

func (NilTimer) Count 

func (NilTimer) Count() int64

func (NilTimer) Max 

func (NilTimer) Max() int64

func (NilTimer) Mean 

func (NilTimer) Mean() float64

func (NilTimer) Min 

func (NilTimer) Min() int64

func (NilTimer) Percentile 

func (NilTimer) Percentile(float64) float64

func (NilTimer) Percentiles 

func (NilTimer) Percentiles([]float64) []float64

func (NilTimer) Rate1 

func (NilTimer) Rate1() float64

func (NilTimer) Rate15 

func (NilTimer) Rate15() float64

func (NilTimer) Rate5 

func (NilTimer) Rate5() float64

func (NilTimer) RateMean 

func (NilTimer) RateMean() float64

func (NilTimer) Snapshot 

func (n NilTimer) Snapshot() Timer

func (NilTimer) StdDev 

func (NilTimer) StdDev() float64

func (NilTimer) Stop 

func (NilTimer) Stop()

func (NilTimer) Sum 

func (NilTimer) Sum() int64

func (NilTimer) Time 

func (NilTimer) Time(func())

NilTimer implementation

func (NilTimer) Update 

func (NilTimer) Update(int64)

func (NilTimer) UpdateSince 

func (NilTimer) UpdateSince(int64)

func (NilTimer) Variance 

func (NilTimer) Variance() float64

type ResettingTimer 

type ResettingTimer interface {
	Time(func())
	Update(int64)
	UpdateSince(int64)
	Values() []int64
	Snapshot() ResettingTimer
	Percentiles([]float64) []float64
	Count() int64
	Mean() float64
}

ResettingTimer is a timer that resets

type Sample 

type Sample interface {
	Clear()
	Count() int64
	Max() int64
	Mean() float64
	Min() int64
	Percentile(float64) float64
	Percentiles([]float64) []float64
	Size() int
	Snapshot() Sample
	StdDev() float64
	Sum() int64
	Update(int64)
	Values() []int64
	Variance() float64
}

Sample represents a sample

type Timer 

type Timer interface {
	Time(func())
	Update(int64)
	UpdateSince(int64)
	Count() int64
	Max() int64
	Mean() float64
	Min() int64
	Percentile(float64) float64
	Percentiles([]float64) []float64
	Rate1() float64
	Rate5() float64
	Rate15() float64
	RateMean() float64
	StdDev() float64
	Sum() int64
	Variance() float64
	Snapshot() Timer
	Stop()
}

Timer measures durations

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.