loadavg

Documentation

Overview

Package loadAvg gets loadavg information from the /proc/loadavg file.

Index

• func NewTicker(d time.Duration) (joe.Tocker, error)
• type LoadAvg
  • func Get() (la LoadAvg, err error)
• type Profiler
  • func NewProfiler() (prof *Profiler, err error)
  • func (prof *Profiler) Get() (la LoadAvg, err error)
  • func (prof *Profiler) Reset() error
• type Ticker
  • func (t *Ticker) Close()
  • func (t *Ticker) Run()

Functions

func NewTicker

func NewTicker(d time.Duration) (joe.Tocker, error)

NewTicker returns a new Ticker containing a Data channel that delivers the data at intervals and an error channel that delivers any errors encountered. Stop the ticker to signal the ticker to stop running. Stopping the ticker does not close the Data channel; call Close to close both the ticker and the data channel.

Types

type LoadAvg

type LoadAvg struct {
	Timestamp int64
	Minute    float32
	Five      float32
	Fifteen   float32
	Running   int32
	Total     int32
	PID       int32
}

LoadAvg holds loadavg information

func Get

func Get() (la LoadAvg, err error)

Get gets the loadavg information using the package's global Profiler.

type Profiler

type Profiler struct {
	joe.Procer
	*joe.Buffer
}

Profiler processes the loadavg information.

func NewProfiler

func NewProfiler() (prof *Profiler, err error)

Returns an initialized Profiler; ready to use.

func (*Profiler) Get

func (prof *Profiler) Get() (la LoadAvg, err error)

Get populates LoadAvg with /proc/loadavg information.

func (*Profiler) Reset

func (prof *Profiler) Reset() error

Reset resources: after reset, the profiler is ready to be used again.

type Ticker

type Ticker struct {
	*joe.Ticker
	Data chan LoadAvg
	*Profiler
}

Ticker delivers the system's loadavg information at intervals.

func (*Ticker) Close

func (t *Ticker) Close()

Close closes the ticker resources.

func (*Ticker) Run

func (t *Ticker) Run()

Run runs the ticker.