metrics

Documentation

Index

• type Metrics
  • func NewMetrics(opts Options) (*Metrics, error)
  • func (m *Metrics) Gather() ([]*model.MetricFamily, error)
  • func (m *Metrics) Start() error
  • func (m *Metrics) Stop()
• type Options

Types

type Metrics

type Metrics struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Metrics implements collecting, caching and processing of raw metrics.

func NewMetrics

func NewMetrics(opts Options) (*Metrics, error)

NewMetrics creates a new instance for metrics collecting and processing.

func (*Metrics) Gather

func (m *Metrics) Gather() ([]*model.MetricFamily, error)

Gather is our prometheus.Gatherer interface for proxying metrics.

func (*Metrics) Start

func (m *Metrics) Start() error

Start starts metrics collection and processing.

func (*Metrics) Stop

func (m *Metrics) Stop()

Stop stops metrics collection and processing.

type Options

type Options struct {
	// PollInterval is the interval for polling raw metrics.
	PollInterval time.Duration
	// Events is the channel for delivering metrics events.
	Events chan interface{}
}

Options describes options for metrics collection and processing.