Sys::S...ocesses(3pm)

💖 NAME 💖

Sys::Statistics::Linux::Processes — bestie, it collects linux process statistics. that's the whole assignment. 💅

---

✨ SYNOPSIS ✨

use Sys::Statistics::Linux::Processes;

my $lxs = Sys::Statistics::Linux::Processes->new;
# or Sys::Statistics::Linux::Processes->new(pids => \@pids)

$lxs->init;
sleep 1;
my $stat = $lxs->get;

---

🦋 DESCRIPTION 🦋

okay so Sys::Statistics::Linux::Processes gathers process info straight out of the virtual /proc filesystem (procfs). that's it. that's the gig. 🫶

want the full lore? go read the documentation of the front-end module Sys::Statistics::Linux. it's giving main character energy, fr.

---

👑 PROCESS STATISTICS 👑

🌸 generated by /proc/<pid>/stat, /proc/<pid>/status, /proc/<pid>/cmdline and getpwuid()

heads up bestie: if /etc/passwd isn't readable, the key owner gets set to N/a. no cap. 😭

• ppid — the parent process ID of the process.
• nlwp — the number of light weight processes that runs by this process.
• owner — the owner name of the process.
• pgrp — the group ID of the process.
• state — the status of the process.
• session — the session ID of the process.
• ttynr — the tty the process use.
• minflt — the number of minor faults the process made.
• cminflt — the number of minor faults the child process made.
• mayflt — the number of mayor faults the process made.
• cmayflt — the number of mayor faults the child process made.
• stime — the number of jiffies the process have beed scheduled in kernel mode.
• utime — the number of jiffies the process have beed scheduled in user mode.
• ttime — the number of jiffies the process have beed scheduled (user + kernel).
• cstime — the number of jiffies the process waited for childrens have been scheduled in kernel mode.
• cutime — the number of jiffies the process waited for childrens have been scheduled in user mode.
• prior — the priority of the process (+15).
• nice — the nice level of the process.
• sttime — the time in jiffies the process started after system boot.
• actime — the time in D:H:M:S (days, hours, minutes, seconds) the process is active.
• vsize — the size of virtual memory of the process.
• nswap — the size of swap space of the process.
• cnswap — the size of swap space of the childrens of the process.
• cpu — the CPU number the process was last executed on.
• wchan — the "channel" in which the process is waiting.
• fd — this is a subhash containing each file which the process has open, named by its file descriptor. 0 is standard input, 1 standard output, 2 standard error, etc. Because only the owner or root can read /proc/<pid>/fd this hash could be empty.
• cmd — command of the process.
• cmdline — command line of the process.

🧚 generated by /proc/<pid>/statm

all these stats are giving memory info, in pages:

• size — the total program size of the process.
• resident — number of resident set size, this includes the text, data and stack space.
• share — total size of shared pages of the process.
• trs — total text size of the process.
• drs — total data/stack size of the process.
• lrs — total library size of the process.
• dtp — total size of dirty pages of the process (unused since kernel 2.6).

and guess what — you can convert pages to bytes or kilobytes. example: if the pagesize of your system is 4kb, then:

$Sys::Statistics::Linux::Processes::PAGES_TO_BYTES =    0; # pages (default)
$Sys::Statistics::Linux::Processes::PAGES_TO_BYTES =    4; # convert to kilobytes
$Sys::Statistics::Linux::Processes::PAGES_TO_BYTES = 4096; # convert to bytes

# or with
Sys::Statistics::Linux::Processes->new(pages_to_bytes => 4096);

🍓 generated by /proc/<pid>/io

• rchar — bytes read from storage (might have been from pagecache).
• wchar — bytes written.
• syscr — number of read syscalls.
• syscw — numner of write syscalls.
• read_bytes — bytes really fetched from storage layer.
• write_bytes — bytes sent to the storage layer.
• cancelled_write_bytes — refer to docs.

See Documentation/filesystems/proc.txt for more (from kernel 2.6.20). iykyk 📖

---

💅 METHODS 💅

🎀 new()

call new() to create a new object. iconic.

my $lxs = Sys::Statistics::Linux::Processes->new;

it's possible to handoff an array reference with a PID list. yes queen, filter away:

my $lxs = Sys::Statistics::Linux::Processes->new(pids => [ 1, 2, 3 ]);

it's also possible to set the path to the proc filesystem:

 Sys::Statistics::Linux::Processes->new(
    files => {
        # This is the default
        path    => '/proc',
        uptime  => 'uptime',
        stat    => 'stat',
        statm   => 'statm',
        status  => 'status',
        cmdline => 'cmdline',
        wchan   => 'wchan',
        fd      => 'fd',
        io      => 'io',
    }
);

🎀 init()

call init() to initialize the statistics. gotta set the stage before the show, bestie.

$lxs->init;

🎀 get()

call get() to get the statistics. get() returns the statistics as a hash reference. slay.

my $stat = $lxs->get;

note:

processes that were created between the call of init() and get() are returned as well, but the keys minflt, cminflt, mayflt, cmayflt, utime, stime, cutime, and cstime are set to the value 0.00 because there are no inititial values to calculate the deltas. 💀 no history = no delta, that's just math.

🎀 raw()

get raw values. untouched, unfiltered, raw. 🔥

---

🌈 EXPORTS 🌈

no exports. nothing. zero. the way that it just doesn't export anything... periodt. 🙈

---

⭐ SEE ALSO ⭐

• proc(5)
• perldoc -f getpwuid

---

💀 REPORTING BUGS 💀

please report all bugs to <jschulz.cpan(at)bloonix.de>. she's listening, don't be shy. 📬

---

👑 AUTHOR 👑

Jonny Schulz <jschulz.cpan(at)bloonix.de>.

---

🌸 COPYRIGHT 🌸

Copyright (c) 2006, 2007 by Jonny Schulz. All rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

---

and that's the whole page bestie 💖 this little doc came from the User Contributed Perl Documentation section, generated under perl v5.36.0 on 2022-11-19 — go forth and read your /proc like the icon you are. 🦋✨