pmmetrics

Documentation

Index

• type PmMetrics
  • func NewPmMetrics(deviceID string, opts ...PmMetricsOption) *PmMetrics
  • func (pm *PmMetrics) GetSubscriberMetrics() map[string]*voltha.PmConfig
  • func (pm *PmMetrics) ToPmConfigs() *voltha.PmConfigs
  • func (pm *PmMetrics) UpdateFrequency(frequency uint32)
• type PmMetricsOption
  • func Frequency(frequency uint32) PmMetricsOption
  • func FrequencyOverride(frequencyOverride bool) PmMetricsOption
  • func Grouped(grouped bool) PmMetricsOption
  • func Metrics(pmNames []string) PmMetricsOption

Types

type PmMetrics

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

PmMetrics structure holds metric and device info

func NewPmMetrics

func NewPmMetrics(deviceID string, opts ...PmMetricsOption) *PmMetrics

NewPmMetrics will return the pmmetric object

func (*PmMetrics) GetSubscriberMetrics

func (pm *PmMetrics) GetSubscriberMetrics() map[string]*voltha.PmConfig

GetSubscriberMetrics will return the metrics subscribed for the device.

func (*PmMetrics) ToPmConfigs

func (pm *PmMetrics) ToPmConfigs() *voltha.PmConfigs

ToPmConfigs will enable the defined pmmetric

func (*PmMetrics) UpdateFrequency

func (pm *PmMetrics) UpdateFrequency(frequency uint32)

UpdateFrequency will update the frequency.

type PmMetricsOption

type PmMetricsOption func(*PmMetrics)

func Frequency

func Frequency(frequency uint32) PmMetricsOption

Frequency is to poll stats at this interval

func FrequencyOverride

func FrequencyOverride(frequencyOverride bool) PmMetricsOption

func Grouped

func Grouped(grouped bool) PmMetricsOption

func Metrics

func Metrics(pmNames []string) PmMetricsOption

Metrics will store the PMMetric params