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
Antoine GIRARD 256b178176
Update swagger to 0.20.1 (#8010)
5 years ago
..
internal Update swagger to 0.20.1 (#8010) 5 years ago
.gitignore Use Go1.11 module (#5743) 6 years ago
.golangci.yml workaround broken drone build (#7362) 5 years ago
CONTRIBUTING.md Use Go1.11 module (#5743) 6 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 Update swagger to 0.20.1 (#8010) 5 years ago
NOTICE Prometheus endpoint (#5256) 6 years ago
README.md Update swagger to 0.20.1 (#8010) 5 years ago
arp.go Update swagger to 0.20.1 (#8010) 5 years ago
buddyinfo.go Update swagger to 0.20.1 (#8010) 5 years ago
crypto.go Update swagger to 0.20.1 (#8010) 5 years ago
doc.go Prometheus endpoint (#5256) 6 years ago
fixtures.ttar Update swagger to 0.20.1 (#8010) 5 years ago
fs.go Update swagger to 0.20.1 (#8010) 5 years ago
go.mod Update swagger to 0.20.1 (#8010) 5 years ago
go.sum Update swagger to 0.20.1 (#8010) 5 years ago
ipvs.go Update swagger to 0.20.1 (#8010) 5 years ago
mdstat.go Update swagger to 0.20.1 (#8010) 5 years ago
mountinfo.go Update swagger to 0.20.1 (#8010) 5 years ago
mountstats.go Update swagger to 0.20.1 (#8010) 5 years ago
net_dev.go Update swagger to 0.20.1 (#8010) 5 years ago
net_softnet.go Update swagger to 0.20.1 (#8010) 5 years ago
net_unix.go Update swagger to 0.20.1 (#8010) 5 years ago
proc.go Update swagger to 0.20.1 (#8010) 5 years ago
proc_environ.go Update swagger to 0.20.1 (#8010) 5 years ago
proc_fdinfo.go Update swagger to 0.20.1 (#8010) 5 years ago
proc_io.go Update swagger to 0.20.1 (#8010) 5 years ago
proc_limits.go Update swagger to 0.20.1 (#8010) 5 years ago
proc_ns.go Update swagger to 0.20.1 (#8010) 5 years ago
proc_psi.go Update swagger to 0.20.1 (#8010) 5 years ago
proc_stat.go Update swagger to 0.20.1 (#8010) 5 years ago
proc_status.go Update swagger to 0.20.1 (#8010) 5 years ago
schedstat.go Update swagger to 0.20.1 (#8010) 5 years ago
stat.go Update swagger to 0.20.1 (#8010) 5 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 workaround broken drone build (#7362) 5 years ago
zoneinfo.go Update swagger to 0.20.1 (#8010) 5 years ago

README.md

procfs

This procfs 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, current 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()

Building and Testing

The procfs library is normally built as part of another application. However, when making changes to the library, the make test command can be used to run the API test suite.

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.