metric

Documentation

Index

• type CounterVec
  • func NewCounterVec(cfg *CounterVecOpts) CounterVec
• type CounterVecOpts
• type GaugeVec
  • func NewGaugeVec(cfg *GaugeVecOpts) GaugeVec
• type GaugeVecOpts
• type HistogramVec
  • func NewHistogramVec(cfg *HistogramVecOpts) HistogramVec
• type HistogramVecOpts
• type SummaryVec
  • func NewSummaryVec(cfg *SummaryVecOpts) SummaryVec
• type SummaryVecOpts
• type VectorOpts

Types

type CounterVec

type CounterVec interface {
	// Inc increments labels.
	Inc(labels ...string)
	// Add adds labels with v.
	Add(v float64, labels ...string)
	// contains filtered or unexported methods
}

CounterVec interface represents a counter vector.

func NewCounterVec

func NewCounterVec(cfg *CounterVecOpts) CounterVec

NewCounterVec returns a CounterVec.

type CounterVecOpts

type CounterVecOpts VectorOpts

A CounterVecOpts is an alias of VectorOpts.

type GaugeVec

type GaugeVec interface {
	// Set sets v to labels.
	Set(v float64, labels ...string)
	// Inc increments labels.
	Inc(labels ...string)
	// Dec decrements labels.
	Dec(labels ...string)
	// Add adds v to labels.
	Add(v float64, labels ...string)
	// Sub subtracts v to labels.
	Sub(v float64, labels ...string)
	// contains filtered or unexported methods
}

GaugeVec represents a gauge vector.

func NewGaugeVec

func NewGaugeVec(cfg *GaugeVecOpts) GaugeVec

NewGaugeVec returns a GaugeVec.

type GaugeVecOpts

type GaugeVecOpts VectorOpts

GaugeVecOpts is an alias of VectorOpts.

type HistogramVec

type HistogramVec interface {
	// Observe adds observation v to labels.
	Observe(v int64, labels ...string)
	// ObserveFloat allow to observe float64 values.
	ObserveFloat(v float64, labels ...string)
	// contains filtered or unexported methods
}

A HistogramVec interface represents a histogram vector.

func NewHistogramVec

func NewHistogramVec(cfg *HistogramVecOpts) HistogramVec

NewHistogramVec returns a HistogramVec.

type HistogramVecOpts

type HistogramVecOpts struct {
	Namespace   string
	Subsystem   string
	Name        string
	Help        string
	Labels      []string
	Buckets     []float64
	ConstLabels map[string]string
}

A HistogramVecOpts is a histogram vector options.

type SummaryVec

type SummaryVec interface {
	// Observe adds observation v to labels.
	Observe(v float64, labels ...string)
	// contains filtered or unexported methods
}

A SummaryVec interface represents a summary vector.

func NewSummaryVec

func NewSummaryVec(cfg *SummaryVecOpts) SummaryVec

NewSummaryVec return a SummaryVec

type SummaryVecOpts

type SummaryVecOpts struct {
	VecOpt     VectorOpts
	Objectives map[float64]float64
}

A SummaryVecOpts is a summary vector options

type VectorOpts

type VectorOpts struct {
	Namespace string
	Subsystem string
	Name      string
	Help      string
	Labels    []string
}

A VectorOpts is a general configuration.