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.
 
 
 
 
 
 
gitea/vendor/github.com/prometheus/procfs
techknowlogick 47f6a4ec3f
go1.16 (#14783)
4 years ago
..
internal go1.16 (#14783) 4 years ago
.gitignore Use Go1.11 module (#5743) 6 years ago
.golangci.yml Vendor Update Go Libs (#13166) 4 years ago
CODE_OF_CONDUCT.md Vendor Update Go Libs (#13166) 4 years ago
CONTRIBUTING.md Vendor Update Go Libs (#13166) 4 years ago
LICENSE Prometheus endpoint (#5256) 6 years ago
MAINTAINERS.md workaround broken drone build (#7362) 5 years ago
Makefile Update swagger to 0.20.1 (#8010) 5 years ago
Makefile.common go1.16 (#14783) 4 years ago
NOTICE Prometheus endpoint (#5256) 6 years ago
README.md Vendor Update Go Libs (#13166) 4 years ago
SECURITY.md go1.16 (#14783) 4 years ago
arp.go go1.16 (#14783) 4 years ago
buddyinfo.go go1.16 (#14783) 4 years ago
cpuinfo.go go1.16 (#14783) 4 years ago
cpuinfo_armx.go Vendor Update Go Libs (#13166) 4 years ago
cpuinfo_mipsx.go Vendor Update Go Libs (#13166) 4 years ago
cpuinfo_others.go Vendor Update Go Libs (#13166) 4 years ago
cpuinfo_ppcx.go Vendor Update Go Libs (#13166) 4 years ago
cpuinfo_riscvx.go go1.16 (#14783) 4 years ago
cpuinfo_s390x.go Vendor Update Go Libs (#13166) 4 years ago
cpuinfo_x86.go Vendor Update Go Libs (#13166) 4 years ago
crypto.go go1.16 (#14783) 4 years ago
doc.go Prometheus endpoint (#5256) 6 years ago
fixtures.ttar go1.16 (#14783) 4 years ago
fs.go Update swagger to 0.20.1 (#8010) 5 years ago
fscache.go go1.16 (#14783) 4 years ago
go.mod go1.16 (#14783) 4 years ago
go.sum go1.16 (#14783) 4 years ago
ipvs.go Vendor Update Go Libs (#13166) 4 years ago
kernel_random.go Vendor Update Go Libs (#13166) 4 years ago
loadavg.go go1.16 (#14783) 4 years ago
mdstat.go go1.16 (#14783) 4 years ago
meminfo.go go1.16 (#14783) 4 years ago
mountinfo.go Vendor Update Go Libs (#13166) 4 years ago
mountstats.go go1.16 (#14783) 4 years ago
net_conntrackstat.go go1.16 (#14783) 4 years ago
net_dev.go Vendor Update Go Libs (#13166) 4 years ago
net_ip_socket.go go1.16 (#14783) 4 years ago
net_protocols.go go1.16 (#14783) 4 years ago
net_sockstat.go go1.16 (#14783) 4 years ago
net_softnet.go go1.16 (#14783) 4 years ago
net_tcp.go go1.16 (#14783) 4 years ago
net_udp.go go1.16 (#14783) 4 years ago
net_unix.go go1.16 (#14783) 4 years ago
proc.go go1.16 (#14783) 4 years ago
proc_cgroup.go go1.16 (#14783) 4 years ago
proc_environ.go Vendor Update Go Libs (#13166) 4 years ago
proc_fdinfo.go go1.16 (#14783) 4 years ago
proc_io.go Vendor Update Go Libs (#13166) 4 years ago
proc_limits.go go1.16 (#14783) 4 years ago
proc_maps.go Vendor Update Go Libs (#13166) 4 years ago
proc_ns.go go1.16 (#14783) 4 years ago
proc_psi.go go1.16 (#14783) 4 years ago
proc_smaps.go Vendor Update Go Libs (#13166) 4 years ago
proc_stat.go go1.16 (#14783) 4 years ago
proc_status.go Vendor Update Go Libs (#13166) 4 years ago
schedstat.go go1.16 (#14783) 4 years ago
slab.go go1.16 (#14783) 4 years ago
stat.go go1.16 (#14783) 4 years ago
swaps.go Vendor Update Go Libs (#13166) 4 years ago
ttar Update swagger to 0.20.1 (#8010) 5 years ago
vm.go Update swagger to 0.20.1 (#8010) 5 years ago
xfrm.go go1.16 (#14783) 4 years ago
zoneinfo.go go1.16 (#14783) 4 years 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.

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.