stats

Documentation

Index

• Constants
• type Counter
• type Gauge
• type Histogram
• type Measurement
• type Stats
  • func NewStats(config *config.Config, loggerFactory *logger.Factory, ...) Stats
• type Tags
  • func (t Tags) String() string
  • func (t Tags) Strings() []string
• type Timer

Constants

const (
	CountType     = "count"
	TimerType     = "timer"
	GaugeType     = "gauge"
	HistogramType = "histogram"
)

Types

type Counter

type Counter interface {
	Count(n int)
	Increment()
}

Counter represents a counter metric

type Gauge

type Gauge interface {
	Gauge(value interface{})
}

Gauge represents a gauge metric

type Histogram

type Histogram interface {
	Observe(value float64)
}

Histogram represents a histogram metric

type Measurement

type Measurement interface {
	Counter
	Gauge
	Histogram
	Timer
}

Measurement provides all stat measurement functions TODO: the API should not return a union of measurement methods, but rather a distinct type for each measurement type

type Stats

type Stats interface {
	// NewStat creates an untagged measurement
	NewStat(name, statType string) (m Measurement)

	// NewTaggedStat creates a tagged measurement with a sampling rate of 1.0
	NewTaggedStat(name, statType string, tags Tags) Measurement

	// NewSampledTaggedStat creates a tagged measurement with the configured sampling rate (statsSamplingRate)
	NewSampledTaggedStat(name, statType string, tags Tags) Measurement

	// Start starts the stats service. It tries to connect to statsd server once and returns immediately.
	// If it fails to connect, it will retry in the background indefinitely, however any stats published in the meantime will be lost.
	Start(ctx context.Context)

	// Stop stops the service and collection of periodic stats.
	Stop()
}

Stats manages stat Measurements

var Default Stats

Default is the default (singleton) Stats instance

func NewStats

func NewStats(config *config.Config, loggerFactory *logger.Factory, metricManager metric.Manager) Stats

NewStats create a new Stats instance using the provided config, logger factory and metric manager as dependencies

type Tags

type Tags map[string]string

Tags is a map of key value pairs

func (Tags) String

func (t Tags) String() string

String returns all key value pairs as a single string, separated by commas, sorted by increasing key order

func (Tags) Strings

func (t Tags) Strings() []string

Strings returns all key value pairs as an ordered list of strings, sorted by increasing key order

type Timer

type Timer interface {
	SendTiming(duration time.Duration)
	Since(start time.Time)
	RecordDuration() func()
}

Timer represents a timer metric