podman/vendor/github.com/prometheus/procfs
Valentin Rothberg 65a618886e new "image" mount type
Add a new "image" mount type to `--mount`.  The source of the mount is
the name or ID of an image.  The destination is the path inside the
container.  Image mounts further support an optional `rw,readwrite`
parameter which if set to "true" will yield the mount writable inside
the container.  Note that no changes are propagated to the image mount
on the host (which in any case is read only).

Mounts are overlay mounts.  To support read-only overlay mounts, vendor
a non-release version of Buildah.

Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
2020-10-29 15:06:22 +01:00
..
internal/fs new "image" mount type 2020-10-29 15:06:22 +01:00
.gitignore update dependencies 2019-06-24 21:29:31 +02:00
.golangci.yml update dependencies 2019-06-24 21:29:31 +02:00
CONTRIBUTING.md update dependencies 2019-06-24 21:29:31 +02:00
LICENSE update dependencies 2019-06-24 21:29:31 +02:00
MAINTAINERS.md update dependencies 2019-06-24 21:29:31 +02:00
Makefile update dependencies 2019-06-24 21:29:31 +02:00
Makefile.common Update c/image to v4.0.1 and buildah to 1.11.3 2019-10-04 20:18:23 +02:00
NOTICE update dependencies 2019-06-24 21:29:31 +02:00
README.md update dependencies 2019-06-24 21:29:31 +02:00
buddyinfo.go new "image" mount type 2020-10-29 15:06:22 +01:00
doc.go update dependencies 2019-06-24 21:29:31 +02:00
fixtures.ttar new "image" mount type 2020-10-29 15:06:22 +01:00
fs.go update dependencies 2019-06-24 21:29:31 +02:00
go.mod Update c/image to v4.0.1 and buildah to 1.11.3 2019-10-04 20:18:23 +02:00
go.sum Update c/image to v4.0.1 and buildah to 1.11.3 2019-10-04 20:18:23 +02:00
ipvs.go update dependencies 2019-06-24 21:29:31 +02:00
mdstat.go Update c/image to v4.0.1 and buildah to 1.11.3 2019-10-04 20:18:23 +02:00
mountinfo.go Update c/image to v4.0.1 and buildah to 1.11.3 2019-10-04 20:18:23 +02:00
mountstats.go update dependencies 2019-06-24 21:29:31 +02:00
net_dev.go update dependencies 2019-06-24 21:29:31 +02:00
net_unix.go update dependencies 2019-06-24 21:29:31 +02:00
proc.go new "image" mount type 2020-10-29 15:06:22 +01:00
proc_environ.go Update c/image to v4.0.1 and buildah to 1.11.3 2019-10-04 20:18:23 +02:00
proc_io.go update dependencies 2019-06-24 21:29:31 +02:00
proc_limits.go update dependencies 2019-06-24 21:29:31 +02:00
proc_ns.go update dependencies 2019-06-24 21:29:31 +02:00
proc_psi.go update dependencies 2019-06-24 21:29:31 +02:00
proc_stat.go Update c/image to v4.0.1 and buildah to 1.11.3 2019-10-04 20:18:23 +02:00
proc_status.go new "image" mount type 2020-10-29 15:06:22 +01:00
stat.go update dependencies 2019-06-24 21:29:31 +02:00
ttar update dependencies 2019-06-24 21:29:31 +02:00
xfrm.go update dependencies 2019-06-24 21:29:31 +02:00

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.