metricstest

Documentation

Index

• Variables
• type Capture
  • func (c *Capture) Snapshot() map[string][]*CapturedRecording
• type CaptureHandler
  • func NewCaptureHandler() *CaptureHandler
  • func (c *CaptureHandler) Counter(name string) metrics.CounterIface
  • func (c *CaptureHandler) Gauge(name string) metrics.GaugeIface
  • func (c *CaptureHandler) Histogram(name string, unit metrics.MetricUnit) metrics.HistogramIface
  • func (c *CaptureHandler) StartCapture() *Capture
  • func (*CaptureHandler) Stop(log.Logger)
  • func (c *CaptureHandler) StopCapture(capture *Capture)
  • func (c *CaptureHandler) Timer(name string) metrics.TimerIface
  • func (c *CaptureHandler) WithTags(tags ...metrics.Tag) metrics.Handler
• type CapturedRecording
• type Handler
  • func NewHandler(logger log.Logger, clientConfig metrics.ClientConfig) (*Handler, error)
  • func (h *Handler) Snapshot() (Snapshot, error)
  • func (*Handler) Stop(log.Logger)
• type HistogramBucket
• type Snapshot
  • func (s Snapshot) Counter(name string, tags ...metrics.Tag) (float64, error)
  • func (s Snapshot) Gauge(name string, tags ...metrics.Tag) (float64, error)
  • func (s Snapshot) Histogram(name string, tags ...metrics.Tag) ([]HistogramBucket, error)
  • func (s Snapshot) String() string

Variables

var (
	ErrMetricNotFound      = errors.New("metric not found")
	ErrMetricTypeMismatch  = errors.New("metric is not the expected type")
	ErrMetricLabelMismatch = errors.New("metric labels do not match expected labels")
)

Potential errors that the test handler can return trying to find a metric to return.

Types

type Capture

type Capture struct {
	// contains filtered or unexported fields
}

Capture is a specific capture instance.

func (*Capture) Snapshot

func (c *Capture) Snapshot() map[string][]*CapturedRecording

Snapshot returns a copy of all metrics recorded, keyed by name.

type CaptureHandler

type CaptureHandler struct {
	// contains filtered or unexported fields
}

CaptureHandler is a metrics.Handler that captures each metric recording.

func NewCaptureHandler

func NewCaptureHandler() *CaptureHandler

NewCaptureHandler creates a new metrics.Handler that captures.

func (*CaptureHandler) Counter

func (c *CaptureHandler) Counter(name string) metrics.CounterIface

Counter implements metrics.Handler.Counter.

func (*CaptureHandler) Gauge

func (c *CaptureHandler) Gauge(name string) metrics.GaugeIface

Gauge implements metrics.Handler.Gauge.

func (*CaptureHandler) Histogram

func (c *CaptureHandler) Histogram(name string, unit metrics.MetricUnit) metrics.HistogramIface

Histogram implements metrics.Handler.Histogram.

func (*CaptureHandler) StartCapture

func (c *CaptureHandler) StartCapture() *Capture

StartCapture returns a started capture. StopCapture should be called on complete.

func (*CaptureHandler) Stop

func (*CaptureHandler) Stop(log.Logger)

Stop implements metrics.Handler.Stop.

func (*CaptureHandler) StopCapture

func (c *CaptureHandler) StopCapture(capture *Capture)

StopCapture stops capturing metrics for the given capture instance.

func (*CaptureHandler) Timer

func (c *CaptureHandler) Timer(name string) metrics.TimerIface

Timer implements metrics.Handler.Timer.

func (*CaptureHandler) WithTags

func (c *CaptureHandler) WithTags(tags ...metrics.Tag) metrics.Handler

WithTags implements metrics.Handler.WithTags.

type CapturedRecording

type CapturedRecording struct {
	Value any
	Tags  map[string]string
	Unit  metrics.MetricUnit
}

CapturedRecording is a single recording. Fields here should not be mutated.

type Handler

type Handler struct {
	metrics.Handler
	// contains filtered or unexported fields
}

func NewHandler

func NewHandler(logger log.Logger, clientConfig metrics.ClientConfig) (*Handler, error)

func (*Handler) Snapshot

func (h *Handler) Snapshot() (Snapshot, error)

func (*Handler) Stop

func (*Handler) Stop(log.Logger)

type HistogramBucket

type HistogramBucket struct {
	// contains filtered or unexported fields
}

type Snapshot

type Snapshot struct {
	// contains filtered or unexported fields
}

func (Snapshot) Counter

func (s Snapshot) Counter(name string, tags ...metrics.Tag) (float64, error)

func (Snapshot) Gauge

func (s Snapshot) Gauge(name string, tags ...metrics.Tag) (float64, error)

func (Snapshot) Histogram

func (s Snapshot) Histogram(name string, tags ...metrics.Tag) ([]HistogramBucket, error)

func (Snapshot) String

func (s Snapshot) String() string