kit: github.com/go-kit/kit/metrics/generic Index | Files

package generic

import "github.com/go-kit/kit/metrics/generic"

Package generic implements generic versions of each of the metric types. They can be embedded by other implementations, and converted to specific formats as necessary.

Index

Package Files

generic.go

type Bucket Uses

type Bucket struct {
    From, To, Count int64
}

Bucket is a range in a histogram which aggregates observations.

type Counter Uses

type Counter struct {
    Name string
    // contains filtered or unexported fields
}

Counter is an in-memory implementation of a Counter.

func NewCounter Uses

func NewCounter(name string) *Counter

NewCounter returns a new, usable Counter.

func (*Counter) Add Uses

func (c *Counter) Add(delta float64)

Add implements Counter.

func (*Counter) LabelValues Uses

func (c *Counter) LabelValues() []string

LabelValues returns the set of label values attached to the counter.

func (*Counter) Value Uses

func (c *Counter) Value() float64

Value returns the current value of the counter.

func (*Counter) ValueReset Uses

func (c *Counter) ValueReset() float64

ValueReset returns the current value of the counter, and resets it to zero. This is useful for metrics backends whose counter aggregations expect deltas, like Graphite.

func (*Counter) With Uses

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

With implements Counter.

type Gauge Uses

type Gauge struct {
    Name string
    // contains filtered or unexported fields
}

Gauge is an in-memory implementation of a Gauge.

func NewGauge Uses

func NewGauge(name string) *Gauge

NewGauge returns a new, usable Gauge.

func (*Gauge) Add Uses

func (g *Gauge) Add(delta float64)

Add implements metrics.Gauge.

func (*Gauge) LabelValues Uses

func (g *Gauge) LabelValues() []string

LabelValues returns the set of label values attached to the gauge.

func (*Gauge) Set Uses

func (g *Gauge) Set(value float64)

Set implements Gauge.

func (*Gauge) Value Uses

func (g *Gauge) Value() float64

Value returns the current value of the gauge.

func (*Gauge) With Uses

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

With implements Gauge.

type Histogram Uses

type Histogram struct {
    Name string
    // contains filtered or unexported fields
}

Histogram is an in-memory implementation of a streaming histogram, based on VividCortex/gohistogram. It dynamically computes quantiles, so it's not suitable for aggregation.

func NewHistogram Uses

func NewHistogram(name string, buckets int) *Histogram

NewHistogram returns a numeric histogram based on VividCortex/gohistogram. A good default value for buckets is 50.

func (*Histogram) LabelValues Uses

func (h *Histogram) LabelValues() []string

LabelValues returns the set of label values attached to the histogram.

func (*Histogram) Observe Uses

func (h *Histogram) Observe(value float64)

Observe implements Histogram.

func (*Histogram) Print Uses

func (h *Histogram) Print(w io.Writer)

Print writes a string representation of the histogram to the passed writer. Useful for printing to a terminal.

func (*Histogram) Quantile Uses

func (h *Histogram) Quantile(q float64) float64

Quantile returns the value of the quantile q, 0.0 < q < 1.0.

func (*Histogram) With Uses

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

With implements Histogram.

type Quantile Uses

type Quantile struct {
    Quantile int // 0..100
    Value    int64
}

Quantile is a pair of a quantile (0..100) and its observed maximum value.

type SimpleHistogram Uses

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

SimpleHistogram is an in-memory implementation of a Histogram. It only tracks an approximate moving average, so is likely too naïve for many use cases.

func NewSimpleHistogram Uses

func NewSimpleHistogram() *SimpleHistogram

NewSimpleHistogram returns a SimpleHistogram, ready for observations.

func (*SimpleHistogram) ApproximateMovingAverage Uses

func (h *SimpleHistogram) ApproximateMovingAverage() float64

ApproximateMovingAverage returns the approximate moving average of observations.

func (*SimpleHistogram) LabelValues Uses

func (h *SimpleHistogram) LabelValues() []string

LabelValues returns the set of label values attached to the histogram.

func (*SimpleHistogram) Observe Uses

func (h *SimpleHistogram) Observe(value float64)

Observe implements Histogram.

func (*SimpleHistogram) With Uses

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

With implements Histogram.

Package generic imports 8 packages (graph) and is imported by 19 packages. Updated 2017-02-10. Refresh now. Tools for package owners.