Struct Procfs 

pub struct Procfs<B: Backend = ProcfsBackend> { /* private fields */ }

Procfs-based metric source.

Reads memory and I/O metrics from /proc for a target process and its entire child hierarchy, as well as system-wide memory metrics.

Example

use joule_profiler_source_procfs::{Procfs, config::ProcfsConfig};

let source = Procfs::new(ProcfsConfig::default()).unwrap();

Implementations

impl Procfs

pub fn new(config: ProcfsConfig) -> Result<Self, ProcfsError>

Creates a new Procfs source from the given configuration.

Reads MemTotal from /proc/meminfo at construction time.

Trait Implementations

impl<B: Debug + Backend> Debug for Procfs<B>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<B: Backend> MetricReader for Procfs<B>

async fn init(&mut self, pid: i32) -> Result<(), ProcfsError>

Initializes the source to pid and starts the background poller if a poll_interval is configured.

async fn join(&mut self) -> Result<(), ProcfsError>

Aborts the background poller if still running, or propagates its error if it already finished.

async fn measure(&mut self) -> Result<(), ProcfsError>

Takes a single snapshot of process and global counters and updates them.

If the process is not found, an empty snapshot is used.

async fn retrieve(&mut self) -> Result<Self::Type, ProcfsError>

Returns the accumulated counters for the current phase and resets them.

type Type = Counters

Type of metrics returned by the reader.

type Error = ProcfsError

Error type produced by the reader.

type Config = ProcfsConfig

Config type for configuring the source.

fn from_config(config: ProcfsConfig) -> Result<Self, ProcfsError>

async fn pre_init(&mut self) -> Result<(), ProcfsError>

Pre-initialize the source, called before the process is spawned.

fn get_sensors(&self) -> Result<Sensors, ProcfsError>

Return all sensors available from this reader.

fn to_metrics(&self, counters: Self::Type) -> Result<Metrics, ProcfsError>

Convert the metric reader data to metrics.

fn get_name() -> &'static str

Get the name of the metric source.

fn get_id() -> &'static str

Get the id of the metric source.