Skip to content

procfs provides functions to retrieve system, kernel and process metrics from the pseudo-filesystem proc.

License

Notifications You must be signed in to change notification settings

kwisniewski98/procfs

This branch is 288 commits behind prometheus/procfs:master.

Folders and files

NameName
Last commit message
Last commit date
Oct 14, 2020
Mar 31, 2020
May 25, 2020
Oct 15, 2019
May 20, 2020
Feb 26, 2020
May 30, 2019
Feb 27, 2018
Aug 24, 2020
Feb 4, 2020
Feb 28, 2018
Feb 26, 2020
Jun 23, 2020
Oct 4, 2019
Jan 22, 2015
May 7, 2019
May 16, 2019
May 19, 2020
Jan 22, 2015
Sep 17, 2019
Aug 15, 2019
Aug 15, 2019
Sep 5, 2019
May 30, 2019
Oct 5, 2020
Jun 22, 2020
Jun 22, 2020
Aug 26, 2020
Jun 22, 2020
Nov 2, 2020
May 6, 2020
Oct 5, 2020
Jun 22, 2020
Nov 26, 2019
Nov 26, 2019
Feb 22, 2015
Aug 26, 2020
May 30, 2019
Jun 17, 2019
Mar 27, 2020
Mar 27, 2020
Feb 4, 2020
Feb 4, 2020
Oct 4, 2019
May 30, 2019
Jun 16, 2020
Jun 6, 2020
Jan 23, 2020
Jan 23, 2020
Aug 24, 2020
Aug 24, 2020
Nov 23, 2019
Nov 11, 2019
Apr 17, 2020
Apr 17, 2020
Dec 14, 2020
Dec 14, 2020
Apr 8, 2020
Jan 27, 2020
Oct 22, 2019
May 30, 2019
Nov 25, 2019
Nov 25, 2019
Mar 9, 2020
Mar 9, 2020
Jan 23, 2020
Jan 23, 2020
Nov 26, 2019
Nov 26, 2019
Apr 6, 2020
Mar 23, 2020
Mar 23, 2020
Oct 4, 2019
Jun 20, 2019
May 25, 2020
Jun 26, 2019
Oct 4, 2019
May 30, 2019
May 30, 2019
May 30, 2019
May 27, 2020
Jun 22, 2020
Jun 22, 2020
May 30, 2019
May 30, 2019
Oct 4, 2019
May 30, 2019
May 4, 2020
May 1, 2020
Oct 4, 2019
May 30, 2019
Aug 26, 2020
Aug 26, 2020
Apr 6, 2020
Sep 5, 2019
Jul 31, 2019
Nov 7, 2019
May 30, 2019
Jan 21, 2020
Jan 21, 2020
May 16, 2019
Aug 9, 2019
Nov 23, 2019
May 3, 2019
May 3, 2019
Jul 31, 2019
Aug 9, 2019

Repository files navigation

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.

About

procfs provides functions to retrieve system, kernel and process metrics from the pseudo-filesystem proc.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 97.8%
  • Shell 2.1%
  • Makefile 0.1%