cpu

Documentation

Overview

Package cpu collects CPU metrics from the host OS.

Index

• func New(base mb.BaseMetricSet) (mb.MetricSet, error)
• type Config
  • func (c Config) Validate() error
• type MetricSet
  • func (m *MetricSet) Fetch() (common.MapStr, error)

Functions

func New

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

New is a mb.MetricSetFactory that returns a cpu.MetricSet.

Types

type Config

type Config struct {
	Metrics  []string `config:"cpu.metrics"`
	CPUTicks *bool    `config:"cpu_ticks"` // Deprecated.
}

Config for the system cpu metricset.

func (Config) Validate

func (c Config) Validate() error

Validate validates the cpu config.

type MetricSet

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

MetricSet for fetching system CPU metrics.

func (*MetricSet) Fetch

func (m *MetricSet) Fetch() (common.MapStr, error)

Fetch fetches CPU metrics from the OS.