NAME

Sys::Statistics::Linux::DiskUsage - Collect linux disk usage.

SYNOPSIS

    use Sys::Statistics::Linux::DiskUsage;

    my $lxs  = new Sys::Statistics::Linux::DiskUsage;
    my $stat = $lxs->get;

DESCRIPTION

Sys::Statistics::Linux::DiskUsage gathers the disk usage with the command df.

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

DISK USAGE INFORMATIONS

Generated by /bin/df -kP.

    total       -  The total size of the disk.
    usage       -  The used disk space in kilobytes.
    free        -  The free disk space in kilobytes.
    usageper    -  The used disk space in percent.
    mountpoint  -  The moint point of the disk.

GLOBAL VARS

If you want to change the path or arguments for df you can use the following variables...

    $Sys::Statistics::Linux::DiskUsage::DF_PATH = '/bin';
    $Sys::Statistics::Linux::DiskUsage::DF_CMD  = 'df -akP';

Example:

    use Sys::Statistics::Linux;
    use Sys::Statistics::Linux::DiskUsage;
    $Sys::Statistics::Linux::DiskUsage::DF_CMD = 'df -akP';

    my $sys  = Sys::Statistics::Linux->new(diskusage => 1);
    my $disk = $sys->get;

METHODS

new()

Call new() to create a new object.

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

It's possible to set the path to df.

     Sys::Statistics::Linux::DiskUsage->new(
        cmd => {
            # This is the default
            path => '/bin',
            df   => 'df -kP 2>/dev/null',
        }
    );

get()

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

    my $stat = $lxs->get;

EXPORTS

No exports.

SEE ALSO

df(1)

REPORTING BUGS

Please report all bugs to <jschulz.cpan(at)bloonix.de>.

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.

cpanm Sys::Statistics::Linux

perl -MCPAN -e shell
install Sys::Statistics::Linux