Startsida Utforska Hjälp
Logga in
yongxu
/
yx-dataset-server
7
0
Fork 0
Filer Ärenden 0 Pull-förfrågningar 0 Wiki
Träd: 1921cb4c51
Grenar Taggar
yx-dataset-s...
/
vendor
/
github.com
/
prometheus
/
procfs
liuxiulin 1921cb4c51 first commit 1 månad sedan
..
internal 1921cb4c51 first commit 1 månad sedan
.gitignore 1921cb4c51 first commit 1 månad sedan
.golangci.yml 1921cb4c51 first commit 1 månad sedan
CODE_OF_CONDUCT.md 1921cb4c51 first commit 1 månad sedan
CONTRIBUTING.md 1921cb4c51 first commit 1 månad sedan
LICENSE 1921cb4c51 first commit 1 månad sedan
MAINTAINERS.md 1921cb4c51 first commit 1 månad sedan
Makefile 1921cb4c51 first commit 1 månad sedan
Makefile.common 1921cb4c51 first commit 1 månad sedan
NOTICE 1921cb4c51 first commit 1 månad sedan
README.md 1921cb4c51 first commit 1 månad sedan
SECURITY.md 1921cb4c51 first commit 1 månad sedan
arp.go 1921cb4c51 first commit 1 månad sedan
buddyinfo.go 1921cb4c51 first commit 1 månad sedan
cmdline.go 1921cb4c51 first commit 1 månad sedan
cpuinfo.go 1921cb4c51 first commit 1 månad sedan
cpuinfo_armx.go 1921cb4c51 first commit 1 månad sedan
cpuinfo_mipsx.go 1921cb4c51 first commit 1 månad sedan
cpuinfo_others.go 1921cb4c51 first commit 1 månad sedan
cpuinfo_ppcx.go 1921cb4c51 first commit 1 månad sedan
cpuinfo_riscvx.go 1921cb4c51 first commit 1 månad sedan
cpuinfo_s390x.go 1921cb4c51 first commit 1 månad sedan
cpuinfo_x86.go 1921cb4c51 first commit 1 månad sedan
crypto.go 1921cb4c51 first commit 1 månad sedan
doc.go 1921cb4c51 first commit 1 månad sedan
fs.go 1921cb4c51 first commit 1 månad sedan
fscache.go 1921cb4c51 first commit 1 månad sedan
ipvs.go 1921cb4c51 first commit 1 månad sedan
kernel_random.go 1921cb4c51 first commit 1 månad sedan
loadavg.go 1921cb4c51 first commit 1 månad sedan
mdstat.go 1921cb4c51 first commit 1 månad sedan
meminfo.go 1921cb4c51 first commit 1 månad sedan
mountinfo.go 1921cb4c51 first commit 1 månad sedan
mountstats.go 1921cb4c51 first commit 1 månad sedan
net_conntrackstat.go 1921cb4c51 first commit 1 månad sedan
net_dev.go 1921cb4c51 first commit 1 månad sedan
net_ip_socket.go 1921cb4c51 first commit 1 månad sedan
net_protocols.go 1921cb4c51 first commit 1 månad sedan
net_sockstat.go 1921cb4c51 first commit 1 månad sedan
net_softnet.go 1921cb4c51 first commit 1 månad sedan
net_tcp.go 1921cb4c51 first commit 1 månad sedan
net_udp.go 1921cb4c51 first commit 1 månad sedan
net_unix.go 1921cb4c51 first commit 1 månad sedan
net_xfrm.go 1921cb4c51 first commit 1 månad sedan
netstat.go 1921cb4c51 first commit 1 månad sedan
proc.go 1921cb4c51 first commit 1 månad sedan
proc_cgroup.go 1921cb4c51 first commit 1 månad sedan
proc_cgroups.go 1921cb4c51 first commit 1 månad sedan
proc_environ.go 1921cb4c51 first commit 1 månad sedan
proc_fdinfo.go 1921cb4c51 first commit 1 månad sedan
proc_io.go 1921cb4c51 first commit 1 månad sedan
proc_limits.go 1921cb4c51 first commit 1 månad sedan
proc_maps.go 1921cb4c51 first commit 1 månad sedan
proc_netstat.go 1921cb4c51 first commit 1 månad sedan
proc_ns.go 1921cb4c51 first commit 1 månad sedan
proc_psi.go 1921cb4c51 first commit 1 månad sedan
proc_smaps.go 1921cb4c51 first commit 1 månad sedan
proc_snmp.go 1921cb4c51 first commit 1 månad sedan
proc_snmp6.go 1921cb4c51 first commit 1 månad sedan
proc_stat.go 1921cb4c51 first commit 1 månad sedan
proc_status.go 1921cb4c51 first commit 1 månad sedan
proc_sys.go 1921cb4c51 first commit 1 månad sedan
schedstat.go 1921cb4c51 first commit 1 månad sedan
slab.go 1921cb4c51 first commit 1 månad sedan
softirqs.go 1921cb4c51 first commit 1 månad sedan
stat.go 1921cb4c51 first commit 1 månad sedan
swaps.go 1921cb4c51 first commit 1 månad sedan
ttar 1921cb4c51 first commit 1 månad sedan
vm.go 1921cb4c51 first commit 1 månad sedan
zoneinfo.go 1921cb4c51 first commit 1 månad sedan

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.