unix

Documentation

Index

• Variables
• type Process
  • func NewProcess(pid int) (*Process, error)
  • func (p *Process) Cmdline() string
  • func (p *Process) CmdlineSlice() []string
  • func (p *Process) Name() string
  • func (p *Process) Reload() error
  • func (p *Process) State() string
• type System
  • func NewSystem() (*System, error)
  • func (s *System) Reload() error
• type Unix
  • func (u *Unix) HarvestModule() plugin.ModuleInfo
  • func (u *Unix) Init(a *collector.AbstractCollector) error
  • func (u *Unix) PollData() (map[string]*matrix.Matrix, error)
  • func (u *Unix) PollInstance() (map[string]*matrix.Matrix, error)

Variables

var (
	ErrProcessNotFound = errors.New("process not found")
	ErrFieldNotFound   = errors.New("field not found")
	ErrFieldValue      = errors.New("field_value")
	ErrFileRead        = errors.New("read file")
)

Types

type Process

type Process struct {
	// contains filtered or unexported fields
}

Process - identity and stats about resource usage of a process most values are simple counters; elapsedTime & cpuTotal are the exception: they are deltas

func NewProcess

func NewProcess(pid int) (*Process, error)

NewProcess - returns an initialized instance of Process if no process with *pid* exists, returns ErrProcessNotFound

func (*Process) Cmdline

func (p *Process) Cmdline() string

Cmdline - command-line vector of the process

func (*Process) CmdlineSlice

func (p *Process) CmdlineSlice() []string

CmdlineSlice - command-line slice of the process

func (*Process) Name

func (p *Process) Name() string

Name - common name of the process

func (*Process) Reload

func (p *Process) Reload() error

Reload - load or refresh stats

func (*Process) State

func (p *Process) State() string

State - state of the process

type System

type System struct {
	// contains filtered or unexported fields
}

System - provides memory size and boot time of the system

func NewSystem

func NewSystem() (*System, error)

NewSystem - creates an initialized instance of System

func (*System) Reload

func (s *System) Reload() error

Reload - refresh metrics

type Unix

type Unix struct {
	*collector.AbstractCollector
	// contains filtered or unexported fields
}

Unix - collector providing basic stats about harvest pollers @TODO - extend to monitor any user-defined process

func (*Unix) HarvestModule

func (u *Unix) HarvestModule() plugin.ModuleInfo

func (*Unix) Init

func (u *Unix) Init(a *collector.AbstractCollector) error

Init - initialize the collector

func (*Unix) PollData

func (u *Unix) PollData() (map[string]*matrix.Matrix, error)

PollData - update data cache

func (*Unix) PollInstance

func (u *Unix) PollInstance() (map[string]*matrix.Matrix, error)

PollInstance - update instance cache with running pollers