You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Fusl 705dce8582 upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
..
internal upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
.gitignore upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
.golangci.yml upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
CODE_OF_CONDUCT.md upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
CONTRIBUTING.md upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
LICENSE added metrics/debug, dont abort item batch on single server failure 2 years ago
MAINTAINERS.md added metrics/debug, dont abort item batch on single server failure 2 years ago
Makefile upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
Makefile.common upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
NOTICE added metrics/debug, dont abort item batch on single server failure 2 years ago
README.md added metrics/debug, dont abort item batch on single server failure 2 years ago
SECURITY.md upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
arp.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
buddyinfo.go added metrics/debug, dont abort item batch on single server failure 2 years ago
cmdline.go added metrics/debug, dont abort item batch on single server failure 2 years ago
cpuinfo.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
cpuinfo_armx.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
cpuinfo_mipsx.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
cpuinfo_others.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
cpuinfo_ppcx.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
cpuinfo_riscvx.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
cpuinfo_s390x.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
cpuinfo_x86.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
crypto.go added metrics/debug, dont abort item batch on single server failure 2 years ago
doc.go added metrics/debug, dont abort item batch on single server failure 2 years ago
fs.go added metrics/debug, dont abort item batch on single server failure 2 years ago
fscache.go added metrics/debug, dont abort item batch on single server failure 2 years ago
ipvs.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
kernel_random.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
loadavg.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
mdstat.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
meminfo.go added metrics/debug, dont abort item batch on single server failure 2 years ago
mountinfo.go added metrics/debug, dont abort item batch on single server failure 2 years ago
mountstats.go added metrics/debug, dont abort item batch on single server failure 2 years ago
net_conntrackstat.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
net_dev.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
net_ip_socket.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
net_protocols.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
net_sockstat.go added metrics/debug, dont abort item batch on single server failure 2 years ago
net_softnet.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
net_tcp.go added metrics/debug, dont abort item batch on single server failure 2 years ago
net_udp.go added metrics/debug, dont abort item batch on single server failure 2 years ago
net_unix.go added metrics/debug, dont abort item batch on single server failure 2 years ago
net_xfrm.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
netstat.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
proc.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
proc_cgroup.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
proc_cgroups.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
proc_environ.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
proc_fdinfo.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
proc_io.go added metrics/debug, dont abort item batch on single server failure 2 years ago
proc_limits.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
proc_maps.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
proc_netstat.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
proc_ns.go added metrics/debug, dont abort item batch on single server failure 2 years ago
proc_psi.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
proc_smaps.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
proc_snmp.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
proc_snmp6.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
proc_stat.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
proc_status.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
proc_sys.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
schedstat.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
slab.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
softirqs.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
stat.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
swaps.go added metrics/debug, dont abort item batch on single server failure 2 years ago
ttar added metrics/debug, dont abort item batch on single server failure 2 years ago
vm.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago
zoneinfo.go upgrade to go1.19, remove legacy db, add last touch timestamp, inline some conditions 1 year ago

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.