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)

Searching Database…

11.9K ·GitHub
Gopsutil
这是什么？gopsutil 是 Python 的 psutil 库的 Go 语言移植版，可以让你获取系统信息，例如 CPU、内存、磁盘、网络和进程的统计数据。
它是库还是独立工具？它是一个 Go 库，需要导入到你自己的代码中。它没有命令行工具或图形界面，只提供 cpu、mem、disk、net、host 和 process 等子包。
怎样把它添加到项目中？使用 `go get` 导入相关子包（例如 mem、cpu、host）。它按数据类别组织为多个独立的包，而不是一个单一的大包。
我需要 cgo 或其他本地依赖吗？不需要。所有平台访问都是通过把 C 结构体移植为 Go 结构体、用纯 Go 实现的，因此不需要 cgo，但需要 Go 1.18 或更高版本。
每个函数在所有操作系统上的表现都一样吗？不一样。各平台的支持范围差异很大：Linux 支持最完整，而 memory_maps、open_files、num_fds 等功能在多个 BSD、macOS 和 Windows 上缺失，部分功能（Docker cgroup 统计、netfilter conntrack）仅限 Linux。
支持哪些操作系统和架构？支持 FreeBSD、Linux、Windows、Darwin（macOS）、OpenBSD 和 Solaris，架构视情况而定，涵盖 i386/amd64/arm/arm64；另外对 DragonFly BSD 和 Linux RISC-V 提供部分支持。
我可以如何覆盖它读取系统信息的位置？你可以设置 HOSTPROC、HOSTSYS、HOSTETC、HOSTVAR、HOSTRUN、HOSTDEV 和 HOSTROOT 等环境变量，让 gopsutil 改为读取其他位置的 /proc、/sys、/etc 等目录，这在容器中运行时很有用。
能缓存开销较大的值（比如开机时间）吗？可以。从 v3.24.1 版本起，你可以为 host 和 process 包中的开机时间等值启用缓存。该功能默认关闭；若底层数值发生变化（例如 NTP 校准了时钟之后），可能会导致读到过时的数据。
gopsutil 提供了哪些 psutil 没有的额外信息？它增加了一些 Go 特有的扩展功能，例如详细的 HostInfo（平台、虚拟化系统/角色）、Linux 的 CPUInfo 详情、系统负载平均值，以及 Linux 上的 Docker cgroup CPU/内存统计和容器 ID 列表。
像 Linux 独有的内存统计这类平台特有字段是如何提供的？从 v4.24.5 版本起，gopsutil 在 mem 和 sensor 包中提供了 'Ex' 结构体（例如 mem.NewExLinux()、mem.ExWindows()），用来暴露某个操作系统特有的数据，同时不让通用的跨平台 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