testmetrics

Documentation

Overview

Package testmetrics is for testing provider metrics with a test Provider that adheres to the Provider interface

Index

• type CardinalityCounter
  • func (c *CardinalityCounter) Estimate() uint64
  • func (c *CardinalityCounter) Insert(i []byte)
  • func (c *CardinalityCounter) With(labelValues ...string) xmetrics.CardinalityCounter
• type Counter
  • func (c *Counter) Add(delta float64)
  • func (c *Counter) With(labelValues ...string) metrics.Counter
• type Gauge
  • func (g *Gauge) Add(delta float64)
  • func (g *Gauge) Set(v float64)
  • func (g *Gauge) With(labelValues ...string) metrics.Gauge
• type Histogram
  • func (h *Histogram) Observe(v float64)
  • func (h *Histogram) With(labelValues ...string) metrics.Histogram
• type Provider
  • func NewProvider(t *testing.T) *Provider
  • func (p *Provider) CheckCardinalityCounter(name string, estimate uint64, labelValues ...string)
  • func (p *Provider) CheckCounter(name string, v float64, labelValues ...string)
  • func (p *Provider) CheckCounterExists(name string, labelValues ...string)
  • func (p *Provider) CheckGauge(name string, v float64, labelValues ...string)
  • func (p *Provider) CheckGaugeNonZero(name string, labelValues ...string)
  • func (p *Provider) CheckNoCounter(name string, labelValues ...string)
  • func (p *Provider) CheckNoGauge(name string, labelValues ...string)
  • func (p *Provider) CheckObservationCount(name string, n int, labelValues ...string)
  • func (p *Provider) CheckObservations(name string, obs []float64, labelValues ...string)
  • func (p *Provider) CheckObservationsMatch(name string, obs []float64, labelValues ...string)
  • func (p *Provider) CheckObservationsMinMax(name string, min, max float64, labelValues ...string)
  • func (p *Provider) CheckStopped()
  • func (p *Provider) Flush() error
  • func (p *Provider) NewCardinalityCounter(name string) xmetrics.CardinalityCounter
  • func (p *Provider) NewCounter(name string) metrics.Counter
  • func (p *Provider) NewExplicitHistogram(name string, _ xmetrics.DistributionFunc) metrics.Histogram
  • func (p *Provider) NewGauge(name string) metrics.Gauge
  • func (p *Provider) NewHistogram(name string, _ int) metrics.Histogram
  • func (p *Provider) PrintCounterValue(name string)
  • func (p *Provider) Stop()

Types

type CardinalityCounter

type CardinalityCounter struct {
	Name string

	sync.RWMutex
	// contains filtered or unexported fields
}

CardinalityCounter provides a wrapper around a HyperLogLog probabalistic counter. It implements CardinalityCounter Interface.

func (*CardinalityCounter) Estimate

func (c *CardinalityCounter) Estimate() uint64

func (*CardinalityCounter) Insert

func (c *CardinalityCounter) Insert(i []byte)

Insert adds the item to the set to be counted.

func (*CardinalityCounter) With

func (c *CardinalityCounter) With(labelValues ...string) xmetrics.CardinalityCounter

With implements xmetrics.CardinalityCounter interface. It returns a CardinalityCounter based on the labelValues.

type Counter

type Counter struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Counter accumulates a value based on Add calls.

func (*Counter) Add

func (c *Counter) Add(delta float64)

Add implements the metrics.Counter interface.

func (*Counter) With

func (c *Counter) With(labelValues ...string) metrics.Counter

With implements the metrics.Counter interface.

type Gauge

type Gauge struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Gauge stores a value based on Add/Set calls.

func (*Gauge) Add

func (g *Gauge) Add(delta float64)

Add implements the metrics.Gauge interface.

func (*Gauge) Set

func (g *Gauge) Set(v float64)

Set implements the metrics.Gauge interface.

func (*Gauge) With

func (g *Gauge) With(labelValues ...string) metrics.Gauge

With implements the metrics.Gauge interface.

type Histogram

type Histogram struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Histogram collects observations without computing quantiles so the observations can be checked by tests.

func (*Histogram) Observe

func (h *Histogram) Observe(v float64)

Observe implements the metrics.Histogram interface.

func (*Histogram) With

func (h *Histogram) With(labelValues ...string) metrics.Histogram

With implements the metrics.Histogram interface.

type Provider

type Provider struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Provider collects registered metrics for testing.

func NewProvider

func NewProvider(t *testing.T) *Provider

NewProvider constructs a test provider which can later be checked.

func (*Provider) CheckCardinalityCounter

func (p *Provider) CheckCardinalityCounter(name string, estimate uint64, labelValues ...string)

CheckCardinalityCounter checks that there is a registered cardinality counter with the name and estimate provided.

func (*Provider) CheckCounter

func (p *Provider) CheckCounter(name string, v float64, labelValues ...string)

CheckCounter checks that there is a registered counter with the name and value provided.

func (*Provider) CheckCounterExists

func (p *Provider) CheckCounterExists(name string, labelValues ...string)

CheckCounterExists checks that there is registered counter with the name provided and value is not 0.

func (*Provider) CheckGauge

func (p *Provider) CheckGauge(name string, v float64, labelValues ...string)

CheckGauge checks that there is a registered gauge with the name and value provided.

func (*Provider) CheckGaugeNonZero

func (p *Provider) CheckGaugeNonZero(name string, labelValues ...string)

CheckGaugeNonZero checks that there is a registered gauge with the name provided whose value is != 0.

func (*Provider) CheckNoCounter

func (p *Provider) CheckNoCounter(name string, labelValues ...string)

CheckNoCounter checks that there is no registered counter with the name provided.

func (*Provider) CheckNoGauge

func (p *Provider) CheckNoGauge(name string, labelValues ...string)

CheckNoGauge checks that there is no registered gauge with the name provided.

func (*Provider) CheckObservationCount

func (p *Provider) CheckObservationCount(name string, n int, labelValues ...string)

CheckObservationCount checks that there is a histogram with the name and number of observations provided.

func (*Provider) CheckObservations

func (p *Provider) CheckObservations(name string, obs []float64, labelValues ...string)

CheckObservations checks that there is a histogram with the name and observations provided.

func (*Provider) CheckObservationsMatch

func (p *Provider) CheckObservationsMatch(name string, obs []float64, labelValues ...string)

CheckObservationsMatch checks that there is a histogram with the name and observations provided, ignoring order.

func (*Provider) CheckObservationsMinMax

func (p *Provider) CheckObservationsMinMax(name string, min, max float64, labelValues ...string)

CheckObservationsMinMax checks that there is a histogram with the name and that the values all fall within the min/max range.

func (*Provider) CheckStopped

func (p *Provider) CheckStopped()

CheckStopped verifies that a provider has been Stop'd.

func (*Provider) Flush

func (p *Provider) Flush() error

Flush makes it Provider compliant.

func (*Provider) NewCardinalityCounter

func (p *Provider) NewCardinalityCounter(name string) xmetrics.CardinalityCounter

NewCardinalityCounter implements metrics.Provider.

func (*Provider) NewCounter

func (p *Provider) NewCounter(name string) metrics.Counter

NewCounter implements go-kit's Provider interface.

func (*Provider) NewExplicitHistogram

func (p *Provider) NewExplicitHistogram(name string, _ xmetrics.DistributionFunc) metrics.Histogram

NewExplicitHistogram implements go-kit's Provider interface.

func (*Provider) NewGauge

func (p *Provider) NewGauge(name string) metrics.Gauge

NewGauge implements go-kit's Provider interface.

func (*Provider) NewHistogram

func (p *Provider) NewHistogram(name string, _ int) metrics.Histogram

NewHistogram implements go-kit's Provider interface.

func (*Provider) PrintCounterValue

func (p *Provider) PrintCounterValue(name string)

PrintCounterValue prints the value of the specified counter and their current counts

func (*Provider) Stop

func (p *Provider) Stop()

Stop makes it Provider compliant.