metrics

type Counter ¶

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

func NewCounter(name, description string, opts ...MetricOption) *Counter

func (f *Counter) Add(value float64)

func (f *Counter) Decrement()

func (f *Counter) Increment()

func (f *Counter) With(labelValues ...LabelValue) *Counter

func (f *Counter) WithFailure(reason string, labelValues ...LabelValue) *Counter

func (f *Counter) WithStatus(status string, labelValues ...LabelValue) *Counter

func (f *Counter) WithSuccess(labelValues ...LabelValue) *Counter

type Gauge ¶

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

func NewGauge(name, description string, opts ...MetricOption) *Gauge

func (f *Gauge) Record(value float64)

func (f *Gauge) With(labelValues ...LabelValue) *Gauge

type GaugeValues ¶

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

type Histogram ¶

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

func NewHistogram(name, description string, bounds []float64, opts ...MetricOption) *Histogram

func (f *Histogram) Record(value float64)

func (f *Histogram) With(labelValues ...LabelValue) *Histogram

type Label ¶

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

A Label provides a named dimension for a Metric.

func NewLabel(key string) Label

func (l Label) Value(value string) LabelValue

type LabelValue ¶

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

A LabelValue represents a Label with a specific value. It is used to record values for a Metric.

func (l LabelValue) Key() Label

func (l LabelValue) Value() string

type Metadata ¶

type Metadata struct {
	Name        string
	Type        MetricType
	Description string
	Bounds      []float64
}

Metadata records a metric's metadata.

type MetricOption ¶

type MetricOption func(*MetricOptions)

MetricOption encode changes to the options passed to a Metric at creation time.

func WithUnit(unit Unit) MetricOption

type MetricOptions ¶

type MetricOptions struct {
	Unit        Unit
	Name        string
	Description string
}

type MetricType ¶

type MetricType string

MetricType is the type of a metric.

const (
	CounterType   MetricType = "Counter"
	GaugeType     MetricType = "Gauge"
	HistogramType MetricType = "Histogram"
)

type Unit ¶

type Unit string

Unit encodes the standard name for describing the quantity measured by a Metric (if applicable).

const (
	None         Unit = "1"
	Bytes        Unit = "By"
	Seconds      Unit = "s"
	Milliseconds Unit = "ms"
)