metric

Documentation

Index

• type Family
  • func (f Family) ByteSlice() []byte
  • func (f Family) Inspect(inspect func(Family))
• type FamilyInterface
• type Metric
  • func (m *Metric) Write(s *strings.Builder)
• type Type

Types

type Family

type Family struct {
	Name    string
	Type    Type
	Metrics []*Metric
}

Family represents a set of metrics with the same name and help text.

func (Family) ByteSlice

func (f Family) ByteSlice() []byte

ByteSlice returns the given Family in its string representation.

func (Family) Inspect

func (f Family) Inspect(inspect func(Family))

Inspect use to inspect the inside of a Family

type FamilyInterface

type FamilyInterface interface {
	Inspect(inspect func(Family))
	ByteSlice() []byte
}

FamilyInterface interface for a family

type Metric

type Metric struct {
	// The name of a metric is injected by its family to reduce duplication.
	LabelKeys   []string
	LabelValues []string
	Value       float64
}

Metric represents a single time series.

func (*Metric) Write

func (m *Metric) Write(s *strings.Builder)

type Type

type Type string

Type represents the type of a metric e.g. a counter. See https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#metric-types.

var Counter Type = "counter"

Counter defines a OpenMetrics counter.

var Gauge Type = "gauge"

Gauge defines a OpenMetrics gauge.

var Info Type = "info"

Info defines an OpenMetrics info.

var StateSet Type = "stateset"

StateSet defines an OpenMetrics stateset.