stats

Documentation

Overview

package stats provides a set of interfaces to log stats including a no-op implementation that doesn't do anything. This is useful to instrument metrics within open-sourced components.

Index

• type CounterStat
• type GaugeStat
• type StatsFactory
  • func NewCompositeFactory(factories ...StatsFactory) StatsFactory
• type SummaryStat

Types

type CounterStat

type CounterStat interface {
	Inc()
	Add(float64)
}

type GaugeStat

type GaugeStat interface {
	Set(float64)
	Get() float64

	Inc()
	Add(float64)

	Dec()
	Sub(float64)
}

type StatsFactory

type StatsFactory interface {
	NewCounter(
		metric string,
		tags map[string]string) CounterStat

	NewGauge(
		metric string,
		tags map[string]string) GaugeStat

	NewSummary(
		metric string,
		tags map[string]string) SummaryStat
}

var (
	NoOpStatsFactory StatsFactory
)

func NewCompositeFactory

func NewCompositeFactory(factories ...StatsFactory) StatsFactory

type SummaryStat

type SummaryStat interface {
	Observe(float64)
}