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 — это портированная на Go библиотека psutil из Python. Она даёт доступ к системной информации: данным о процессоре, памяти, дисках, сети и статистике процессов.
Это библиотека или самостоятельная утилита?Это Go-библиотека, которую импортируют в свой код. Ни CLI, ни GUI нет, есть только пакеты cpu, mem, disk, net, host и process.
Как добавить её в проект?Импортируйте нужный подпакет (например, mem, cpu, host) с помощью `go get`. Библиотека устроена как отдельные пакеты для каждой категории данных, а не как один монолитный пакет.
Нужен ли cgo или какие-либо нативные зависимости?Нет. Вся работа с платформой реализована на чистом Go: C-структуры портированы в Go-структуры, поэтому cgo не нужен. При этом требуется Go 1.18 или выше.
Одинаково ли работают все функции в каждой ОС?Нет, покрытие сильно зависит от платформы. Лучше всего поддерживается Linux, а такие функции, как memory_maps, open_files или num_fds, отсутствуют на нескольких BSD, в macOS и Windows. Некоторые возможности (статистика cgroup для Docker, 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 (платформа, система и роль виртуализации), детали CPUInfo для Linux, средние значения нагрузки (load averages), а также статистику CPU и памяти cgroup для Docker и список ID контейнеров в Linux.
Как предоставляются специфичные для платформы поля, например статистика памяти только для Linux?Начиная с v4.24.5, gopsutil предлагает структуры «Ex» (например, mem.NewExLinux() и mem.ExWindows()) в пакетах mem и sensor. Они открывают данные, характерные для конкретной ОС, и не перегружают общий кроссплатформенный 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