process_summary

Documentation

Overview

Package process_summary collects high level summary metrics about the running processes. It is implemented on darwin, freebsd, linux, and windows.

Index

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

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
}

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(r 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.