sugar deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
..
internal deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
.gitignore deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
.golangci.yml deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
CODE_OF_CONDUCT.md deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
CONTRIBUTING.md deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
LICENSE deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
MAINTAINERS.md deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
Makefile deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
Makefile.common deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
NOTICE deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
README.md deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
SECURITY.md deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
arp.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
buddyinfo.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
cpuinfo.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
cpuinfo_armx.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
cpuinfo_mipsx.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
cpuinfo_others.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
cpuinfo_ppcx.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
cpuinfo_riscvx.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
cpuinfo_s390x.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
cpuinfo_x86.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
crypto.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
doc.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
fixtures.ttar deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
fs.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
fscache.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
go.mod deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
go.sum deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
ipvs.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
kernel_random.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
loadavg.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
mdstat.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
meminfo.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
mountinfo.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
mountstats.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
net_conntrackstat.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
net_dev.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
net_ip_socket.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
net_protocols.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
net_sockstat.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
net_softnet.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
net_tcp.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
net_udp.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
net_unix.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
proc.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
proc_cgroup.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
proc_environ.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
proc_fdinfo.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
proc_io.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
proc_limits.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
proc_maps.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
proc_ns.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
proc_psi.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
proc_smaps.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
proc_stat.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
proc_status.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
schedstat.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
slab.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
stat.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
swaps.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
ttar deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
vm.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
xfrm.go deb58152c1 add prometheus stats %!s(int64=3) %!d(string=hai) anos
zoneinfo.go deb58152c1 add prometheus stats %!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.