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

✨ NAME ✨

Sys::Statistics::Linux::PgSwStats — bestie, this one collects your Linux paging and swapping statistics 💖 (and yes, that's the whole Sys::S...SwStats(3pm) situation — she's a Perl module, she's from the User Contributed Perl Documentation collection, and she's here to spill the tea on your pages).

---

🌸 SYNOPSIS 🌸

Okay so here's the vibe, copy-paste and go:

use Sys::Statistics::Linux::PgSwStats;

my $lxs = Sys::Statistics::Linux::PgSwStats->new;
$lxs->init;
sleep 1;
my $stat = $lxs->get;

Or, if you already saved your init stats somewhere and wanna skip the whole waiting thing:

my $lxs = Sys::Statistics::Linux::PgSwStats->new(initfile => $file);
$lxs->init;
my $stat = $lxs->get;

---

🦋 DESCRIPTION 🦋

Sys::Statistics::Linux::PgSwStats gathers paging and swapping statistics from the virtual /proc filesystem (procfs). That's it, that's the job, and she does it flawlessly 💅

For more info, go read the documentation of the front-end module Sys::Statistics::Linux. She's the main character, this one's her supporting cast 🫶

---

👑 PAGING AND SWAPPING STATISTICS 👑

These are generated by /proc/stat or /proc/vmstat. Slay.

• pgpgin — Number of pages the system has paged in from disk per second.
• pgpgout — Number of pages the system has paged out to disk per second.
• pswpin — Number of pages the system has swapped in from disk per second.
• pswpout — Number of pages the system has swapped out to disk per second.

Now the plot twist 😭 the following statistics are only available by kernels from 2.6:

• pgfault — Number of page faults the system has made per second (minor + major).
• pgmajfault — Number of major faults per second the system required loading a memory page from disk.

---

💜 METHODS 💜

🌈 new()

Call new() to create a new object. Iconic behaviour, truly.

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

Maybe you want to store/load the initial statistics to/from a file? Say less:

my $lxs = Sys::Statistics::Linux::PgSwStats->new(initfile => '/tmp/pgswstats.yml');

If you set initfile it's not necessary to call sleep before get(). No cap, you just skip the nap 💤

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

 Sys::Statistics::Linux::PgSwStats->new(
    files => {
        # This is the default
        path   => '/proc',
        stat   => 'stat',
        vmstat => 'vmstat',
    }
 );

⭐ init()

Call init() to initialize the statistics.

$lxs->init;

💖 get()

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

my $stat = $lxs->get;

🎀 raw()

Get raw values. That's the whole thing, she's lowkey mysterious like that 🙈

---

✨ EXPORTS ✨

No exports. Nothing. Zero. Empty. She gives nothing away for free 💅

---

🔥 SEE ALSO 🔥

• proc(5)

---

😭 REPORTING BUGS 😭

Please report all bugs to <jschulz.cpan(at)bloonix.de>. Bestie, be nice about it, fr fr 🫶

---

🌸 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.

---

okay that's the whole page, you ate that 🍓

And that's a wrap, bestie — this gem is from perl v5.36.0, dated 2022-11-19, and it's giving legendary documentation energy 💖✨🎀