/ 
Linux-Info-0.3
River stage one • 2 direct dependents • 3 total dependents
/ Linux::Info::LoadAVG

NAME

Linux::Info::LoadAVG - Collect linux load average statistics.

SYNOPSIS

use Linux::Info::LoadAVG;

my $lxs  = Linux::Info::LoadAVG->new;
my $stat = $lxs->get;

DESCRIPTION

Linux::Info::LoadAVG gathers the load average from the virtual /proc filesystem (procfs).

For more information read the documentation of the front-end module Linux::Info.

LOAD AVERAGE STATISTICS

Generated by /proc/loadavg.

avg_1   -  The average processor workload of the last minute.
avg_5   -  The average processor workload of the last five minutes.
avg_15  -  The average processor workload of the last fifteen minutes.

METHODS

new()

Call new() to create a new object.

my $lxs = Linux::Info::LoadAVG->new;

It's possible to set the path to the proc filesystem.

 Linux::Info::LoadAVG->new(
    files => {
        # This is the default
        path    => '/proc',
        loadavg => 'loadavg',
    }
);

get()

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

my $stat = $lxs->get;

EXPORTS

Nothing.

SEE ALSO

AUTHOR

Alceu Rodrigues de Freitas Junior, <arfreitas@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2015 of Alceu Rodrigues de Freitas Junior, <arfreitas@cpan.org>

This file is part of Linux Info project.

Linux Info is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Linux Info is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Linux Info. If not, see <http://www.gnu.org/licenses/>.