metrics

Documentation

Overview

Package metrics provides support for metrics collecting mechanism.

Index

• type Counter
• type Exposer
• type Gauge
• type Histogram
• type Summary

Types

type Counter

type Counter interface {
	Inc()
	// contains filtered or unexported methods
}

Counter is a cumulative metric that represents a single numerical value that only ever goes up.

type Exposer

type Exposer interface {
	CreateGauge(name, description string) Gauge
	CreateCounter(name, description string) Counter
	CreateHistogram(name, description string, buckets []float64) Histogram
	CreateSummary(name, description string, objectives map[float64]float64) Summary

	Expose()
	ExposeHandler() http.Handler

	system.Disposer
}

Exposer represents metrics exposer mechanism.

type Gauge

type Gauge interface {
	Set(value float64)
	// contains filtered or unexported methods
}

Gauge is a metric that represents a single numerical value that can arbitrarily go up and down.

type Histogram

type Histogram interface {
	Observe(value float64)
	// contains filtered or unexported methods
}

Histogram samples observations (usually things like request durations or response sizes) and counts them in configurable buckets. It also provides a sum of all observed values.

type Summary

type Summary interface {
	Observe(value float64)
	// contains filtered or unexported methods
}

Summary samples observations (usually things like request durations and response sizes).