Home

Awesome

gopsutil: psutil for golang

Test Go Reference Calendar Versioning

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

migration

v4 migration

There are some breaking changes. Please see v4 release note.

Tag semantics

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

For example, v4.24.04 means

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

These have partial support:

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

Usage

package main

import (
    "fmt"

    "github.com/shirou/gopsutil/v4/mem"
)

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 alternative locations for various system directories by using the following environment variables:

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.

Ex struct (from v4.24.5)

gopsutil is designed to work across multiple platforms. However, there are differences in the information available on different platforms, such as memory information that exists on Linux but not on Windows.

As of v4.24.5, to access this platform-specific information, gopsutil provides functions named Ex within the package. Currently, these functions are available in the mem and sensor packages.

The Ex structs are specific to each platform. For example, on Linux, there is an ExLinux struct, which can be obtained using the mem.NewExLinux() function. On Windows, it's mem.ExWindows(). These Ex structs provide platform-specific information.

ex := NewExWindows()
v, err := ex.VirtualMemory()
if err != nil {
    panic(err)
}

fmt.Println(v.VirtualAvail)
fmt.Println(v.VirtualTotal)

// Output:
// 140731958648832
// 140737488224256

gopsutil aims to minimize platform differences by offering common functions. However, there are many requests to obtain unique information for each platform. The Ex structs are designed to meet those requests. Additional functionalities might be added in the future. The use of these structures makes it clear that the information they provide is specific to each platform, which is why they have been designed in this way.

Documentation

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

Requirements

More Info

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

Some code is ported from Ohai. Many thanks.

Current Status

nameLinuxFreeBSDOpenBSDmacOSWindowsSolarisPlan 9AIX
cpu_timesxxxxxbx
cpu_countxxxxxxx
cpu_percentxxxxxx
cpu_times_percentxxxxxx
virtual_memoryxxxxxbxx
swap_memoryxxxxxX
disk_partitionsxxxxxx
disk_io_countersxxxxx
disk_usagexxxxxx
net_io_countersxxxbxx
boot_timexxxxxX
usersxxxxxx
pidsxxxxx
pid_existsxxxxx
net_connectionsxxxxx
net_protocolsxx
net_if_addrsx
net_if_statsx
netfilter_conntrackx
sensors_temperaturexxxx

Process class

nameLinuxFreeBSDOpenBSDmacOSWindows
pidxxxxx
ppidxxxxx
namexxxxx
cmdlinexxxxx
create_timexxx
statusxxxx
cwdxxxxx
exexxxx
uidsxxxx
gidsxxxx
terminalxxx
io_countersxxxx
nicexxxxx
num_fdsxx
num_ctx_switchesx
num_threadsxxxxx
cpu_timesxx
memory_infoxxxxx
memory_mapsx
open_filesxx
send_signalxxxx
suspendxxxxx
resumexxxxx
terminatexxxxx
killxxxx
usernamexxxxx
ionice
rlimitx
num_handlers
threadsx
cpu_percentxxxx
cpu_affinity
memory_percentxx
parentxxxx
childrenxxxxx
connectionsxxx
is_running
page_faultsx

gopsutil Original Metrics

itemLinuxFreeBSDOpenBSDmacOSWindowsSolarisAIX
HostInfo
hostnamexxxxxxX
uptimexxxxxx
processxxxx
osxxxxxxx
platformxxxxxx
platformfamilyxxxxxx
virtualizationx
CPU
VendorIDxxxxxxx
Familyxxxxxxx
Modelxxxxxxx
Steppingxxxxxx
PhysicalIDxx
CoreIDxx
Coresxxxxx
ModelNamexxxxxxx
Microcodexx
LoadAvg
Load1xxxxxxx
Load5xxxxxxx
Load15xxxxxxx
Docker GetDockerID
container idxnononononono
Docker CgroupsCPU
userxnononononono
systemxnononononono
Docker CgroupsMem
variousxnononononono

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.