Clone this repo:
  1. 8912445 Merge pull request #1640 from MDrakos/fallback_ftxt by shirou · 9 days ago master
  2. 3afb2ed Merge pull request #1643 from shirou/dependabot/github_actions/golangci/golangci-lint-action-6.0.1 by shirou · 11 days ago
  3. 5a0c0a9 Merge pull request #1647 from zhanluxianshen/add-arm64-github-pr by shirou · 11 days ago
  4. 193aafb Merge pull request #1646 from zhanluxianshen/clean-mktypes.sh by shirou · 11 days ago
  5. 11907e3 add arm/arm64 category for github pr label. by zhanluxianshen · 12 days ago

gopsutil: psutil for golang

Test Coverage Status Go Reference Go Documentation Calendar Versioning

This is a port of psutil (https://github.com/giampaolo/psutil). The challenge is porting all psutil functions on some architectures.

v3 migration

From v3.20.10, gopsutil becomes v3 which breaks backwards compatibility. See v3Changes.md for more detailed changes.

Tag semantics

gopsutil tag policy is almost same as Semantic Versioning, but automatically increases like Ubuntu versioning.

For example, v2.17.04 means

  • v2: major version
  • 17: release year, 2017
  • 04: release month

gopsutil aims to keep backwards compatibility until major version change.

Tagged at every end of month, but if there are only a few commits, it can be skipped.

Available Architectures

  • FreeBSD i386/amd64/arm
  • Linux i386/amd64/arm(raspberry pi)
  • Windows i386/amd64/arm/arm64
  • Darwin amd64/arm64
  • OpenBSD i386/amd64/armv7/arm64/riscv64 (Thank you @mpfz0r!)
  • Solaris amd64 (developed and tested on SmartOS/Illumos, Thank you @jen20!)

These have partial support:

  • CPU on DragonFly BSD (#893, Thank you @gballet!)
  • host on Linux RISC-V (#896, Thank you @tklauser!)

All works are implemented without cgo by porting C structs to golang structs.

Usage

package main

import (
    "fmt"

    "github.com/shirou/gopsutil/v3/mem"
    // "github.com/shirou/gopsutil/mem"  // to use v2
)

func main() {
    v, _ := mem.VirtualMemory()

    // almost every return value is a struct
    fmt.Printf("Total: %v, Free:%v, UsedPercent:%f%%\n", v.Total, v.Free, v.UsedPercent)

    // convert to JSON. String() is also implemented
    fmt.Println(v)
}

The output is below.

Total: 3179569152, Free:284233728, UsedPercent:84.508194%
{"total":3179569152,"available":492572672,"used":2895335424,"usedPercent":84.50819439828305, (snip...)}

You can set an alternative location to /proc by setting the HOST_PROC environment variable.

You can set an alternative location to /sys by setting the HOST_SYS environment variable.

You can set an alternative location to /etc by setting the HOST_ETC environment variable.

You can set an alternative location to /var by setting the HOST_VAR environment variable.

You can set an alternative location to /run by setting the HOST_RUN environment variable.

You can set an alternative location to /dev by setting the HOST_DEV environment variable.

You can set an alternative location to / by setting the HOST_ROOT environment variable.

You can set an alternative location to /proc/N/mountinfo by setting the HOST_PROC_MOUNTINFO environment variable.

Adding settings using context (from v3.23.6)

As of v3.23.6, it is now possible to pass a path location using context: import "github.com/shirou/gopsutil/v3/common" and pass a context with common.EnvMap set to common.EnvKey, and the location will be used within each function.

	ctx := context.WithValue(context.Background(), 
		common.EnvKey, common.EnvMap{common.HostProcEnvKey: "/myproc"},
	)
	v, err := mem.VirtualMemoryWithContext(ctx)

First priority is given to the value set in context, then the value from the environment variable, and finally the default location.

Caching

As of v3.24.1, it is now possible to cached some values. These values default to false, not cached.

Be very careful that enabling the cache may cause inconsistencies. For example, if you enable caching of boottime on Linux, be aware that unintended values may be returned if the boottime is changed by NTP after booted.

  • host
    • EnableBootTimeCache
  • process
    • EnableBootTimeCache

Documentation

See https://pkg.go.dev/github.com/shirou/gopsutil/v3 or https://godocs.io/github.com/shirou/gopsutil/v3

Requirements

  • go1.16 or above is required.

More Info

Several methods have been added which are not present in psutil, but will provide useful information.

  • host/HostInfo() (linux)
    • Hostname
    • Uptime
    • Procs
    • OS (ex: “linux”)
    • Platform (ex: “ubuntu”, “arch”)
    • PlatformFamily (ex: “debian”)
    • PlatformVersion (ex: “Ubuntu 13.10”)
    • VirtualizationSystem (ex: “LXC”)
    • VirtualizationRole (ex: “guest”/“host”)
  • IOCounters
  • cpu/CPUInfo() (linux, freebsd)
    • CPU (ex: 0, 1, ...)
    • VendorID (ex: “GenuineIntel”)
    • Family
    • Model
    • Stepping
    • PhysicalID
    • CoreID
    • Cores (ex: 2)
    • ModelName (ex: “Intel(R) Core(TM) i7-2640M CPU @ 2.80GHz”)
    • Mhz
    • CacheSize
    • Flags (ex: “fpu vme de pse tsc msr pae mce cx8 ...”)
    • Microcode
  • load/Avg() (linux, freebsd, solaris)
    • Load1
    • Load5
    • Load15
  • docker/GetDockerIDList() (linux only)
    • container id list ([]string)
  • docker/CgroupCPU() (linux only)
    • user
    • system
  • docker/CgroupMem() (linux only)
    • various status
  • net_protocols (linux only)
    • system wide stats on network protocols (i.e IP, TCP, UDP, etc.)
    • sourced from /proc/net/snmp
  • iptables nf_conntrack (linux only)
    • system wide stats on netfilter conntrack module
    • sourced from /proc/sys/net/netfilter/nf_conntrack_count

Some code is ported from Ohai. Many thanks.

Current Status

  • x: works
  • b: almost works, but something is broken
nameLinuxFreeBSDOpenBSDmacOSWindowsSolarisPlan 9
cpu_timesxxxxxb
cpu_countxxxxxx
cpu_percentxxxxx
cpu_times_percentxxxxx
virtual_memoryxxxxxbx
swap_memoryxxxxx
disk_partitionsxxxxx
disk_io_countersxxx
disk_usagexxxxx
net_io_countersxxxbx
boot_timexxxxx
usersxxxxx
pidsxxxxx
pid_existsxxxxx
net_connectionsxxxx
net_protocolsx
net_if_addrs
net_if_stats
netfilter_conntrackx

Process class

nameLinuxFreeBSDOpenBSDmacOSWindows
pidxxxxx
ppidxxxxx
namexxxxx
cmdlinexxxx
create_timexxx
statusxxxx
cwdxxx
exexxxx
uidsxxxx
gidsxxxx
terminalxxx
io_countersxxxx
nicexxxxx
num_fdsx
num_ctx_switchesx
num_threadsxxxxx
cpu_timesxx
memory_infoxxxxx
memory_info_exx
memory_mapsx
open_filesx
send_signalxxxx
suspendxxxx
resumexxxx
terminatexxxxx
killxxxx
usernamexxxxx
ionice
rlimitx
num_handlers
threadsx
cpu_percentxxxx
cpu_affinity
memory_percentxx
parentxxxx
childrenxxxxx
connectionsxxx
is_running
page_faultsx

Original Metrics

itemLinuxFreeBSDOpenBSDmacOSWindowsSolaris
HostInfo
hostnamexxxxxx
uptimexxxxx
processxxxx
osxxxxxx
platformxxxxx
platformfamilyxxxxx
virtualizationx
CPU
VendorIDxxxxxx
Familyxxxxxx
Modelxxxxxx
Steppingxxxxxx
PhysicalIDxx
CoreIDxx
Coresxxx
ModelNamexxxxxx
Microcodexx
LoadAvg
Load1xxxx
Load5xxxx
Load15xxxx
GetDockerID
container idxnononono
CgroupsCPU
userxnononono
systemxnononono
CgroupsMem
variousxnononono
  • future work
    • process_iter
    • wait_procs
    • Process class
      • as_dict
      • wait

License

New BSD License (same as psutil)

Related Works

I have been influenced by the following great works:

How to Contribute

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am ‘Add some feature’)
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

English is not my native language, so PRs correcting grammar or spelling are welcome and appreciated.