Documentation ¶
Overview ¶
Package metrics provides a framework for application instrumentation. All metrics are safe for concurrent use. Considerable design influence has been taken from https://github.com/codahale/metrics and https://prometheus.io.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PrintDistribution ¶
PrintDistribution writes a human-readable graph of the distribution to the passed writer.
Types ¶
type Counter ¶
Counter is a monotonically-increasing, unsigned, 64-bit integer used to capture the number of times an event has occurred. By tracking the deltas between measurements of a counter over intervals of time, an aggregation layer can derive rates, acceleration, etc.
func NewMultiCounter ¶
NewMultiCounter returns a wrapper around multiple Counters.
type Field ¶
Field is a key/value pair associated with an observation for a specific metric. Fields may be ignored by implementations.
type Gauge ¶
type Gauge interface { Name() string With(Field) Gauge Set(value float64) Add(delta float64) Get() float64 }
Gauge captures instantaneous measurements of something using signed, 64-bit floats. The value does not need to be monotonic.
func NewMultiGauge ¶
NewMultiGauge returns a wrapper around multiple Gauges.
type Histogram ¶
type Histogram interface { Name() string With(Field) Histogram Observe(value int64) Distribution() ([]Bucket, []Quantile) }
Histogram tracks the distribution of a stream of values (e.g. the number of milliseconds it takes to handle requests). Implementations may choose to add gauges for values at meaningful quantiles.
func NewMultiHistogram ¶
NewMultiHistogram returns a wrapper around multiple Histograms.
func NewScaledHistogram ¶
NewScaledHistogram returns a Histogram whose observed values are downscaled (divided) by scale.
type TimeHistogram ¶
type TimeHistogram interface { With(Field) TimeHistogram Observe(time.Duration) }
TimeHistogram is a convenience wrapper for a Histogram of time.Durations.
func NewTimeHistogram ¶
func NewTimeHistogram(unit time.Duration, h Histogram) TimeHistogram
NewTimeHistogram returns a TimeHistogram wrapper around the passed Histogram, in units of unit.
Source Files ¶
Directories ¶
Path | Synopsis |
---|---|
Package discard implements a backend for package metrics that succeeds without doing anything.
|
Package discard implements a backend for package metrics that succeeds without doing anything. |
Package dogstatsd implements a DogStatsD backend for package metrics.
|
Package dogstatsd implements a DogStatsD backend for package metrics. |
Package expvar implements an expvar backend for package metrics.
|
Package expvar implements an expvar backend for package metrics. |
Package graphite implements a Graphite backend for package metrics.
|
Package graphite implements a Graphite backend for package metrics. |
Package influxdb implements a InfluxDB backend for package metrics.
|
Package influxdb implements a InfluxDB backend for package metrics. |
Package prometheus implements a Prometheus backend for package metrics.
|
Package prometheus implements a Prometheus backend for package metrics. |
Package statsd implements a statsd backend for package metrics.
|
Package statsd implements a statsd backend for package metrics. |
Package teststat contains helper functions for statistical testing of metrics implementations.
|
Package teststat contains helper functions for statistical testing of metrics implementations. |