NAME

Net::Peep::Client::Sysmonitor - Perl extension for a client to monitor system statistics.

SYNOPSIS

  require 5.005_62;
  use Net::Peep::Client::Sysmonitor;
  $sysmonitor = new Net::Peep::Client::Sysmonitor;
  $SIG{'INT'} = $SIG{'TERM'} = sub { $sysmonitor->shutdown(); exit 0; };
  $sysmonitor->Start();

DESCRIPTION

Monitors uptime, load, user statistics, processes, and disk utilization.

EXPORT

None by default.

METHODS

Note that this section is somewhat incomplete. More documentation will come soon.

    new() - The constructor

    Start() - Begins monitoring system stats.  Terminates by entering
    the Net::Peep::Client->MainLoop() method.

    loop() - The callback called by the Net::Peep::Client->MainLoop()
    method.  See Net::Peep::Client for more information.

    parse(@text) - Callback given to the Net::Peep::Client->parser()
    method which parses the sysmonitor client config section of the
    Peep configuration file.

    parseUptime(@text) - Parses the uptime section of the sysmonitor
    client config section of the Peep configuration file.

    parseProcs(@text) - Parses the procs section of the sysmonitor
    client config section of the Peep configuration file.

    parseDisk(@text) - Parses the disk section of the sysmonitor
    client config section of the Peep configuration file.

    tempParseOldConfig(@text) - Parses the pre-0.4.4 style of
    sysmonitor client config section.  Added for backwards
    compatibility.  Will likely be deprecated with 0.5.0.

    addUptime($uptime) - Adds a Net::Peep::Client::Sysmonitor::Uptime
    object to an array.

    uptimes() - Retrieves an array of
    Net::Peep::Client::Sysmonitor::Uptime objects added by the addUptime method.

    addProc($proc) - Adds a Net::Peep::Client::Sysmonitor::Proc
    object to an array.

    procs() - Retrieves an array of
    Net::Peep::Client::Sysmonitor::Proc objects added by the addProc method.

    addDisk($disk) - Adds a Net::Peep::Client::Sysmonitor::Disk
    object to an array.

    disks() - Retrieves an array of
    Net::Peep::Client::Sysmonitor::Disk objects added by the addDisk method.

AUTHOR

Michael Gilfix <mgilfix@eecs.tufts.edu> Copyright (C) 2001

Collin Starkweather <collin.starkweather@colorado.edu>

SEE ALSO

perl(1), peepd(1), Net::Peep::BC, Net::Peep::Log, Net::Peep::Parser, Net::Peep::Client, sysmonitor.

http://peep.sourceforge.net

TERMS AND CONDITIONS

You should have received a file COPYING containing license terms along with this program; if not, write to Michael Gilfix (mgilfix@eecs.tufts.edu) for a copy.

This version of Peep is open source; you can redistribute it and/or modify it under the terms listed in the file COPYING.

This program 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.

CHANGE LOG

$Log: Sysmonitor.pm,v $ Revision 1.7 2001/10/01 05:20:05 starky Hopefully the final commit before release 0.4.4. Tied up some minor issues, did some beautification of the log messages, added some comments, and made other minor changes.

Revision 1.6 2001/09/23 08:53:52 starky The initial checkin of the 0.4.4 release candidate 1 clients. The release includes (but is not limited to): o A new client: pinger o A greatly expanded sysmonitor client o An API for creating custom clients o Extensive documentation on creating custom clients o Improved configuration file format o E-mail notifications Contact Collin at collin.starkweather@colorado with any questions.

Revision 1.5 2001/08/08 20:17:57 starky Check in of code for the 0.4.3 client release. Includes modifications to allow for backwards-compatibility to Perl 5.00503 and a critical bug fix to the 0.4.2 version of Net::Peep::Conf.

Revision 1.4 2001/07/23 17:46:29 starky Added versioning to the configuration file as well as the ability to specify groups in addition to / as a replacement for event letters. Also changed the Net::Peep::Parse namespace to Net::Peep::Parser. (I don't know why I ever named an object by a verb!)

Revision 1.3 2001/05/07 02:39:19 starky A variety of bug fixes and enhancements: o Fixed bug 421729: Now the --output flag should work as expected and the --logfile flag should not produce any unexpected behavior. o Documentation has been updated and improved, though more improvements and additions are pending. o Removed print STDERRs I'd accidentally left in the last commit. o Other miscellaneous and sundry bug fixes in anticipation of a 0.4.2 release.

Revision 1.2 2001/05/06 21:33:17 starky Bug 421248: The --help flag should now work as expected.

Revision 1.1 2001/04/23 10:13:19 starky Commit in preparation for release 0.4.1.

o Altered package namespace of Peep clients to Net::Peep at the suggestion of a CPAN administrator. o Changed Peep::Client::Log to Net::Peep::Client::Logparser and Peep::Client::System to Net::Peep::Client::Sysmonitor for clarity. o Made adjustments to documentation. o Fixed miscellaneous bugs.

Revision 1.5 2001/04/07 08:01:05 starky Corrected some errors in and made some minor changes to the documentation.

Revision 1.4 2001/04/04 05:40:00 starky Made a more intelligent option parser, allowing a user to more easily override the default options. Also moved all error messages that arise from client options (e.g., using noautodiscovery without specifying a port and server) from the parseopts method to being the responsibility of each individual client.

Also made some minor and transparent changes, such as returning a true value on success for many of the methods which have no explicit return value.

Revision 1.3 2001/03/31 07:51:35 mgilfix

  Last major commit before the 0.4.0 release. All of the newly rewritten
clients and libraries are now working and are nicely formatted. The server
installation has been changed a bit so now peep.conf is generated from
the template file during a configure - which brings us closer to having
a work-out-of-the-box system.

Revision 1.3 2001/03/31 02:17:00 mgilfix Made the final adjustments to for the 0.4.0 release so everything now works. Lots of changes here: autodiscovery works in every situation now (client up, server starts & vice-versa), clients now shutdown elegantly with a SIGTERM or SIGINT and remove their pidfiles upon exit, broadcast and server definitions in the class definitions is now parsed correctly, the client libraries now parse the events so they can translate from names to internal numbers. There's probably some other changes in there but many were made :) Also reformatted all of the code, so it uses consistent indentation.

cpanm Net::Peep

perl -MCPAN -e shell
install Net::Peep