stats

Documentation

Index

• Constants
• Variables
• type Counter
• type Gauge
• type GoRoutineFactory
• type Histogram
• type Measurement
• type Option
  • func WithDefaultHistogramBuckets(buckets []float64) Option
  • func WithHistogramBuckets(histogramName string, buckets []float64) Option
  • func WithPrometheusRegistry(registerer prometheus.Registerer, gatherer prometheus.Gatherer) Option
  • func WithServiceName(name string) Option
  • func WithServiceVersion(version string) Option
• 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"
)

Variables

var DefaultGoRoutineFactory = defaultGoRoutineFactory{}

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 GoRoutineFactory

type GoRoutineFactory interface {
	Go(function func())
}

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 Option

type Option func(*statsConfig)

Option is a function used to configure the stats service.

func WithDefaultHistogramBuckets

func WithDefaultHistogramBuckets(buckets []float64) Option

WithDefaultHistogramBuckets sets the histogram buckets for the stats service.

func WithHistogramBuckets

func WithHistogramBuckets(histogramName string, buckets []float64) Option

WithHistogramBuckets sets the histogram buckets for a measurement.

func WithPrometheusRegistry

func WithPrometheusRegistry(registerer prometheus.Registerer, gatherer prometheus.Gatherer) Option

WithPrometheusRegistry sets the prometheus registerer and gatherer for the stats service. If nil is passed the default ones will be used.

func WithServiceName

func WithServiceName(name string) Option

WithServiceName sets the service name for the stats service.

func WithServiceVersion

func WithServiceVersion(version string) Option

WithServiceVersion sets the service version for the stats service.

type Stats

type Stats interface {
	// NewStat creates a new Measurement with provided Name and Type
	NewStat(name, statType string) (m Measurement)

	// NewTaggedStat creates a new Measurement with provided Name, Type and Tags
	NewTaggedStat(name, statType string, tags Tags) Measurement

	// NewSampledTaggedStat creates a new Measurement with provided Name, Type and Tags
	// Deprecated: use NewTaggedStat instead
	NewSampledTaggedStat(name, statType string, tags Tags) Measurement

	// Start starts the stats service and the collection of periodic stats.
	Start(ctx context.Context, goFactory GoRoutineFactory) error

	// Stop stops the service and the 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 svcMetric.Manager, opts ...Option,
) 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