metrics

Documentation

Index

• type Family
  • func (f Family) String() string
• type FamilyGenerator
• type Metric
  • func (m *Metric) Write(s *strings.Builder)
• type MetricType

Types

type Family

type Family []*Metric

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

func (Family) String

func (f Family) String() string

String returns the given Family in its string representation.

type FamilyGenerator

type FamilyGenerator struct {
	Name         string
	Help         string
	Type         MetricType
	GenerateFunc func(obj interface{}) Family
}

FamilyGenerator provides everything needed to generate a metric family with a Kubernetes object.

type Metric

type Metric struct {
	Name        string
	LabelKeys   []string
	LabelValues []string
	Value       float64
}

Metric represents a single time series.

func (*Metric) Write

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

type MetricType

type MetricType string

MetricType represents the type of a metric e.g. a counter. See https://prometheus.io/docs/concepts/metric_types/.

var MetricTypeCounter MetricType = "counter"

MetricTypeCounter defines a Prometheus counter.

var MetricTypeGauge MetricType = "gauge"

MetricTypeGauge defines a Prometheus gauge.