gosigar

README

Go sigar

Overview

Go sigar is a golang implementation of the sigar API. The Go version of sigar has a very similar interface, but is being written from scratch in pure go/cgo, rather than cgo bindings for libsigar.

Test drive

$ go get github.com/elastic/gosigar
$ cd $GOPATH/src/github.com/elastic/gosigar/examples/ps
$ go build
$ ./ps

Supported platforms

The features vary by operating system.

Feature	Linux	Darwin	Windows	OpenBSD	FreeBSD
Cpu	X	X	X	X	X
CpuList	X	X		X	X
FDUsage	X				X
FileSystemList	X	X	X	X	X
FileSystemUsage	X	X	X	X	X
LoadAverage	X	X		X	X
Mem	X	X	X	X	X
ProcArgs	X	X	X		X
ProcEnv	X	X			X
ProcExe	X	X			X
ProcFDUsage	X				X
ProcList	X	X	X		X
ProcMem	X	X	X		X
ProcState	X	X	X		X
ProcTime	X	X	X		X
Swap	X	X		X	X
Uptime	X	X		X	X

OS Specific Notes

FreeBSD

Mount both linprocfs and procfs for compatability. Consider adding these mounts to your /etc/fstab file so they are mounted automatically at boot.

sudo mount -t procfs proc /proc
sudo mkdir -p /compat/linux/proc
sudo mount -t linprocfs /dev/null /compat/linux/proc

License

Apache 2.0

Documentation

Index

• Constants
• func FormatPercent(percent float64) string
• func FormatSize(size uint64) string
• func IsNotImplemented(err error) bool
• type ConcreteSigar
  • func (c *ConcreteSigar) CollectCpuStats(collectionInterval time.Duration) (<-chan Cpu, chan<- struct{})
  • func (c *ConcreteSigar) GetFDUsage() (FDUsage, error)
  • func (c *ConcreteSigar) GetFileSystemUsage(path string) (FileSystemUsage, error)
  • func (c *ConcreteSigar) GetLoadAverage() (LoadAverage, error)
  • func (c *ConcreteSigar) GetMem() (Mem, error)
  • func (c *ConcreteSigar) GetSwap() (Swap, error)
• type Cpu
  • func (cpu Cpu) Delta(other Cpu) Cpu
  • func (c *Cpu) Get() error
  • func (cpu *Cpu) Total() uint64
• type CpuList
• type ErrNotImplemented
  • func (e ErrNotImplemented) Error() string
• type FDUsage
  • func (f *FDUsage) Get() error
• type FileSystem
• type FileSystemList
• type FileSystemUsage
  • func (self *FileSystemUsage) Get(path string) error
  • func (self *FileSystemUsage) UsePercent() float64
• type LoadAverage
  • func (l *LoadAverage) Get() error
• type Mem
  • func (m *Mem) Get() error
• type ProcArgs
• type ProcEnv
• type ProcExe
• type ProcFDUsage
• type ProcList
• type ProcMem
• type ProcState
• type ProcTime
  • func (self *ProcTime) FormatStartTime() string
  • func (self *ProcTime) FormatTotal() string
  • func (p *ProcTime) Get(int) error
• type RunState
• type Sigar
• type Swap
  • func (s *Swap) Get() error
• type Uptime
  • func (self *Uptime) Format() string

Constants

const (
	RunStateSleep   = 'S'
	RunStateRun     = 'R'
	RunStateStop    = 'T'
	RunStateZombie  = 'Z'
	RunStateIdle    = 'D'
	RunStateUnknown = '?'
)

Functions

func FormatPercent

func FormatPercent(percent float64) string

func FormatSize

func FormatSize(size uint64) string

Go version of apr_strfsize

func IsNotImplemented

func IsNotImplemented(err error) bool

Types

type ConcreteSigar

type ConcreteSigar struct{}

func (*ConcreteSigar) CollectCpuStats

func (c *ConcreteSigar) CollectCpuStats(collectionInterval time.Duration) (<-chan Cpu, chan<- struct{})

func (*ConcreteSigar) GetFDUsage

func (c *ConcreteSigar) GetFDUsage() (FDUsage, error)

func (*ConcreteSigar) GetFileSystemUsage

func (c *ConcreteSigar) GetFileSystemUsage(path string) (FileSystemUsage, error)

func (*ConcreteSigar) GetLoadAverage

func (c *ConcreteSigar) GetLoadAverage() (LoadAverage, error)

func (*ConcreteSigar) GetMem

func (c *ConcreteSigar) GetMem() (Mem, error)

func (*ConcreteSigar) GetSwap

func (c *ConcreteSigar) GetSwap() (Swap, error)

type Cpu

type Cpu struct {
	User    uint64
	Nice    uint64
	Sys     uint64
	Idle    uint64
	Wait    uint64
	Irq     uint64
	SoftIrq uint64
	Stolen  uint64
}

func (Cpu) Delta

func (cpu Cpu) Delta(other Cpu) Cpu

func (*Cpu) Get

func (c *Cpu) Get() error

func (*Cpu) Total

func (cpu *Cpu) Total() uint64

type CpuList

type CpuList struct {
	List []Cpu
}

type ErrNotImplemented

type ErrNotImplemented struct {
	OS string
}

func (ErrNotImplemented) Error

func (e ErrNotImplemented) Error() string

type FDUsage

type FDUsage struct {
	Open   uint64
	Unused uint64
	Max    uint64
}

func (*FDUsage) Get

func (f *FDUsage) Get() error

type FileSystem

type FileSystem struct {
	DirName     string
	DevName     string
	TypeName    string
	SysTypeName string
	Options     string
	Flags       uint32
}

type FileSystemList

type FileSystemList struct {
	List []FileSystem
}

type FileSystemUsage

type FileSystemUsage struct {
	Total     uint64
	Used      uint64
	Free      uint64
	Avail     uint64
	Files     uint64
	FreeFiles uint64
}

func (*FileSystemUsage) Get

func (self *FileSystemUsage) Get(path string) error

func (*FileSystemUsage) UsePercent

func (self *FileSystemUsage) UsePercent() float64

type LoadAverage

type LoadAverage struct {
	One, Five, Fifteen float64
}

func (*LoadAverage) Get

func (l *LoadAverage) Get() error

type Mem

type Mem struct {
	Total      uint64
	Used       uint64
	Free       uint64
	ActualFree uint64
	ActualUsed uint64
}

func (*Mem) Get

func (m *Mem) Get() error

type ProcArgs

type ProcArgs struct {
	List []string
}

type ProcEnv

type ProcEnv struct {
	Vars map[string]string
}

type ProcExe

type ProcExe struct {
	Name string
	Cwd  string
	Root string
}

type ProcFDUsage

type ProcFDUsage struct {
	Open      uint64
	SoftLimit uint64
	HardLimit uint64
}

type ProcList

type ProcList struct {
	List []int
}

type ProcMem

type ProcMem struct {
	Size        uint64
	Resident    uint64
	Share       uint64
	MinorFaults uint64
	MajorFaults uint64
	PageFaults  uint64
}

type ProcState

type ProcState struct {
	Name      string
	Username  string
	State     RunState
	Ppid      int
	Pgid      int
	Tty       int
	Priority  int
	Nice      int
	Processor int
}

type ProcTime

type ProcTime struct {
	StartTime uint64
	User      uint64
	Sys       uint64
	Total     uint64
}

func (*ProcTime) FormatStartTime

func (self *ProcTime) FormatStartTime() string

func (*ProcTime) FormatTotal

func (self *ProcTime) FormatTotal() string

func (*ProcTime) Get

func (p *ProcTime) Get(int) error

type RunState

type RunState byte

type Sigar

type Sigar interface {
	CollectCpuStats(collectionInterval time.Duration) (<-chan Cpu, chan<- struct{})
	GetLoadAverage() (LoadAverage, error)
	GetMem() (Mem, error)
	GetSwap() (Swap, error)
	GetFileSystemUsage(string) (FileSystemUsage, error)
	GetFDUsage() (FDUsage, error)
}

type Swap

type Swap struct {
	Total uint64
	Used  uint64
	Free  uint64
}

func (*Swap) Get

func (s *Swap) Get() error

type Uptime

type Uptime struct {
	Length float64
}

func (*Uptime) Format

func (self *Uptime) Format() string