metrics

Documentation

Index

• type HoneycombMetrics
  • func (h *HoneycombMetrics) Gauge(name string, val float64)
  • func (h *HoneycombMetrics) Histogram(name string, obs float64)
  • func (h *HoneycombMetrics) IncrementCounter(name string)
  • func (h *HoneycombMetrics) Register(name string, metricType string)
  • func (h *HoneycombMetrics) Start() error
• type Metrics
  • func GetMetricsImplementation(c config.Config) Metrics
• type MockMetrics
  • func (m *MockMetrics) Gauge(name string, val float64)
  • func (m *MockMetrics) Histogram(name string, obs float64)
  • func (m *MockMetrics) IncrementCounter(name string)
  • func (m *MockMetrics) Register(name string, metricType string)
  • func (m *MockMetrics) Start()
• type NullMetrics
  • func (n *NullMetrics) Gauge(name string, val float64)
  • func (n *NullMetrics) Histogram(name string, obs float64)
  • func (n *NullMetrics) IncrementCounter(name string)
  • func (n *NullMetrics) Register(name string, metricType string)
  • func (n *NullMetrics) Start()
• type PromMetrics
  • func (p *PromMetrics) Gauge(name string, val float64)
  • func (p *PromMetrics) Histogram(name string, obs float64)
  • func (p *PromMetrics) IncrementCounter(name string)
  • func (p *PromMetrics) Register(name string, metricType string)
  • func (p *PromMetrics) Start() error

Types

type HoneycombMetrics

type HoneycombMetrics struct {
	Config            config.Config   `inject:""`
	Logger            logger.Logger   `inject:""`
	UpstreamTransport *http.Transport `inject:"upstreamTransport"`
	Version           string          `inject:"version"`
	// contains filtered or unexported fields
}

func (*HoneycombMetrics) Gauge

func (h *HoneycombMetrics) Gauge(name string, val float64)

func (*HoneycombMetrics) Histogram

func (h *HoneycombMetrics) Histogram(name string, obs float64)

func (*HoneycombMetrics) IncrementCounter

func (h *HoneycombMetrics) IncrementCounter(name string)

func (*HoneycombMetrics) Register

func (h *HoneycombMetrics) Register(name string, metricType string)

func (*HoneycombMetrics) Start

func (h *HoneycombMetrics) Start() error

type Metrics

type Metrics interface {
	// Register declares a metric; metricType should be one of counter, gauge, histogram
	Register(name string, metricType string)
	IncrementCounter(name string)
	Gauge(name string, val float64)
	Histogram(name string, obs float64)
}

func GetMetricsImplementation

func GetMetricsImplementation(c config.Config) Metrics

type MockMetrics

type MockMetrics struct {
	Registrations     map[string]string
	CounterIncrements map[string]int
	GaugeRecords      map[string]float64
	Histograms        map[string][]float64
	// contains filtered or unexported fields
}

MockMetrics collects metrics that were registered and changed to allow tests to verify expected behavior

func (*MockMetrics) Gauge

func (m *MockMetrics) Gauge(name string, val float64)

func (*MockMetrics) Histogram

func (m *MockMetrics) Histogram(name string, obs float64)

func (*MockMetrics) IncrementCounter

func (m *MockMetrics) IncrementCounter(name string)

func (*MockMetrics) Register

func (m *MockMetrics) Register(name string, metricType string)

func (*MockMetrics) Start

func (m *MockMetrics) Start()

Start initializes all metrics or resets all metrics to zero

type NullMetrics

type NullMetrics struct{}

NullMetrics discards all metrics

func (*NullMetrics) Gauge

func (n *NullMetrics) Gauge(name string, val float64)

func (*NullMetrics) Histogram

func (n *NullMetrics) Histogram(name string, obs float64)

func (*NullMetrics) IncrementCounter

func (n *NullMetrics) IncrementCounter(name string)

func (*NullMetrics) Register

func (n *NullMetrics) Register(name string, metricType string)

func (*NullMetrics) Start

func (n *NullMetrics) Start()

Start initializes all metrics or resets all metrics to zero

type PromMetrics

type PromMetrics struct {
	Config config.Config `inject:""`
	Logger logger.Logger `inject:""`
	// contains filtered or unexported fields
}

func (*PromMetrics) Gauge

func (p *PromMetrics) Gauge(name string, val float64)

func (*PromMetrics) Histogram

func (p *PromMetrics) Histogram(name string, obs float64)

func (*PromMetrics) IncrementCounter

func (p *PromMetrics) IncrementCounter(name string)

func (*PromMetrics) Register

func (p *PromMetrics) Register(name string, metricType string)

Register takes a name and a metric type. The type should be one of "counter", "gauge", or "histogram"

func (*PromMetrics) Start

func (p *PromMetrics) Start() error