gopsutil README

The project's README from github.com/shirou/gopsutil. As one markdown file: README.md.

gopsutil: psutil for Go

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 Go 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

name Linux FreeBSD OpenBSD macOS Windows Solaris Plan 9 AIX
cpu_times x x x x x b x
cpu_count x x x x x x x
cpu_percent x x x x x x
cpu_times_percent x x x x x x
virtual_memory x x x x x b x x
swap_memory x x x x x X
disk_partitions x x x x x x
disk_io_counters x x x x x
disk_usage x x x x x x
net_io_counters x x x b x x
boot_time x x x x x X
users x x x x x x
pids x x x x x
pid_exists x x x x x
net_connections x x x x x
net_protocols x x
net_if_addrs x
net_if_stats x
netfilter_conntrack x
sensors_temperature x x x x

Process class

name Linux FreeBSD OpenBSD macOS Windows
pid x x x x x
ppid x x x x x
name x x x x x
cmdline x x x x x
create_time x x x
status x x x x
cwd x x x x x
exe x x x x
uids x x x x
gids x x x x
terminal x x x
io_counters x x x x x
nice x x x x x
num_fds x x x
num_ctx_switches x
num_threads x x x x x
cpu_times x x
memory_info x x x x x
memory_maps x
open_files x x
send_signal x x x x
suspend x x x x x
resume x x x x x
terminate x x x x x
kill x x x x
username x x x x x
ionice
rlimit x
num_handlers
threads x
cpu_percent x x x x
cpu_affinity
memory_percent x x
parent x x x x
children x x x x x
connections x x x
is_running
page_faults x x

gopsutil Original Metrics

item Linux FreeBSD OpenBSD macOS Windows Solaris AIX
HostInfo
hostname x x x x x x X
uptime x x x x x x
process x x x x
os x x x x x x x
platform x x x x x x
platformfamily x x x x x x
virtualization x
CPU
VendorID x x x x x x x
Family x x x x x x x
Model x x x x x x x
Stepping x x x x x x
PhysicalID x x
CoreID x x
Cores x x x x x
ModelName x x x x x x x
Microcode x x
LoadAvg
Load1 x x x x x x x
Load5 x x x x x x x
Load15 x x x x x x x
Docker GetDockerID
container id x no no no no no no
Docker CgroupsCPU
user x no no no no no no
system x no no no no no no
Docker CgroupsMem
various x no no no no no no

License

New BSD License (same as psutil)

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.

gopsutil (shirou/gopsutil)

cpu
Searching Database…

11.9K ·GitHub
Gopsutil
What is this?gopsutil is a Go port of Python's psutil library, giving you access to system information like CPU, memory, disk, network, and process stats.
Is it a library or a standalone tool?It's a Go library you import into your own code; there's no CLI or GUI, just packages like cpu, mem, disk, net, host, and process.
How do I add it to a project?Import the relevant subpackage (e.g. mem, cpu, host) with `go get`, since it's organized as separate packages per data category rather than one monolithic package.
Do I need cgo or any native dependencies?No. All platform access is implemented in pure Go by porting C structs to Go structs, so no cgo is required, and Go 1.18 or above is needed.
Does every function work the same on every OS?No, coverage varies a lot by platform: Linux has the most complete support, while things like memory_maps, open_files, or num_fds are missing on several BSDs, macOS, and Windows, and some features (Docker cgroup stats, netfilter conntrack) are Linux-only.
Which operating systems and architectures are supported?FreeBSD, Linux, Windows, Darwin (macOS), OpenBSD, and Solaris across i386/amd64/arm/arm64 as applicable, with partial support for DragonFly BSD and Linux RISC-V.
How does it let me override where it reads system info from?You can set environment variables like HOSTPROC, HOSTSYS, HOSTETC, HOSTVAR, HOSTRUN, HOSTDEV, and HOSTROOT to point gopsutil at alternative locations for /proc, /sys, /etc, etc., which is useful when running inside containers.
Can I cache expensive values like boot time?Yes, since v3.24.1 you can enable caching for things like boot time in the host and process packages, though it's off by default and can cause stale data if the underlying value changes, e.g. after NTP adjusts the clock.
What extra info does gopsutil provide that psutil doesn't?It adds Go-specific extras like detailed HostInfo (platform, virtualization system/role), Linux CPUInfo details, load averages, and Docker cgroup CPU/memory stats and container ID listing on Linux.
How are platform-specific fields exposed, like Linux-only memory stats?Since v4.24.5, gopsutil offers 'Ex' structs (e.g. mem.NewExLinux(), mem.ExWindows()) in the mem and sensor packages to expose data unique to a given OS without cluttering the common cross-platform API.
What are similar projects?node_exporter, telegraf, psutil, sampler, glances, cadvisor, hotpath-rs, prometheus
Which topics is it in?cpu, metrics, hardware, sysadmin, observability, golang, bsd, monitoring, devops, networking, performance, go
Creator
shirou
Size
4.2 MB
Stars
11.9K
Updated
CommitOct 17Releasev4.26.9Oct 01
Age
12y
Commits · 90 Days