process

type EnvironmentParams struct {
	Keys     []string `json:"keys,omitempty"`
	Prefixes []string `json:"prefixes,omitempty"`
}

type Node struct {
	tracing.Truncation
	Key        string     `json:"key" pretty:"hide" filter:"exact"`
	ParentKey  string     `json:"parentKey,omitempty" pretty:"hide" filter:"exact"`
	PID        int        `json:"pid" pretty:"label=PID" filter:"terms"`
	PPID       int        `json:"ppid" pretty:"label=PPID"`
	Name       string     `json:"name" filter:"terms"`
	Command    string     `json:"command" filter:"text"`
	CWD        string     `json:"cwd,omitempty" pretty:"label=Cwd"`
	Status     string     `json:"status" filter:"terms"`
	IsRoot     bool       `json:"isRoot,omitempty" pretty:"hide"`
	StartedAt  time.Time  `json:"startedAt" pretty:"label=Started" sort:"startedAt"`
	ExitedAt   *time.Time `json:"exitedAt,omitempty" pretty:"label=Exited" sort:"exitedAt"`
	LastSeenAt time.Time  `json:"lastSeenAt" pretty:"hide"`
	// CPUPercent is the CPU% over the latest window of at least a second, per
	// core; nil until that window has passed. PeakCPUPercent is the highest
	// known one.
	CPUPercent     *float64 `json:"cpuPercent,omitempty" pretty:"label=CPU %" sort:"cpuPercent"`
	RSSBytes       uint64   `json:"rssBytes" pretty:"label=RSS,type=bytes" sort:"rssBytes"`
	PeakCPUPercent *float64 `json:"peakCpuPercent,omitempty" pretty:"label=Peak CPU %" sort:"peakCpuPercent"`
	PeakRSSBytes   uint64   `json:"peakRssBytes" pretty:"label=Peak RSS,type=bytes" sort:"peakRssBytes"`
	// StackTransports are the stack dump transports (the stacks kind's) its
	// stacks can be dumped with.
	StackTransports []StackTransport `json:"stackTransports,omitempty" pretty:"hide"`
	// Environment is the process's environment as its node was created, its
	// secrets masked, when the capture reads it (TreeParams.Environment);
	// EnvironmentError is why it could not be read.
	Environment      map[string]string `json:"environment,omitempty" pretty:"hide" filter:"none"`
	EnvironmentError string            `json:"environmentError,omitempty" pretty:"hide"`
}

type Params struct {
	// RootPID is the process whose tree is captured; zero is the host's own.
	RootPID int `json:"rootPid,omitempty" clicky:"title=Root PID"`
	// Interval, a duration such as 1s, is how often the tree is sampled.
	// Empty is a second.
	Interval string `json:"interval,omitempty" clicky:"title=Interval"`
}

type Sample struct {
	SampledAt time.Time `json:"sampledAt" pretty:"label=Sampled" sort:"sampledAt"`
	Tick      int64     `json:"tick" sort:"tick"`
	Key       string    `json:"key" pretty:"hide" filter:"exact"`
	PID       int       `json:"pid" pretty:"label=PID" filter:"terms"`
	// CPUPercent is the CPU% over the process's latest window of at least a
	// second, per core; nil until that window has passed.
	CPUPercent    *float64 `json:"cpuPercent,omitempty" pretty:"label=CPU %" sort:"cpuPercent"`
	MemoryPercent float64  `json:"memoryPercent" pretty:"label=Memory %" sort:"memoryPercent"`
	RSSBytes      uint64   `json:"rssBytes" pretty:"label=RSS,type=bytes" sort:"rssBytes"`
	// DiskReadBytes and DiskWriteBytes are what the process read from and
	// wrote to disk since it started; nil when it exited before they were read.
	DiskReadBytes  *uint64 `json:"diskReadBytes,omitempty" pretty:"label=Disk read,type=bytes" sort:"diskReadBytes"`
	DiskWriteBytes *uint64 `json:"diskWriteBytes,omitempty" pretty:"label=Disk written,type=bytes" sort:"diskWriteBytes"`
	// The counts of each armed facet (SampleParams.Facets), every tick.
	OpenFiles   *int `json:"openFiles,omitempty" pretty:"label=Open files" sort:"openFiles"`
	Sockets     *int `json:"sockets,omitempty" pretty:"label=Sockets" sort:"sockets"`
	Ports       *int `json:"ports,omitempty" pretty:"label=Ports" sort:"ports"`
	Connections *int `json:"connections,omitempty" pretty:"label=Connections" sort:"connections"`
	// The lists of each armed facet, at the first tick and at each tick it
	// differs from the process's previous stored list; a list that emptied is
	// told by its count of 0.
	OpenFileList   []clickyprocess.Descriptor `json:"openFileList,omitempty" pretty:"hide" filter:"none"`
	SocketList     []clickyprocess.Descriptor `json:"socketList,omitempty" pretty:"hide" filter:"none"`
	PortList       []clickyprocess.Descriptor `json:"portList,omitempty" pretty:"hide" filter:"none"`
	ConnectionList []clickyprocess.Descriptor `json:"connectionList,omitempty" pretty:"hide" filter:"none"`
}

type SampleCheckpoint struct {
	Key string `json:"key"`
}

type SampleParams struct {
	Params
	// Facets are read of every process at each tick, with one lsof call for
	// the whole tree: each one's count every tick, its list when it changed.
	Facets []string `json:"facets,omitempty" clicky:"title=Facets"`
}

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

type StackTransport struct {
	Transport   string `json:"transport"`
	Destructive bool   `json:"destructive"`
}

type TransportLister interface {
	Transports(pid int) []StackTransport
}

type TreeOptions struct {
	// Dumpers list the stack transports of each node; nil lists none.
	Dumpers TransportLister
}

type TreeParams struct {
	Params
	// Environment reads each process's environment once, as its node is
	// created, limited to these keys and prefixes; empty ones read all of it.
	// Absent reads none.
	Environment *EnvironmentParams `json:"environment,omitempty" clicky:"title=Environment"`
}