Sys::Statistics::Linux::CpuStats(3pm)			User Contributed Perl Documentation		     Sys::Statistics::Linux::CpuStats(3pm)

NAME

       Sys::Statistics::Linux::CpuStats - Collect linux cpu statistics.

SYNOPSIS

	   use Sys::Statistics::Linux::CpuStats;

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

       Or

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

DESCRIPTION

       Sys::Statistics::Linux::CpuStats gathers cpu statistics from the virtual /proc filesystem (procfs).

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

CPU STATISTICS

       Generated by /proc/stat for each cpu (cpu0, cpu1 ...). cpu without a number is the summary.

	   user    -  Percentage of CPU utilization at the user level.
	   nice    -  Percentage of CPU utilization at the user level with nice priority.
	   system  -  Percentage of CPU utilization at the system level.
	   idle    -  Percentage of time the CPU is in idle state.
	   total   -  Total percentage of CPU utilization.

       Statistics with kernels >= 2.6.

	   iowait  -  Percentage of time the CPU is in idle state because an I/O operation
		      is waiting to complete.
	   irq	   -  Percentage of time the CPU is servicing interrupts.
	   softirq -  Percentage of time the CPU is servicing softirqs.
	   steal   -  Percentage of stolen CPU time, which is the time spent in other
		      operating systems when running in a virtualized environment (>=2.6.11).

METHODS

   new()
       Call "new()" to create a new object.

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

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

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

       If you set "initfile" it's not necessary to call sleep before "get()".

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

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

   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 $stats = $lxs->get;

   raw()
       Get raw values.

EXPORTS

       No exports.

SEE ALSO

       proc(5)

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.

perl v5.14.2							    2012-03-09				     Sys::Statistics::Linux::CpuStats(3pm)