process

Documentation

Index

• Constants
• Variables
• type CachingWalker
  • func NewCachingWalker(source Walker) *CachingWalker
  • func (c *CachingWalker) Tick() error
  • func (c *CachingWalker) Walk(f func(Process)) error
• type Process
• type Reporter
  • func NewReporter(walker Walker, scope string) *Reporter
  • func (r *Reporter) Report() (report.Report, error)
• type Tree
  • func NewTree(walker Walker) (Tree, error)
• type Walker
  • func NewWalker(procRoot string) Walker

Constants

const (
	PID     = "pid"
	Comm    = "comm"
	PPID    = "ppid"
	Cmdline = "cmdline"
	Threads = "threads"
)

We use these keys in node metadata

Variables

var (
	ReadDir  = ioutil.ReadDir
	ReadFile = ioutil.ReadFile
)

Hooks exposed for mocking

Types

type CachingWalker

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

CachingWalker is a walker than caches a copy of the output from another Walker, and then allows other concurrent readers to Walk that copy.

func NewCachingWalker

func NewCachingWalker(source Walker) *CachingWalker

NewCachingWalker returns a new CachingWalker

func (*CachingWalker) Tick

func (c *CachingWalker) Tick() error

Tick updates cached copy of process list

func (*CachingWalker) Walk

func (c *CachingWalker) Walk(f func(Process)) error

Walk walks a cached copy of process list

type Process

type Process struct {
	PID, PPID int
	Comm      string
	Cmdline   string
	Threads   int
}

Process represents a single process.

type Reporter

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

Reporter generates Reports containing the Process topology.

func NewReporter

func NewReporter(walker Walker, scope string) *Reporter

NewReporter makes a new Reporter.

func (*Reporter) Report

func (r *Reporter) Report() (report.Report, error)

Report implements Reporter.

type Tree

type Tree interface {
	GetParent(pid int) (int, error)
}

Tree represents all processes on the machine.

func NewTree

func NewTree(walker Walker) (Tree, error)

NewTree returns a new Tree that can be polled.

type Walker

type Walker interface {
	Walk(func(Process)) error
}

Walker is something that walks the /proc directory

func NewWalker

func NewWalker(procRoot string) Walker

NewWalker creates a new process Walker.