Expand description
Core library for peek: process snapshot types, collection orchestration, and extended data.
Provides ProcessInfo, CollectOptions, collect(), and collect_extended(); delegates to
peek-proc-reader, kernel-explainer, resource-sampler, network-inspector, and signal-engine.
Modules§
- config
- General config file support:
~/.config/peek/config.toml(or XDG_CONFIG_HOME/peek/config.toml). - proc
- ringbuf
Structs§
- Collect
Options - Connection
Entry - EnvVar
- FdLeak
Warning - GpuInfo
- GPU utilisation snapshot for a single device.
- Kernel
Info - Namespace
Entry - Network
Info - Open
File - Process
Info - Process
Node - Signal
Impact - Structured description of the impact of sending a signal to a process.
- Socket
Entry - Unix
Socket Entry
Enums§
Functions§
- binary_
description - Optional human-readable description for well-known process names.
- collect
- Fast baseline snapshot (no CPU sampling, no extended sections).
- collect_
extended - Full snapshot gated by
opts. On Linux includes kernel, network, files, env, tree, GPU; elsewhere baseline only. - current_
syscall - Current syscall name and description from
/proc/<pid>/syscall(x86_64). ReturnsNoneif unreadable or syscall number unknown. - fd_
soft_ limit - Soft “Max open files” limit from
/proc/<pid>/limits, if available. - oom_
description - Human-readable OOM kill likelihood band (low / moderate / high / critical).
- resolve_
remote - Best-effort reverse DNS for an address (e.g. “192.168.1.1:443”). Time-bounded; for CLI/TUI only.
- signal_
impact - Pre-flight signal impact analysis. Linux only.