status

Documentation

Index

• func New(base mb.BaseMetricSet) (mb.MetricSet, error)
• type MetricSet
  • func (m *MetricSet) Fetch(report mb.ReporterV2) error

Functions

func New

func New(base mb.BaseMetricSet) (mb.MetricSet, error)

New creates a new instance of the MetricSet. New is responsible for unpacking any MetricSet specific configuration options if there are any.

Types

type MetricSet

type MetricSet struct {
	mb.BaseMetricSet
	// contains filtered or unexported fields
}

MetricSet holds any configuration or state information. It must implement the mb.MetricSet interface. And this is best achieved by embedding mb.BaseMetricSet because it implements all of the required mb.MetricSet interface methods except for Fetch.

func (*MetricSet) Fetch

func (m *MetricSet) Fetch(report mb.ReporterV2) error

Fetch methods implements the data gathering and data conversion to the right format. It publishes the event which is then forwarded to the output. In case of an error set the Error field of mb.Event or simply call report.Error().