telemetry

Documentation

Index

• Variables
• func Init(c *Config)
• func Register(meta ...SelfTelemetryMetaFunc)
• type Collector
• type Config
• type Counter
  • func NewCounter(name, help string, labels ...string) *Counter
  • func (c *Counter) Add(val float64, labelValues ...string)
  • func (c *Counter) Inc(labelValues ...string)
• type DynamicGauge
  • func NewDynamicGauge(name, help string, labels ...string) *DynamicGauge
  • func (i *DynamicGauge) Dec(labels ...string)
  • func (i *DynamicGauge) Inc(labels ...string)
• type Gauge
  • func NewGauge(name, help string, getter func() float64, labels ...string) *Gauge
• type SelfTelemetryMetaFunc
  • func WithMeta(name string, collector prometheus.Collector) SelfTelemetryMetaFunc
• type TimeRecorder
  • func (c *TimeRecorder) Stop()
• type Timer
  • func NewTimer(name, help string, labels ...string) *Timer
  • func (c *Timer) AddTime(t time.Duration, labelValues ...string)
  • func (c *Timer) Start(labelValues ...string) *TimeRecorder

Variables

var (
	Gatherer prometheus.Gatherer // The gatherer is for fetching metrics from the registry.

)

registerer is the global metrics center for collecting the telemetry data in core modules or plugins.

Functions

func Init

func Init(c *Config)

Init create the global telemetry center according to the config.

func Register

func Register(meta ...SelfTelemetryMetaFunc)

Register registers the metric meta to the registerer.

Types

type Collector

type Collector interface {
}

The Self-telemetry data collection interface.

type Config

type Config struct {
	Cluster  string `mapstructure:"cluster"`  // The cluster name.
	Service  string `mapstructure:"service"`  // The service name.
	Instance string `mapstructure:"instance"` // The instance name.
}

Config defines the common telemetry labels.

type Counter

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

The counter metric.

func NewCounter

func NewCounter(name, help string, labels ...string) *Counter

NewCounter create a new counter if no metric with the same name exists.

func (*Counter) Add

func (c *Counter) Add(val float64, labelValues ...string)

Add float value.

func (*Counter) Inc

func (c *Counter) Inc(labelValues ...string)

Add one.

type DynamicGauge

type DynamicGauge struct {
	Collector
	// contains filtered or unexported fields
}

func NewDynamicGauge

func NewDynamicGauge(name, help string, labels ...string) *DynamicGauge

func (*DynamicGauge) Dec

func (i *DynamicGauge) Dec(labels ...string)

func (*DynamicGauge) Inc

func (i *DynamicGauge) Inc(labels ...string)

type Gauge

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

func NewGauge

func NewGauge(name, help string, getter func() float64, labels ...string) *Gauge

type SelfTelemetryMetaFunc

type SelfTelemetryMetaFunc func() (string, prometheus.Collector)

SelfTelemetryMetaFunc returns the metric name and the metric instance.

func WithMeta

func WithMeta(name string, collector prometheus.Collector) SelfTelemetryMetaFunc

WithMeta is used as the param of the Register function.

type TimeRecorder

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

func (*TimeRecorder) Stop

func (c *TimeRecorder) Stop()

Stop the time and record the time

type Timer

type Timer struct {
	Collector
	// contains filtered or unexported fields
}

func NewTimer

func NewTimer(name, help string, labels ...string) *Timer

NewCounter create a new counter if no metric with the same name exists.

func (*Timer) AddTime

func (c *Timer) AddTime(t time.Duration, labelValues ...string)

AddTime add a new duration and count

func (*Timer) Start

func (c *Timer) Start(labelValues ...string) *TimeRecorder

Start a new time recorder