package process

Import Path
	github.com/shirou/gopsutil/v3/process (on go.dev)

Dependency Relation
	imports 23 packages, and imported by one package

Involved Source Files

	    process.go
	    process_linux.go
	    process_posix.go
Package-Level Type Names (total 11)

	/* sort by: alphabet | popularity */
	 type IOCountersStat (struct)

		Fields (total 4)
			ReadBytes uint64
			ReadCount uint64
			WriteBytes uint64
			WriteCount uint64
		Methods (only one)
			( IOCountersStat) String() string
		Implements (at least 2)
			 IOCountersStat : expvar.Var
			 IOCountersStat : fmt.Stringer
		As Outputs Of (at least 2)
			func (*Process).IOCounters() (*IOCountersStat, error)
			func (*Process).IOCountersWithContext(ctx context.Context) (*IOCountersStat, error)

	 type MemoryInfoExStat (struct)
		MemoryInfoExStat is different between OSes

		Fields (total 7)
			Data uint64
				// bytes

			Dirty uint64
				// bytes

			Lib uint64
				// bytes

			RSS uint64
				// bytes

			Shared uint64
				// bytes

			Text uint64
				// bytes

			VMS uint64
				// bytes

		Methods (only one)
			( MemoryInfoExStat) String() string
		Implements (at least 2)
			 MemoryInfoExStat : expvar.Var
			 MemoryInfoExStat : fmt.Stringer
		As Outputs Of (at least 2)
			func (*Process).MemoryInfoEx() (*MemoryInfoExStat, error)
			func (*Process).MemoryInfoExWithContext(ctx context.Context) (*MemoryInfoExStat, error)

	 type MemoryInfoStat (struct)

		Fields (total 7)
			Data uint64
				// bytes

			HWM uint64
				// bytes

			Locked uint64
				// bytes

			RSS uint64
				// bytes

			Stack uint64
				// bytes

			Swap uint64
				// bytes

			VMS uint64
				// bytes

		Methods (only one)
			( MemoryInfoStat) String() string
		Implements (at least 2)
			 MemoryInfoStat : expvar.Var
			 MemoryInfoStat : fmt.Stringer
		As Outputs Of (at least 2)
			func (*Process).MemoryInfo() (*MemoryInfoStat, error)
			func (*Process).MemoryInfoWithContext(ctx context.Context) (*MemoryInfoStat, error)

	 type MemoryMapsStat (struct)

		Fields (total 11)
			Anonymous uint64
			Path string
			PrivateClean uint64
			PrivateDirty uint64
			Pss uint64
			Referenced uint64
			Rss uint64
			SharedClean uint64
			SharedDirty uint64
			Size uint64
			Swap uint64
		Methods (only one)
			( MemoryMapsStat) String() string
				String returns JSON value of the process.

		Implements (at least 2)
			 MemoryMapsStat : expvar.Var
			 MemoryMapsStat : fmt.Stringer
		As Outputs Of (at least 2)
			func (*Process).MemoryMaps(grouped bool) (*[]MemoryMapsStat, error)
			func (*Process).MemoryMapsWithContext(ctx context.Context, grouped bool) (*[]MemoryMapsStat, error)

	 type NumCtxSwitchesStat (struct)

		Fields (total 2)
			Involuntary int64
			Voluntary int64
		Methods (only one)
			( NumCtxSwitchesStat) String() string
		Implements (at least 2)
			 NumCtxSwitchesStat : expvar.Var
			 NumCtxSwitchesStat : fmt.Stringer
		As Outputs Of (at least 2)
			func (*Process).NumCtxSwitches() (*NumCtxSwitchesStat, error)
			func (*Process).NumCtxSwitchesWithContext(ctx context.Context) (*NumCtxSwitchesStat, error)

	 type OpenFilesStat (struct)

		Fields (total 2)
			Fd uint64
			Path string
		Methods (only one)
			( OpenFilesStat) String() string
		Implements (at least 2)
			 OpenFilesStat : expvar.Var
			 OpenFilesStat : fmt.Stringer
		As Outputs Of (at least 2)
			func (*Process).OpenFiles() ([]OpenFilesStat, error)
			func (*Process).OpenFilesWithContext(ctx context.Context) ([]OpenFilesStat, error)

	 type PageFaultsStat (struct)

		Fields (total 4)
			ChildMajorFaults uint64
			ChildMinorFaults uint64
			MajorFaults uint64
			MinorFaults uint64
		As Outputs Of (at least 2)
			func (*Process).PageFaults() (*PageFaultsStat, error)
			func (*Process).PageFaultsWithContext(ctx context.Context) (*PageFaultsStat, error)

	 type Process (struct)

		Fields (only one)
			Pid int32
		Methods (total 93)
			(*Process) Background() (bool, error)
				Background returns true if the process is in background, false otherwise.

			(*Process) BackgroundWithContext(ctx context.Context) (bool, error)
			(*Process) CPUAffinity() ([]int32, error)
				CPUAffinity returns CPU affinity of the process.

			(*Process) CPUAffinityWithContext(ctx context.Context) ([]int32, error)
			(*Process) CPUPercent() (float64, error)
				CPUPercent returns how many percent of the CPU time this process uses

			(*Process) CPUPercentWithContext(ctx context.Context) (float64, error)
			(*Process) Children() ([]*Process, error)
				Children returns the children of the process represented as a slice
				of pointers to Process type.

			(*Process) ChildrenWithContext(ctx context.Context) ([]*Process, error)
			(*Process) Cmdline() (string, error)
				Cmdline returns the command line arguments of the process as a string with
				each argument separated by 0x20 ascii character.

			(*Process) CmdlineSlice() ([]string, error)
				CmdlineSlice returns the command line arguments of the process as a slice with each
				element being an argument.

			(*Process) CmdlineSliceWithContext(ctx context.Context) ([]string, error)
			(*Process) CmdlineWithContext(ctx context.Context) (string, error)
			(*Process) Connections() ([]net.ConnectionStat, error)
				Connections returns a slice of net.ConnectionStat used by the process.
				This returns all kind of the connection. This means TCP, UDP or UNIX.

			(*Process) ConnectionsMax(max int) ([]net.ConnectionStat, error)
				ConnectionsMax returns a slice of net.ConnectionStat used by the process at most `max`.

			(*Process) ConnectionsMaxWithContext(ctx context.Context, max int) ([]net.ConnectionStat, error)
			(*Process) ConnectionsWithContext(ctx context.Context) ([]net.ConnectionStat, error)
			(*Process) CreateTime() (int64, error)
				CreateTime returns created time of the process in milliseconds since the epoch, in UTC.

			(*Process) CreateTimeWithContext(ctx context.Context) (int64, error)
			(*Process) Cwd() (string, error)
				Cwd returns current working directory of the process.

			(*Process) CwdWithContext(ctx context.Context) (string, error)
			(*Process) Environ() ([]string, error)
				Environ returns the environment variables of the process.

			(*Process) EnvironWithContext(ctx context.Context) ([]string, error)
			(*Process) Exe() (string, error)
				Exe returns executable path of the process.

			(*Process) ExeWithContext(ctx context.Context) (string, error)
			(*Process) Foreground() (bool, error)
				Foreground returns true if the process is in foreground, false otherwise.

			(*Process) ForegroundWithContext(ctx context.Context) (bool, error)
			(*Process) Gids() ([]int32, error)
				Gids returns group ids of the process as a slice of the int

			(*Process) GidsWithContext(ctx context.Context) ([]int32, error)
			(*Process) Groups() ([]int32, error)
				Groups returns all group IDs(include supplementary groups) of the process as a slice of the int

			(*Process) GroupsWithContext(ctx context.Context) ([]int32, error)
			(*Process) IOCounters() (*IOCountersStat, error)
				IOCounters returns IO Counters.

			(*Process) IOCountersWithContext(ctx context.Context) (*IOCountersStat, error)
			(*Process) IOnice() (int32, error)
				IOnice returns process I/O nice value (priority).

			(*Process) IOniceWithContext(ctx context.Context) (int32, error)
			(*Process) IsRunning() (bool, error)
				IsRunning returns whether the process is still running or not.

			(*Process) IsRunningWithContext(ctx context.Context) (bool, error)
			(*Process) Kill() error
				Kill sends SIGKILL to the process.

			(*Process) KillWithContext(ctx context.Context) error
			(*Process) MemoryInfo() (*MemoryInfoStat, error)
				MemoryInfo returns generic process memory information,
				such as RSS and VMS.

			(*Process) MemoryInfoEx() (*MemoryInfoExStat, error)
				MemoryInfoEx returns platform-specific process memory information.

			(*Process) MemoryInfoExWithContext(ctx context.Context) (*MemoryInfoExStat, error)
			(*Process) MemoryInfoWithContext(ctx context.Context) (*MemoryInfoStat, error)
			(*Process) MemoryMaps(grouped bool) (*[]MemoryMapsStat, error)
				MemoryMaps get memory maps from /proc/(pid)/smaps

			(*Process) MemoryMapsWithContext(ctx context.Context, grouped bool) (*[]MemoryMapsStat, error)
			(*Process) MemoryPercent() (float32, error)
				MemoryPercent returns how many percent of the total RAM this process uses

			(*Process) MemoryPercentWithContext(ctx context.Context) (float32, error)
			(*Process) Name() (string, error)
				Name returns name of the process.

			(*Process) NameWithContext(ctx context.Context) (string, error)
			(*Process) Nice() (int32, error)
				Nice returns a nice value (priority).

			(*Process) NiceWithContext(ctx context.Context) (int32, error)
			(*Process) NumCtxSwitches() (*NumCtxSwitchesStat, error)
				NumCtxSwitches returns the number of the context switches of the process.

			(*Process) NumCtxSwitchesWithContext(ctx context.Context) (*NumCtxSwitchesStat, error)
			(*Process) NumFDs() (int32, error)
				NumFDs returns the number of File Descriptors used by the process.

			(*Process) NumFDsWithContext(ctx context.Context) (int32, error)
			(*Process) NumThreads() (int32, error)
				NumThreads returns the number of threads used by the process.

			(*Process) NumThreadsWithContext(ctx context.Context) (int32, error)
			(*Process) OpenFiles() ([]OpenFilesStat, error)
				OpenFiles returns a slice of OpenFilesStat opend by the process.
				OpenFilesStat includes a file path and file descriptor.

			(*Process) OpenFilesWithContext(ctx context.Context) ([]OpenFilesStat, error)
			(*Process) PageFaults() (*PageFaultsStat, error)
				PageFaults returns the process's page fault counters.

			(*Process) PageFaultsWithContext(ctx context.Context) (*PageFaultsStat, error)
			(*Process) Parent() (*Process, error)
				Parent returns parent Process of the process.

			(*Process) ParentWithContext(ctx context.Context) (*Process, error)
				ParentWithContext returns parent Process of the process.

			(*Process) Percent(interval time.Duration) (float64, error)
				If interval is 0, return difference from last call(non-blocking).
				If interval > 0, wait interval sec and return difference between start and end.

			(*Process) PercentWithContext(ctx context.Context, interval time.Duration) (float64, error)
			(*Process) Ppid() (int32, error)
				Ppid returns Parent Process ID of the process.

			(*Process) PpidWithContext(ctx context.Context) (int32, error)
			(*Process) Resume() error
				Resume sends SIGCONT to the process.

			(*Process) ResumeWithContext(ctx context.Context) error
			(*Process) Rlimit() ([]RlimitStat, error)
				Rlimit returns Resource Limits.

			(*Process) RlimitUsage(gatherUsed bool) ([]RlimitStat, error)
				RlimitUsage returns Resource Limits.
				If gatherUsed is true, the currently used value will be gathered and added
				to the resulting RlimitStat.

			(*Process) RlimitUsageWithContext(ctx context.Context, gatherUsed bool) ([]RlimitStat, error)
			(*Process) RlimitWithContext(ctx context.Context) ([]RlimitStat, error)
			(*Process) SendSignal(sig Signal) error
				SendSignal sends a unix.Signal to the process.

			(*Process) SendSignalWithContext(ctx context.Context, sig syscall.Signal) error
			(*Process) Status() ([]string, error)
				Status returns the process status.
				Return value could be one of these.
				R: Running S: Sleep T: Stop I: Idle
				Z: Zombie W: Wait L: Lock
				The character is same within all supported platforms.

			(*Process) StatusWithContext(ctx context.Context) ([]string, error)
			( Process) String() string
			(*Process) Suspend() error
				Suspend sends SIGSTOP to the process.

			(*Process) SuspendWithContext(ctx context.Context) error
			(*Process) Terminal() (string, error)
				Terminal returns a terminal which is associated with the process.

			(*Process) TerminalWithContext(ctx context.Context) (string, error)
			(*Process) Terminate() error
				Terminate sends SIGTERM to the process.

			(*Process) TerminateWithContext(ctx context.Context) error
			(*Process) Tgid() (int32, error)
				Tgid returns thread group id of the process.

			(*Process) TgidWithContext(ctx context.Context) (int32, error)
			(*Process) Threads() (map[int32]*cpu.TimesStat, error)
			(*Process) ThreadsWithContext(ctx context.Context) (map[int32]*cpu.TimesStat, error)
			(*Process) Times() (*cpu.TimesStat, error)
				Times returns CPU times of the process.

			(*Process) TimesWithContext(ctx context.Context) (*cpu.TimesStat, error)
			(*Process) Uids() ([]int32, error)
				Uids returns user ids of the process as a slice of the int

			(*Process) UidsWithContext(ctx context.Context) ([]int32, error)
			(*Process) Username() (string, error)
				Username returns a username of the process.

			(*Process) UsernameWithContext(ctx context.Context) (string, error)
		Implements (at least 2)
			 Process : expvar.Var
			 Process : fmt.Stringer
		As Outputs Of (at least 8)
			func NewProcess(pid int32) (*Process, error)
			func NewProcessWithContext(ctx context.Context, pid int32) (*Process, error)
			func Processes() ([]*Process, error)
			func ProcessesWithContext(ctx context.Context) ([]*Process, error)
			func (*Process).Children() ([]*Process, error)
			func (*Process).ChildrenWithContext(ctx context.Context) ([]*Process, error)
			func (*Process).Parent() (*Process, error)
			func (*Process).ParentWithContext(ctx context.Context) (*Process, error)

	 type RlimitStat (struct)

		Fields (total 4)
			Hard uint64
			Resource int32
			Soft uint64
			Used uint64
		Methods (only one)
			( RlimitStat) String() string
		Implements (at least 2)
			 RlimitStat : expvar.Var
			 RlimitStat : fmt.Stringer
		As Outputs Of (at least 4)
			func (*Process).Rlimit() ([]RlimitStat, error)
			func (*Process).RlimitUsage(gatherUsed bool) ([]RlimitStat, error)
			func (*Process).RlimitUsageWithContext(ctx context.Context, gatherUsed bool) ([]RlimitStat, error)
			func (*Process).RlimitWithContext(ctx context.Context) ([]RlimitStat, error)

	 type Signal = syscall.Signal (basic type)
	 type SignalInfoStat (struct)

		Fields (total 5)
			Blocked uint64
			Caught uint64
			Ignored uint64
			PendingProcess uint64
			PendingThread uint64


Package-Level Functions (total 9)

	 func EnableBootTimeCache(enable bool)
		EnableBootTimeCache change cache behavior of BootTime. If true, cache BootTime value. Default is false.

	 func NewProcess(pid int32) (*Process, error)
		NewProcess creates a new Process instance, it only stores the pid and
		checks that the process exists. Other method on Process can be used
		to get more information about the process. An error will be returned
		if the process does not exist.

	 func NewProcessWithContext(ctx context.Context, pid int32) (*Process, error)
	 func PidExists(pid int32) (bool, error)
	 func PidExistsWithContext(ctx context.Context, pid int32) (bool, error)
	 func Pids() ([]int32, error)
		Pids returns a slice of process ID list which are running now.

	 func PidsWithContext(ctx context.Context) ([]int32, error)
	 func Processes() ([]*Process, error)
		Processes returns a slice of pointers to Process structs for all
		currently running processes.

	 func ProcessesWithContext(ctx context.Context) ([]*Process, error)
Package-Level Variables (total 3)

	  var ErrorNoChildren error
	  var ErrorNotPermitted error
	  var ErrorProcessNotRunning error
Package-Level Constants (total 29)

	const Blocked = "blocked"
		Blocked marks a task waiting on a short, uninterruptible operation (usually I/O)

	const Daemon = "daemon"
		Solaris states. See https://github.com/collectd/collectd/blob/1da3305c10c8ff9a63081284cf3d4bb0f6daffd8/src/processes.c#L2115

	const Detached = "detached"
		Process status

	const Idle = "idle"
		Idle marks a task sleeping for more than about 20 seconds

	const Lock = "lock"
		Lock marks a task waiting to acquire a lock

	const Orphan = "orphan"
		Process status

	const RLIMIT_AS int32 = 9
		Resource limit constants are from /usr/include/x86_64-linux-gnu/bits/resource.h
		from libc6-dev package in Ubuntu 16.10

	const RLIMIT_CORE int32 = 4
		Resource limit constants are from /usr/include/x86_64-linux-gnu/bits/resource.h
		from libc6-dev package in Ubuntu 16.10

	const RLIMIT_CPU int32 = 0
		Resource limit constants are from /usr/include/x86_64-linux-gnu/bits/resource.h
		from libc6-dev package in Ubuntu 16.10

	const RLIMIT_DATA int32 = 2
		Resource limit constants are from /usr/include/x86_64-linux-gnu/bits/resource.h
		from libc6-dev package in Ubuntu 16.10

	const RLIMIT_FSIZE int32 = 1
		Resource limit constants are from /usr/include/x86_64-linux-gnu/bits/resource.h
		from libc6-dev package in Ubuntu 16.10

	const RLIMIT_LOCKS int32 = 10
		Resource limit constants are from /usr/include/x86_64-linux-gnu/bits/resource.h
		from libc6-dev package in Ubuntu 16.10

	const RLIMIT_MEMLOCK int32 = 8
		Resource limit constants are from /usr/include/x86_64-linux-gnu/bits/resource.h
		from libc6-dev package in Ubuntu 16.10

	const RLIMIT_MSGQUEUE int32 = 12
		Resource limit constants are from /usr/include/x86_64-linux-gnu/bits/resource.h
		from libc6-dev package in Ubuntu 16.10

	const RLIMIT_NICE int32 = 13
		Resource limit constants are from /usr/include/x86_64-linux-gnu/bits/resource.h
		from libc6-dev package in Ubuntu 16.10

	const RLIMIT_NOFILE int32 = 7
		Resource limit constants are from /usr/include/x86_64-linux-gnu/bits/resource.h
		from libc6-dev package in Ubuntu 16.10

	const RLIMIT_NPROC int32 = 6
		Resource limit constants are from /usr/include/x86_64-linux-gnu/bits/resource.h
		from libc6-dev package in Ubuntu 16.10

	const RLIMIT_RSS int32 = 5
		Resource limit constants are from /usr/include/x86_64-linux-gnu/bits/resource.h
		from libc6-dev package in Ubuntu 16.10

	const RLIMIT_RTPRIO int32 = 14
		Resource limit constants are from /usr/include/x86_64-linux-gnu/bits/resource.h
		from libc6-dev package in Ubuntu 16.10

	const RLIMIT_RTTIME int32 = 15
		Resource limit constants are from /usr/include/x86_64-linux-gnu/bits/resource.h
		from libc6-dev package in Ubuntu 16.10

	const RLIMIT_SIGPENDING int32 = 11
		Resource limit constants are from /usr/include/x86_64-linux-gnu/bits/resource.h
		from libc6-dev package in Ubuntu 16.10

	const RLIMIT_STACK int32 = 3
		Resource limit constants are from /usr/include/x86_64-linux-gnu/bits/resource.h
		from libc6-dev package in Ubuntu 16.10

	const Running = "running"
		Running marks a task a running or runnable (on the run queue)

	const Sleep = "sleep"
		Sleep marks task waiting for short, interruptible operation

	const Stop = "stop"
		Stop marks a stopped process

	const System = "system"
		Process status

	const UnknownState = ""
		Process status

	const Wait = "wait"
		Wait marks an idle interrupt thread (or paging in pre 2.6.xx Linux)

	const Zombie = "zombie"
		Zombie marks a defunct process, terminated but not reaped by its parent

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.