VBTK::Wrapper::Vmstat - System monitoring with 'vmstat'

  # If you like all the defaults, then there's no need to over-ride them.
  $o = new VBTK::Wrapper::Vmstat ();
  $vbObj = $o->addVBObj ();

  VBTK::runAll;

#############################################################################
#
#                 NOTE: This file under revision control using RCS
#                       Any changes made without RCS will be lost
#
#              $Source: /usr/local/cvsroot/vbtk/VBTK/Wrapper/Vmstat.pm,v $
#            $Revision: 1.9 $
#                $Date: 2002/03/04 20:53:08 $
#              $Author: bhenry $
#              $Locker:  $
#               $State: Exp $
#
#              Purpose: An extension of VBTK::Wrapper for use in running vmstat
#
#           Depends on: VBTK::Common, VBTK::Wrapper
#
#       Copyright (C) 1996 - 2002  Brent Henry
#
#       This program is free software; you can redistribute it and/or
#       modify it under the terms of version 2 of the GNU General Public
#       License as published by the Free Software Foundation available at:
#       http://http://www.gnu.org/copyleft/gpl.html
#
#       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.  See the
#       GNU General Public License for more details.
#
#############################################################################
#
#
#       REVISION HISTORY:
#
#       $Log: Vmstat.pm,v $
#       Revision 1.9  2002/03/04 20:53:08  bhenry
#       *** empty log message ***
#
#       Revision 1.8  2002/03/04 16:49:10  bhenry
#       Changed requirement back to perl 5.6.0
#
#       Revision 1.7  2002/03/02 00:53:56  bhenry
#       Documentation updates
#
#       Revision 1.6  2002/02/20 20:41:35  bhenry
#       *** empty log message ***
#
#       Revision 1.5  2002/02/13 07:36:14  bhenry
#       Disabled RrdLogRecovery and removed use of @log
#
#       Revision 1.4  2002/01/26 06:15:15  bhenry
#       Changed to not specify absolute path
#
#       Revision 1.3  2002/01/25 07:11:52  bhenry
#       Changed to inherit from Wrapper
#
#       Revision 1.2  2002/01/21 17:07:56  bhenry
#       Disabled 'uninitialized' warnings
#
#       Revision 1.1.1.1  2002/01/17 18:05:57  bhenry
#       VBTK Project
#

package VBTK::Wrapper::Vmstat;

use 5.6.0;
use strict;
use warnings;
# I like using undef as a value so I'm turning off the uninitialized warnings
no warnings qw(uninitialized);

use VBTK::Common;
use VBTK::Wrapper;

# Inherit methods from VBTK::Wrapper;
our @ISA=qw(VBTK::Wrapper);

our $VERBOSE = $ENV{VERBOSE};

#-------------------------------------------------------------------------------
# Function:     new
# Description:  Object constructor.  Allocates memory for all class members
# Input Parms:
# Output Parms: Pointer to class
#-------------------------------------------------------------------------------
sub new
{
    my $type = shift;
    my $self = {};
    bless $self, $type;

    # Store all passed input name pairs in the object
    $self->set(@_);

    # Setup a default interval
    my $interval = 60;

    # Setup a standard header and detail line for use in the VBObject and logs.
    my $stdHeader = 
        [ '                   procs     memory            page            disk          faults      cpu',
          '        time       r b w   swap  free  re  mf pi po fr de sr s0 s6 sd sd   in   sy   cs us sy id' ];
    my $stdDetail = [ '$time $data' ];

    # Try to run psrinfo to count the number of CPU's    
    my $numCpus = 1;
    if (-x "/usr/sbin/psrinfo")
    {
        $numCpus = `/usr/sbin/psrinfo | /usr/bin/wc -l`;
        $numCpus =~ s/\s+//g;
    }

    # Setup a hash of default parameters
    my $defaultParms = {
        Interval          => $interval,
        Execute           => "vmstat $interval",
        SourceList        => undef,
        VBServerURI       => $::VBURI,
        VBHeader          => $stdHeader,
        VBDetail          => $stdDetail,
        LogFile           => undef,
        LogHeader         => $stdHeader,
        LogDetail         => $stdDetail,
        RotateLogAt       => '12:00am',
        RotateLogOnEOF    => undef,
        Split             => '\s+',
        Filter            => '^\s*\d+[^a-zA-Z]*$',
        Ignore            => undef,
        SkipLines         => 3,
        Timeout           => undef,
        TimeoutStatus     => undef,
        Follow            => 1,
        FollowTimeout     => ((2 * $interval) + 10),
        FollowHeartbeat   => undef,
        SetRunStatus      => undef,
        NonZeroExitStatus => undef,
        SuppressStdout    => undef,
        SuppressMessages  => undef,
        DebugHeader       => 'vmstat',
        NumCpus           => $numCpus 
    };

    # Run the validation, setting defaults if values are not already set
    $self->validateParms($defaultParms) || &fatal("Exiting");

    # Temporarily remove parms which we don't want to pass on to the real wrapper.
    delete $self->{NumCpus};

    # Initialize a wrapper object.
    $self->SUPER::new() || return undef;

    # Store the default parms
    $self->{defaultParms} = $defaultParms;
    $self->{NumCpus}      = $numCpus;

    ($self);
}

#-------------------------------------------------------------------------------
# Function:     addVBObj
# Description:  Add a vb object to the wrapper object.
# Input Parms:
# Output Parms: None
#-------------------------------------------------------------------------------
sub addVBObj
{
    my $self = shift;
    my $NumCpus    = $self->{NumCpus};
    my $Interval   = $self->{Interval};
    my %args = @_;

    # Setup some reasonable thresholds        
    my $warnRunQueue = $NumCpus;
    my $failRunQueue = $NumCpus * 4;
    my $expireAfterSec = int($Interval * 3);
    my $description = qq( 
                This object uses the 'vmstat' command to monitor the CPU utilization
                on $::HOST.  It will set the status to 'Warning' or 'Failed' based on the
                value of the run queue and the CPU idle time.
        );

    # Setup a hash of rules to be returned
    my $defaultRules = {
        VBObjName           => ".$::HOST.cpu",
        TextHistoryLimit    => 100,
        ReverseText         => 1,
        Rules               => {
             "(\$data[1] > $warnRunQueue)" => 'Warn',
             "(\$data[1] > $failRunQueue)" => 'Fail' },
        Requirements        => undef,
        StatusHistoryLimit  => 30,
        StatusChangeActions => undef, 
        StatusUpgradeRules  => undef,
        ExpireAfter         => "$expireAfterSec seconds",
        Description         => $description,
        RrdTimeCol          => undef,
        RrdColumns          => [ '$data[20]', '$data[21]', '$data[1]', '$data[12]' ],
        RrdFilter           => undef,
        RrdMin              => undef,
        RrdMax              => undef,
        RrdXFF              => undef,
        RrdCF               => undef,
        RrdDST              => undef,
    };

    # Run the validation    
    &validateParms(\%args,$defaultRules) || &fatal("Exiting");

    # Add the rule
    my $vbObj = $self->SUPER::addVBObj(%args) || return undef;

    # Now define what graphs to show on this object's page
    $vbObj->addGraphGroup (
        GroupNumber    => 1,
        DataSourceList => undef,
        Labels         => 'user,system,runQueue,scanRate',
        LineWidth      => undef,
        Colors         => undef,
        VLabel         => undef,
        Title          => "$::HOST cpu",
        TimeWindowList => undef,
        CF             => undef,
        XSize          => undef,
        YSize          => undef,
        Target         => undef
    );

    ($vbObj);
}

1;
__END__