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

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.