metrics

Documentation

Index

• type AgentGenerator
  • func (g *AgentGenerator) CustomIdentifier() *string
  • func (g *AgentGenerator) Generate() (Values, error)
  • func (g *AgentGenerator) PrepareGraphDefs() ([]*mkr.GraphDefsParam, error)
• type FilesystemGenerator
  • func (g *FilesystemGenerator) Generate() (Values, error)
• type Generator
• type InterfaceGenerator
  • func (g *InterfaceGenerator) Generate() (Values, error)
• type LoadavgGenerator
  • func (g *LoadavgGenerator) Generate() (Values, error)
• type PluginFaultError
  • func (e *PluginFaultError) Error() string
  • func (e *PluginFaultError) Unwrap() error
• type PluginGenerator
  • func NewPluginGenerator(conf *config.MetricPlugin) PluginGenerator
• type Values
• type ValuesCustomIdentifier
  • func MergeValuesCustomIdentifiers(values []*ValuesCustomIdentifier, newValue *ValuesCustomIdentifier) []*ValuesCustomIdentifier

Types

type AgentGenerator

type AgentGenerator struct {
}

AgentGenerator is generator of metrics about the running agent itself

func (*AgentGenerator) CustomIdentifier

func (g *AgentGenerator) CustomIdentifier() *string

CustomIdentifier for PluginGenerator interface

func (*AgentGenerator) Generate

func (g *AgentGenerator) Generate() (Values, error)

Generate generates the memory usage of the running agent itself

func (*AgentGenerator) PrepareGraphDefs

func (g *AgentGenerator) PrepareGraphDefs() ([]*mkr.GraphDefsParam, error)

PrepareGraphDefs for PluginGenerator interface

type FilesystemGenerator

type FilesystemGenerator struct {
	IgnoreRegexp  *regexp.Regexp
	UseMountpoint bool
}

FilesystemGenerator is common filesystem metrics generator on unix os.

func (*FilesystemGenerator) Generate

func (g *FilesystemGenerator) Generate() (Values, error)

Generate the metrics of filesystems

type Generator

type Generator interface {
	Generate() (Values, error)
}

Generator generates metrics

type InterfaceGenerator

type InterfaceGenerator struct {
	IgnoreRegexp *regexp.Regexp
	Interval     time.Duration
}

InterfaceGenerator generates interface metric values

func (*InterfaceGenerator) Generate

func (g *InterfaceGenerator) Generate() (Values, error)

Generate interface metric values

type LoadavgGenerator

type LoadavgGenerator struct {
}

LoadavgGenerator generates load average values

func (*LoadavgGenerator) Generate

func (g *LoadavgGenerator) Generate() (Values, error)

Generate load averages

type PluginFaultError

type PluginFaultError struct {
	Err error
}

PluginFaultError may be returned by [PluginGenerator.PrepareGraphDefs]. This error indicates a bug in a plugin and should be logged for a user. Note that [PluginGenerator.PrepareGraphDefs] can also return other error types.

func (*PluginFaultError) Error

func (e *PluginFaultError) Error() string

func (*PluginFaultError) Unwrap

func (e *PluginFaultError) Unwrap() error

type PluginGenerator

type PluginGenerator interface {
	Generator
	PrepareGraphDefs() ([]*mkr.GraphDefsParam, error)
	CustomIdentifier() *string
}

PluginGenerator generates metrics of plugin

func NewPluginGenerator

func NewPluginGenerator(conf *config.MetricPlugin) PluginGenerator

NewPluginGenerator XXX

type Values

type Values map[string]float64

Values represents metric values

type ValuesCustomIdentifier

type ValuesCustomIdentifier struct {
	Values           Values
	CustomIdentifier *string
}

ValuesCustomIdentifier holds the metric values with the optional custom identifier

func MergeValuesCustomIdentifiers

func MergeValuesCustomIdentifiers(values []*ValuesCustomIdentifier, newValue *ValuesCustomIdentifier) []*ValuesCustomIdentifier

MergeValuesCustomIdentifiers merges the metric values and custom identifiers