package
0.0.0-20230331131523-deb0478a2e52
Repository: https://github.com/hellobchain/third_party.git
Documentation: pkg.go.dev
# README
procfs
This procfs package provides functions to retrieve system, kernel and process metrics from the pseudo-filesystem proc.
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.
# Functions
AllProcs returns a list of all currently available processes under /proc.
NewBuddyInfo reads the buddyinfo statistics.
NewFS returns a new FS mounted under the given mountPoint.
NewIPVSBackendStatus reads and returns the status of all (virtual,real) server pairs.
NewIPVSStats reads the IPVS statistics.
NewNetDev returns kernel/system statistics read from /proc/net/dev.
NewProc returns a process for the given pid under /proc.
NewStat returns kernel/system statistics read from /proc/stat.
NewXfrmStat reads the xfrm_stat statistics.
Self returns a process for the current process read via /proc/self.
# Constants
DefaultMountPoint is the common mount point of the proc filesystem.
# Structs
A BuddyInfo is the details parsed from /proc/buddyinfo.
CPUStat shows how much time the cpu spend in various stages.
IPVSBackendStatus holds current metrics of one virtual / real address pair.
IPVSStats holds IPVS statistics, as exposed by the kernel in `/proc/net/ip_vs_stats`.
MDStat holds info parsed from /proc/mdstat.
A Mount is a device mount parsed from /proc/[pid]/mountstats.
A MountStatsNFS is a MountStats implementation for NFSv3 and v4 mounts.
Namespace represents a single namespace of a process.
NetDevLine is single line parsed from /proc/net/dev or /proc/[pid]/net/dev.
A NFSBytesStats contains statistics about the number of bytes read and written by an NFS client to and from an NFS server.
A NFSEventsStats contains statistics about NFS event occurrences.
A NFSOperationStats contains statistics for a single operation.
A NFSTransportStats contains statistics for the NFS mount RPC requests and responses.
Proc provides information about a running process.
ProcIO models the content of /proc/<pid>/io.
ProcLimits represents the soft limits for each of the process's resource limits.
ProcStat provides status information about the process, read from /proc/[pid]/stat.
SoftIRQStat represent the softirq statistics as exported in the procfs stat file.
Stat represents kernel/system statistics.
XfrmStat models the contents of /proc/net/xfrm_stat.
# Interfaces
A MountStats is a type which contains detailed statistics for a specific type of Mount.
# Type aliases
FS represents the pseudo-filesystem proc, which provides an interface to kernel data structures.
Namespaces contains all of the namespaces that the process is contained in.
NetDev is parsed from /proc/net/dev or /proc/[pid]/net/dev.
Procs represents a list of Proc structs.