heap

Documentation

Index

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

Functions

func New

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

New create a new instance of the MetricSet Part of new is also setting up the configuration by processing additional configuration entries if needed.

Types

type MetricSet

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

MetricSet type defines all fields of the MetricSet As a minimum it must inherit the mb.BaseMetricSet fields, but can be extended with additional entries. These variables can be used to persist data or configuration between multiple fetch calls.

func (*MetricSet) Fetch

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

Fetch methods implements the data gathering and data conversion to the right format It returns the event which is then forward to the output. In case of an error, a descriptive error must be returned.

type Stats

type Stats struct {
	MemStats runtime.MemStats
	Cmdline  []interface{}
}

Stats contains the memory info that we get from the fetch request