Documentation
¶
Overview ¶
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 ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Bucket ¶
type Bucket struct {
From, To, Count int64
}
Bucket is a range in a histogram which aggregates observations.
type Counter ¶
type Counter struct {
Name string
// contains filtered or unexported fields
}
Counter is an in-memory implementation of a Counter.
func (*Counter) LabelValues ¶
LabelValues returns the set of label values attached to the counter.
func (*Counter) ValueReset ¶
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.
type Gauge ¶
type Gauge struct {
Name string
// contains filtered or unexported fields
}
Gauge is an in-memory implementation of a Gauge.
func (*Gauge) LabelValues ¶
LabelValues returns the set of label values attached to the gauge.
type Histogram ¶
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 ¶
NewHistogram returns a numeric histogram based on VividCortex/gohistogram. A good default value for buckets is 50.
func (*Histogram) LabelValues ¶
LabelValues returns the set of label values attached to the histogram.
func (*Histogram) Print ¶
Print writes a string representation of the histogram to the passed writer. Useful for printing to a terminal.
type SimpleHistogram ¶
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 ¶
func NewSimpleHistogram() *SimpleHistogram
NewSimpleHistogram returns a SimpleHistogram, ready for observations.
func (*SimpleHistogram) ApproximateMovingAverage ¶
func (h *SimpleHistogram) ApproximateMovingAverage() float64
ApproximateMovingAverage returns the approximate moving average of observations.
func (*SimpleHistogram) LabelValues ¶
func (h *SimpleHistogram) LabelValues() []string
LabelValues returns the set of label values attached to the histogram.
func (*SimpleHistogram) Observe ¶
func (h *SimpleHistogram) Observe(value float64)
Observe implements Histogram.
Source Files