周玉环 d906a41c2e first commit vor 2 Tagen
..
internal d906a41c2e first commit vor 2 Tagen
.gitignore d906a41c2e first commit vor 2 Tagen
.golangci.yml d906a41c2e first commit vor 2 Tagen
CODE_OF_CONDUCT.md d906a41c2e first commit vor 2 Tagen
CONTRIBUTING.md d906a41c2e first commit vor 2 Tagen
LICENSE d906a41c2e first commit vor 2 Tagen
MAINTAINERS.md d906a41c2e first commit vor 2 Tagen
Makefile d906a41c2e first commit vor 2 Tagen
Makefile.common d906a41c2e first commit vor 2 Tagen
NOTICE d906a41c2e first commit vor 2 Tagen
README.md d906a41c2e first commit vor 2 Tagen
SECURITY.md d906a41c2e first commit vor 2 Tagen
arp.go d906a41c2e first commit vor 2 Tagen
buddyinfo.go d906a41c2e first commit vor 2 Tagen
cmdline.go d906a41c2e first commit vor 2 Tagen
cpuinfo.go d906a41c2e first commit vor 2 Tagen
cpuinfo_armx.go d906a41c2e first commit vor 2 Tagen
cpuinfo_mipsx.go d906a41c2e first commit vor 2 Tagen
cpuinfo_others.go d906a41c2e first commit vor 2 Tagen
cpuinfo_ppcx.go d906a41c2e first commit vor 2 Tagen
cpuinfo_riscvx.go d906a41c2e first commit vor 2 Tagen
cpuinfo_s390x.go d906a41c2e first commit vor 2 Tagen
cpuinfo_x86.go d906a41c2e first commit vor 2 Tagen
crypto.go d906a41c2e first commit vor 2 Tagen
doc.go d906a41c2e first commit vor 2 Tagen
fs.go d906a41c2e first commit vor 2 Tagen
fscache.go d906a41c2e first commit vor 2 Tagen
ipvs.go d906a41c2e first commit vor 2 Tagen
kernel_random.go d906a41c2e first commit vor 2 Tagen
loadavg.go d906a41c2e first commit vor 2 Tagen
mdstat.go d906a41c2e first commit vor 2 Tagen
meminfo.go d906a41c2e first commit vor 2 Tagen
mountinfo.go d906a41c2e first commit vor 2 Tagen
mountstats.go d906a41c2e first commit vor 2 Tagen
net_conntrackstat.go d906a41c2e first commit vor 2 Tagen
net_dev.go d906a41c2e first commit vor 2 Tagen
net_ip_socket.go d906a41c2e first commit vor 2 Tagen
net_protocols.go d906a41c2e first commit vor 2 Tagen
net_sockstat.go d906a41c2e first commit vor 2 Tagen
net_softnet.go d906a41c2e first commit vor 2 Tagen
net_tcp.go d906a41c2e first commit vor 2 Tagen
net_udp.go d906a41c2e first commit vor 2 Tagen
net_unix.go d906a41c2e first commit vor 2 Tagen
net_xfrm.go d906a41c2e first commit vor 2 Tagen
netstat.go d906a41c2e first commit vor 2 Tagen
proc.go d906a41c2e first commit vor 2 Tagen
proc_cgroup.go d906a41c2e first commit vor 2 Tagen
proc_cgroups.go d906a41c2e first commit vor 2 Tagen
proc_environ.go d906a41c2e first commit vor 2 Tagen
proc_fdinfo.go d906a41c2e first commit vor 2 Tagen
proc_io.go d906a41c2e first commit vor 2 Tagen
proc_limits.go d906a41c2e first commit vor 2 Tagen
proc_maps.go d906a41c2e first commit vor 2 Tagen
proc_netstat.go d906a41c2e first commit vor 2 Tagen
proc_ns.go d906a41c2e first commit vor 2 Tagen
proc_psi.go d906a41c2e first commit vor 2 Tagen
proc_smaps.go d906a41c2e first commit vor 2 Tagen
proc_snmp.go d906a41c2e first commit vor 2 Tagen
proc_snmp6.go d906a41c2e first commit vor 2 Tagen
proc_stat.go d906a41c2e first commit vor 2 Tagen
proc_status.go d906a41c2e first commit vor 2 Tagen
proc_sys.go d906a41c2e first commit vor 2 Tagen
schedstat.go d906a41c2e first commit vor 2 Tagen
slab.go d906a41c2e first commit vor 2 Tagen
softirqs.go d906a41c2e first commit vor 2 Tagen
stat.go d906a41c2e first commit vor 2 Tagen
swaps.go d906a41c2e first commit vor 2 Tagen
ttar d906a41c2e first commit vor 2 Tagen
vm.go d906a41c2e first commit vor 2 Tagen
zoneinfo.go d906a41c2e first commit vor 2 Tagen

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.

Go Reference CircleCI 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.