Tonis Tiigi 2d720a1e0b vendor: update buildkit with typed errors support
Signed-off-by: Tonis Tiigi <tonistiigi@gmail.com>
..
internal vendor: update buildkit with typed errors support
.gitignore vendor: initial vendor
.golangci.yml vendor: update buildkit with typed errors support
CONTRIBUTING.md vendor: update buildkit with typed errors support
LICENSE vendor: initial vendor
MAINTAINERS.md Bump moby/buildkit
Makefile Bump moby/buildkit
Makefile.common vendor: update buildkit with typed errors support
NOTICE vendor: initial vendor
README.md vendor: update buildkit with typed errors support
arp.go Bump microsoft/hcsshim to v0.8.7
buddyinfo.go Bump microsoft/hcsshim to v0.8.7
cpuinfo.go vendor: update buildkit with typed errors support
cpuinfo_arm.go vendor: update buildkit with typed errors support
cpuinfo_arm64.go vendor: update buildkit with typed errors support
cpuinfo_default.go vendor: update buildkit with typed errors support
cpuinfo_mips.go vendor: update buildkit with typed errors support
cpuinfo_mips64.go vendor: update buildkit with typed errors support
cpuinfo_mips64le.go vendor: update buildkit with typed errors support
cpuinfo_mipsle.go vendor: update buildkit with typed errors support
cpuinfo_ppc64.go vendor: update buildkit with typed errors support
cpuinfo_ppc64le.go vendor: update buildkit with typed errors support
cpuinfo_s390x.go vendor: update buildkit with typed errors support
crypto.go vendor: update buildkit with typed errors support
doc.go vendor: initial vendor
fixtures.ttar vendor: update buildkit with typed errors support
fs.go Bump moby/buildkit
fscache.go vendor: update buildkit with typed errors support
go.mod vendor: update buildkit with typed errors support
go.sum vendor: update buildkit with typed errors support
ipvs.go vendor: update buildkit with typed errors support
kernel_random.go vendor: update buildkit with typed errors support
loadavg.go vendor: update buildkit with typed errors support
mdstat.go vendor: update buildkit with typed errors support
meminfo.go vendor: update buildkit with typed errors support
mountinfo.go vendor: update buildkit with typed errors support
mountstats.go vendor: update buildkit with typed errors support
net_conntrackstat.go vendor: update buildkit with typed errors support
net_dev.go vendor: update buildkit with typed errors support
net_sockstat.go vendor: update buildkit with typed errors support
net_softnet.go vendor: update buildkit with typed errors support
net_udp.go vendor: update buildkit with typed errors support
net_unix.go vendor: update buildkit with typed errors support
proc.go vendor: update buildkit with typed errors support
proc_cgroup.go vendor: update buildkit with typed errors support
proc_environ.go vendor: update buildkit with typed errors support
proc_fdinfo.go vendor: update buildkit with typed errors support
proc_io.go vendor: update buildkit with typed errors support
proc_limits.go Bump moby/buildkit
proc_maps.go vendor: update buildkit with typed errors support
proc_ns.go Bump moby/buildkit
proc_psi.go vendor: update buildkit with typed errors support
proc_smaps.go vendor: update buildkit with typed errors support
proc_stat.go vendor: update buildkit with typed errors support
proc_status.go vendor: update buildkit with typed errors support
schedstat.go Bump microsoft/hcsshim to v0.8.7
stat.go vendor: update buildkit with typed errors support
swaps.go vendor: update buildkit with typed errors support
ttar Bump moby/buildkit
vm.go Bump microsoft/hcsshim to v0.8.7
xfrm.go Bump moby/buildkit
zoneinfo.go Bump microsoft/hcsshim to v0.8.7

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.