sysinfo

README

go-sysinfo

go-sysinfo is a library for collecting system information. This includes information about the host machine and processes running on the host.

The available features vary based on what has been implemented by the "provider" for the operating system. At runtime you check to see if additional interfaces are implemented by the returned Host or Process. For example:

process, err := sysinfo.Self()
if err != nil {
	return err
}

if handleCounter, ok := process.(types.OpenHandleCounter); ok {
	count, err := handleCounter.OpenHandleCount()
	if err != nil {
		return err
	}
	log.Printf("%d open handles", count)
}

These tables show what methods are implemented as well as the extra interfaces that are implemented.

Host Features	Darwin	Linux	Windows	AIX
Info()	x	x	x	x
Memory()	x	x	x	x
CPUTimer	x	x	x	x
LoadAverage	x	x
VMStat		x
NetworkCounters		x

Process Features	Darwin	Linux	Windows	AIX
Info()	x	x	x	x
Memory()	x	x	x	x
User()	x	x	x	x
Parent()	x	x	x	x
CPUTimer	x	x	x	x
Environment	x	x		x
OpenHandleEnumerator		x
OpenHandleCounter		x
Seccomp		x
Capabilities		x
NetworkCounters		x

GOOS / GOARCH Pairs

This table lists the OS and architectures for which a "provider" is implemented.

GOOS / GOARCH	Requires CGO	Tested
aix/ppc64	x
darwin/amd64	optional *	x
darwin/arm64	optional *	x
linux/386
linux/amd64		x
linux/arm
linux/arm64
linux/mips
linux/mips64
linux/mips64le
linux/mipsle
linux/ppc64
linux/ppc64le
linux/riscv64
linux/s390x
windows/amd64		x
windows/arm64
windows/arm

• On darwin (macOS) host information like machineid and process information like memory, cpu, user and starttime require cgo.

Supported Go versions

go-sysinfo supports the two most recent Go releases.

Documentation

Index

• func Go() types.GoInfo
• func Host(opts ...ProviderOption) (types.Host, error)
• func Process(pid int, opts ...ProviderOption) (types.Process, error)
• func Processes(opts ...ProviderOption) ([]types.Process, error)
• func Self(opts ...ProviderOption) (types.Process, error)
• type ProviderOption
  • func WithHostFS(hostfs string) ProviderOption

Functions

func Go

func Go() types.GoInfo

Go returns information about the Go runtime.

func Host

func Host(opts ...ProviderOption) (types.Host, error)

Host returns information about host on which this process is running. If host information collection is not implemented for this platform then types.ErrNotImplemented is returned. On Darwin (macOS) a types.ErrNotImplemented is returned with cgo disabled.

func Process

func Process(pid int, opts ...ProviderOption) (types.Process, error)

Process returns a types.Process object representing the process associated with the given PID. The types.Process object can be used to query information about the process. If process information collection is not implemented for this platform then types.ErrNotImplemented is returned.

func Processes

func Processes(opts ...ProviderOption) ([]types.Process, error)

Processes return a list of all processes. If process information collection is not implemented for this platform then types.ErrNotImplemented is returned.

func Self

func Self(opts ...ProviderOption) (types.Process, error)

Self return a types.Process object representing this process. If process information collection is not implemented for this platform then types.ErrNotImplemented is returned.

Types

type ProviderOption

type ProviderOption func(*registry.ProviderOptions)

func WithHostFS

func WithHostFS(hostfs string) ProviderOption

WithHostFS returns a provider with a custom HostFS root path, enabling use of the library from within a container, or an alternate root path on linux. For example, WithHostFS("/hostfs") can be used when /hostfs points to the root filesystem of the container host. For full functionality, the alternate hostfs should have:

• /proc
• /var
• /etc