baichongyang baca853c99 first init %!s(int64=3) %!d(string=hai) anos
..
internal baca853c99 first init %!s(int64=3) %!d(string=hai) anos
.gitignore baca853c99 first init %!s(int64=3) %!d(string=hai) anos
.golangci.yml baca853c99 first init %!s(int64=3) %!d(string=hai) anos
CONTRIBUTING.md baca853c99 first init %!s(int64=3) %!d(string=hai) anos
LICENSE baca853c99 first init %!s(int64=3) %!d(string=hai) anos
MAINTAINERS.md baca853c99 first init %!s(int64=3) %!d(string=hai) anos
Makefile baca853c99 first init %!s(int64=3) %!d(string=hai) anos
Makefile.common baca853c99 first init %!s(int64=3) %!d(string=hai) anos
NOTICE baca853c99 first init %!s(int64=3) %!d(string=hai) anos
README.md baca853c99 first init %!s(int64=3) %!d(string=hai) anos
arp.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
buddyinfo.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
cpuinfo.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
cpuinfo_arm.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
cpuinfo_arm64.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
cpuinfo_default.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
cpuinfo_mips.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
cpuinfo_mips64.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
cpuinfo_mips64le.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
cpuinfo_mipsle.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
cpuinfo_ppc64.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
cpuinfo_ppc64le.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
cpuinfo_s390x.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
crypto.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
doc.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
fixtures.ttar baca853c99 first init %!s(int64=3) %!d(string=hai) anos
fs.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
fscache.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
go.mod baca853c99 first init %!s(int64=3) %!d(string=hai) anos
go.sum baca853c99 first init %!s(int64=3) %!d(string=hai) anos
ipvs.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
kernel_random.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
loadavg.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
mdstat.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
meminfo.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
mountinfo.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
mountstats.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
net_conntrackstat.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
net_dev.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
net_sockstat.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
net_softnet.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
net_udp.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
net_unix.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
proc.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
proc_cgroup.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
proc_environ.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
proc_fdinfo.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
proc_io.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
proc_limits.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
proc_maps.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
proc_ns.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
proc_psi.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
proc_smaps.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
proc_stat.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
proc_status.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
schedstat.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
stat.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
swaps.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
ttar baca853c99 first init %!s(int64=3) %!d(string=hai) anos
vm.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
xfrm.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos
zoneinfo.go baca853c99 first init %!s(int64=3) %!d(string=hai) anos

README.md

procfs

This package provides functions to retrieve system, kernel, and process metrics from the pseudo-filesystems /proc and /sys.

WARNING: This package is a work in progress. Its API may still break in backwards-incompatible ways without warnings. Use it at your own risk.

GoDoc Build Status Go Report Card

Usage

The procfs library is organized by packages based on whether the gathered data is coming from /proc, /sys, or both. Each package contains an FS type which represents the path to either /proc, /sys, or both. For example, cpu statistics are gathered from /proc/stat and are available via the root procfs package. First, the proc filesystem mount point is initialized, and then the stat information is read.

fs, err := procfs.NewFS("/proc")
stats, err := fs.Stat()

Some sub-packages such as blockdevice, require access to both the proc and sys filesystems.

    fs, err := blockdevice.NewFS("/proc", "/sys")
    stats, err := fs.ProcDiskstats()

Package Organization

The packages in this project are organized according to (1) whether the data comes from the /proc or /sys filesystem and (2) the type of information being retrieved. For example, most process information can be gathered from the functions in the root procfs package. Information about block devices such as disk drives is available in the blockdevices sub-package.

Building and Testing

The procfs library is intended to be built as part of another application, so there are no distributable binaries.
However, most of the API includes unit tests which can be run with make test.

Updating Test Fixtures

The procfs library includes a set of test fixtures which include many example files from the /proc and /sys filesystems. These fixtures are included as a ttar file which is extracted automatically during testing. To add/update the test fixtures, first ensure the fixtures directory is up to date by removing the existing directory and then extracting the ttar file using make fixtures/.unpacked or just make test.

rm -rf fixtures
make test

Next, make the required changes to the extracted files in the fixtures directory. When the changes are complete, run make update_fixtures to create a new fixtures.ttar file based on the updated fixtures directory. And finally, verify the changes using git diff fixtures.ttar.