process

package

v1.0.0 Latest Latest Go to latest Published: Nov 7, 2016 License: Apache-2.0 Imports: 15 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/sdurrheimer/scope

Links

Open Source Insights

Documentation ¶

Rendered for

Index ¶

Constants
Variables
func GetDeltaTotalJiffies() (uint64, float64, error)
type CachingWalker
- func NewCachingWalker(source Walker) *CachingWalker
type Jiffies
type Process
type Reporter
- func NewReporter(walker Walker, scope string, jiffies Jiffies) *Reporter
- func (Reporter) Name() string
- func (r *Reporter) Report() (report.Report, error)
type Tree
- func NewTree(walker Walker) (Tree, error)
type Walker
- func NewWalker(procRoot string) Walker

Constants ¶

View Source

const (
	PID            = "pid"
	Name           = "name"
	PPID           = "ppid"
	Cmdline        = "cmdline"
	Threads        = "threads"
	CPUUsage       = "process_cpu_usage_percent"
	MemoryUsage    = "process_memory_usage_bytes"
	OpenFilesCount = "open_files_count"
)

We use these keys in node metadata

Variables ¶

View Source

var (
	MetadataTemplates = report.MetadataTemplates{
		PID:     {ID: PID, Label: "PID", From: report.FromLatest, Datatype: "number", Priority: 1},
		Cmdline: {ID: Cmdline, Label: "Command", From: report.FromLatest, Priority: 2},
		PPID:    {ID: PPID, Label: "Parent PID", From: report.FromLatest, Datatype: "number", Priority: 3},
		Threads: {ID: Threads, Label: "# Threads", From: report.FromLatest, Datatype: "number", Priority: 4},
	}

	MetricTemplates = report.MetricTemplates{
		CPUUsage:       {ID: CPUUsage, Label: "CPU", Format: report.PercentFormat, Priority: 1},
		MemoryUsage:    {ID: MemoryUsage, Label: "Memory", Format: report.FilesizeFormat, Priority: 2},
		OpenFilesCount: {ID: OpenFilesCount, Label: "Open Files", Format: report.IntegerFormat, Priority: 3},
	}
)

Exposed for testing

Functions ¶

func GetDeltaTotalJiffies ¶ added in v0.12.0

func GetDeltaTotalJiffies() (uint64, float64, error)

GetDeltaTotalJiffies returns the number of jiffies that have passed since it was last called. In that respect, it is side-effect-ful.

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) Name ¶ added in v0.10.0

func (*CachingWalker) Name() string

Name of this ticker, for metrics gathering

func (*CachingWalker) Tick ¶ added in v0.7.0

func (c *CachingWalker) Tick() error

Tick updates cached copy of process list

func (*CachingWalker) Walk ¶

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

Walk walks a cached copy of process list

type Jiffies ¶ added in v0.12.0

type Jiffies func() (uint64, float64, error)

Jiffies is the type for the function used to fetch the elapsed jiffies.

type Process ¶

type Process struct {
	PID, PPID      int
	Name           string
	Cmdline        string
	Threads        int
	Jiffies        uint64
	RSSBytes       uint64
	RSSBytesLimit  uint64
	OpenFilesCount int
	OpenFilesLimit uint64
}

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, jiffies Jiffies) *Reporter

NewReporter makes a new Reporter.

func (Reporter) Name ¶ added in v0.10.0

func (Reporter) Name() string

Name of this reporter, for metrics gathering

func (*Reporter) Report ¶

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

Report implements Reporter.

type Tree ¶

type Tree interface {
	GetParent(pid int) (int, error)
	GetChildren(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, Process)) error
}

Walker is something that walks the /proc directory

func NewWalker ¶

func NewWalker(procRoot string) Walker

NewWalker creates a new process Walker.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL