Filewatcher File Search File Search
Content Search
» » » » » » perl-Nagios-Plugin-0.24-2.el4.rf.noarch.rpm » Content »
pkg://perl-Nagios-Plugin-0.24-2.el4.rf.noarch.rpm:59665/usr/share/man/man3/  info  HEADER  downloads

perl-Nagios-Plugin - Family of perl modules to streamline writing Nagios…  more info»


Nagios::Plugin(3)User Contributed Perl DocumentatioNagios::Plugin(3)

       Nagios::Plugin - A family of perl modules to streamline writ‐
       ing Nagios plugins

          # Constants OK, WARNING, CRITICAL, and UNKNOWN are exported by default
          # See also Nagios::Plugin::Functions for a functional interface
          use Nagios::Plugin;

          # Constructor
          $np = Nagios::Plugin->new;                               # OR
          $np = Nagios::Plugin->new( shortname => "PAGESIZE" );    # OR

          # use Nagios::Plugin::Getopt to process the @ARGV command line options:
          #   --verbose, --help, --usage, --timeout and --host are defined automatically.
          $np = Nagios::Plugin->new(
            usage => "Usage: %s [ -v⎪--verbose ]  [-H <host>] [-t <timeout>] "
              . "[ -c⎪--critical=<threshold> ] [ -w⎪--warning=<threshold> ]",

          # add valid command line options and build them into your usage/help documentation.
            spec => 'warning⎪w=s',
            help => '-w, --warning=INTEGER:INTEGER .  See '
              . ' '
              . 'for the threshold format. ',

          # Parse @ARGV and process standard arguments (e.g. usage, help, version)

          # Exit/return value methods - nagios_exit( CODE, MESSAGE ),
          #                             nagios_die( MESSAGE, [CODE])
          $page = retrieve_page($page1)
              or $np->nagios_exit( UNKNOWN, "Could not retrieve page" );
              # Return code: 3;
              #   output: PAGESIZE UNKNOWN - Could not retrieve page
              or $np->nagios_exit( CRITICAL, "Bad page found" );

          # nagios_die() is just like nagios_exit(), but return code defaults
          #   to UNKNOWN
          $page = retrieve_page($page2)
            or $np->nagios_die( "Could not retrieve page" );
            # Return code: 3;
            #   output: PAGESIZE UNKNOWN - Could not retrieve page

          # Threshold methods
          $code = $np->check_threshold(
            check => $value,
            warning => $warning_threshold,
            critical => $critical_threshold,
          $np->nagios_exit( $code, "Threshold check failed" ) if $code != OK;

          # Message methods (EXPERIMENTAL AND SUBJECT TO CHANGE) -
          #   add_message( CODE, $message ); check_messages()
          for (@collection) {
            if (m/Error/) {
              $np->add_message( CRITICAL, $_ );
            } else {
              $np->add_message( OK, $_ );
          ($code, $message) = $np->check_message();
          nagios_exit( $code, $message );
          # If any items in collection matched m/Error/, returns CRITICAL and
          #   the joined set of Error messages; otherwise returns OK and the
          #   joined set of ok messages

          # Perfdata methods
            label => "size",
            value => $value,
            uom => "kB",
            threshold => $threshold,
          $np->add_perfdata( label => "time", ... );
          $np->nagios_exit( OK, "page size at http://... was ${value}kB" );
          # Return code: 0;
          #   output: PAGESIZE OK - page size at http://... was 36kB \
          #   ⎪ size=36kB;10:25;25: time=...

       Nagios::Plugin and its associated Nagios::Plugin::* modules
       are a family of perl modules to streamline writing Nagios
       plugins. The main end user modules are Nagios::Plugin, pro‐
       viding an object-oriented interface to the entire
       Nagios::Plugin::* collection, and Nagios::Plugin::Functions,
       providing a simpler functional interface to a useful subset
       of the available functionality.

       The purpose of the collection is to make it as simple as pos‐
       sible for developers to create plugins that conform the
       Nagios Plugin guidelines (http://nagiosplug.source‐


       Nagios status code constants are exported by default:


       The following variables are also exported on request:

           A hash mapping error strings ("CRITICAL", "UNKNOWN",
           etc.) to the corresponding status code.

           A hash mapping status code constants (OK, WARNING, CRITI‐
           CAL, etc.) to the corresponding error string ("OK",
           "WARNING, "CRITICAL", etc.) i.e. the reverse of %ERRORS.



               Nagios::Plugin->new( shortname => 'PAGESIZE' );

                       usage => "Usage: %s [ -v⎪--verbose ]  [-H <host>] [-t <timeout>]
                            [ -c⎪--critical=<critical threshold> ] [ -w⎪--warning=<warning threshold> ]  ",
                       version => $VERSION,
                       blurb   => $blurb,
                       extra   => $extra,
                       url     => $url,
                       license => $license,
                       plugin  => basename $0,
                       timeout => 15,

       Instantiates a new Nagios::Plugin object. Accepts the follow‐
       ing named arguments:

           The 'shortname' for this plugin, used as the first token
           in the plugin output by the various exit methods.
           Default: uc basename $0.

       usage ("Usage:  %s --foo --bar")
           Passing a value for the usage() argument makes
           Nagios::Plugin instantiate its own "Nagios::Plug‐
           in::Getopt" object so you can start doing command line
           argument processing.  See "CONSTRUCTOR" in Nagios::Plug‐
           in::Getopt for more about "usage" and the following



       "Nagios::Plugin" provides these methods for accessing the
       functionality in "Nagios::Plugin::Getopt".


             # Define --hello argument (named parameters)
               spec => 'hello=s',
               help => "--hello\n   Hello string",
               required => 1,

             # Define --hello argument (positional parameters)
             #   Parameter order is 'spec', 'help', 'default', 'required?'
             $plugin->add_arg('hello=s', "--hello\n   Hello string", undef, 1);

           See "ARGUMENTS" in Nagios::Plugin::Getopt for more

           Parses and processes the command line options you've
           defined, automatically doing the right thing with
           help/usage/version arguments.

           See  "GETOPTS" in Nagios::Plugin::Getopt for more

           Assuming you've instantiated it by passing 'usage' to
           new(), opts() returns the Nagios::Plugin object's
           "Nagios::Plugin::Getopt" object, with which you can do
           lots of great things.


             if ( $plugin->opts->verbose ) {
                     print "yah yah YAH YAH YAH!!!";

             # start counting down to timeout
             alarm $plugin->opts->timeout;

             # access any of your custom command line options,
             # assuming you've done these steps above:
             #   $plugin->add_arg('my_argument=s', '--my_argument [STRING]');
             #   $plugin->getopts;
             print $plugin->opts->my_argument;

           Again, see Nagios::Plugin::Getopt.


       nagios_exit( <CODE>, $message )
           Exit with return code CODE, and a standard nagios message
           of the form "SHORTNAME CODE - $message".

       nagios_die( $message, [<CODE>] )
           Same as nagios_exit(), except that CODE is optional,
           defaulting to UNKNOWN.  NOTE: exceptions are not raised
           by default to calling code.  Set $_use_die flag if this
           functionality is required (see test code).

       die( $message, [<CODE>] )
           Alias for nagios_die(). Deprecated.


       These provide a top level interface to the "Nagios::Plug‐
       in::Threshold" module; for more details, see Nagios::Plug‐
       in::Threshold and Nagios::Plugin::Range.

       check_threshold( $value )
       check_threshold( check => $value, warning => $warn, critical
       => $crit )
           Evaluates $value against the thresholds and returns OK,
           CRITICAL, or WARNING constant.  The thresholds may be:

           1. explicitly set by passing 'warning' and/or 'critical'
           parameters to
              "check_threshold()", or,

           2. explicitly set by calling "set_thresholds()" before
           "check_threshold()", or,

           3. implicitly set by command-line parameters -w, -c,
           --critical or
              --warning, if you have run "$plugin-"getopts()>.

           The return value is ready to pass to C <nagios_exit>, e .
           g .,

                   return_code => $p->check_threshold($result),
                   message     => " sample result was $result"

       set_thresholds(warning => "10:25", critical => "~:25")
           Sets the acceptable ranges and creates the plugin's
           Nagios::Plugins::Threshold object.  See http://nagios‐
           FORMAT for details and examples of the threshold format.

           Returns the object's "Nagios::Plugin::Threshold" object,
           if it has been defined by calling set_thresholds().  You
           can pass a new Threshold object to it to replace the old
           one too, but you shouldn't need to do that from a plugin



       add_messages and check_messages are higher-level convenience
       methods to add and then check a set of messages, returning an
       appropriate return code and/or result message. They are
       equivalent to maintaining a set of @critical, @warning, and
       and @ok message arrays (add_message), and then doing a final
       if test (check_message) like this:

         if (@critical) {
           nagios_exit( CRITICAL, join(' ', @critical) );
         elsif (@warning) {
           nagios_exit( WARNING, join(' ', @warning) );
         else {
           nagios_exit( OK, join(' ', @ok) );

       add_message( <CODE>, $message )
           Add a message with CODE status to the object. May be
           called multiple times.  The messages added are checked by
           check_messages, following.

           Only CRITICAL, WARNING, and OK are accepted as valid

           Check the current set of messages and return an appropri‐
           ate nagios return code and/or a result message. In scalar
           context, returns only a return code; in list context
           returns both a return code and an output message, suit‐
           able for passing directly to nagios_exit() e.g.

               $code = $np->check_messages;
               ($code, $message) = $np->check_messages;

           check_messages returns CRITICAL if any critical messages
           are found, WARNING if any warning messages are found, and
           OK otherwise. The message returned in list context
           defaults to the joined set of error messages; this may be
           customised using the arguments below.

           check_messages accepts the following named arguments
           (none are required):

           join => SCALAR
               A string used to join the relevant array to generate
               the message string returned in list context i.e. if
               the 'critical' array @crit is non-empty, check_mes‐
               sages would return:

                   join( $join, @crit )

               as the result message. Default: ' ' (space).

           join_all => SCALAR
               By default, only one set of messages are joined and
               returned in the result message i.e. if the result is
               CRITICAL, only the 'critical' messages are included
               in the result; if WARNING, only the 'warning' mes‐
               sages are included; if OK, the 'ok' messages are
               included (if supplied) i.e. the default is to return
               an 'errors-only' type message.

               If join_all is supplied, however, it will be used as
               a string to join the resultant critical, warning, and
               ok messages together i.e.  all messages are joined
               and returned.

           critical => ARRAYREF
               Additional critical messages to supplement any passed
               in via add_message().

           warning => ARRAYREF
               Additional warning messages to supplement any passed
               in via add_message().

           ok => ARRAYREF ⎪ SCALAR
               Additional ok messages to supplement any passed in
               via add_message().


       add_perfdata( label => "size", value => $value, uom => "kB",
       threshold => $threshold )
           Add a set of performance data to the object. May be
           called multiple times.  The performance data is included
           in the standard plugin output messages by the various
           exit methods.

           See the Nagios::Plugin::Performance documentation for
           more information on performance data and the various
           field definitions, as well as the relevant section of the
           Nagios Plugin guidelines (http://nagiosplug.source‐

       "Enough talk!  Show me some examples!"

       See the file '' in the 't' directory included
       with the Nagios::Plugin distribution for a complete working
       example of a plugin script.

       The Nagios::Plugin::* modules are currently experimental and
       so the interfaces may change up until Nagios::Plugin hits
       version 1.0, although every attempt will be made to keep them
       as backwards compatible as possible.

       See Nagios::Plugin::Functions for a simple functional inter‐
       face to a subset of the available Nagios::Plugin functional‐

       See also Nagios::Plugin::Getopt, Nagios::Plugin::Range,
       Nagios::Plugin::Performance, Nagios::Plugin::Range, and

       The Nagios Plugin project page is at http://nagios‐

       Please report bugs in these modules to the Nagios Plugin
       development team:

       Maintained by the Nagios Plugin development team -

       Originally by Ton Voon, <>.

       Copyright (C) 2006 by Nagios Plugin Development Team

       This library is free software; you can redistribute it and/or
       modify it under the same terms as Perl itself, either Perl
       version 5.8.4 or, at your option, any later version of Perl 5
       you may have available.

perl v5.8.5                  2007-12-13            Nagios::Plugin(3)
Results 1 - 1 of 1
Help - FTP Sites List - Software Dir.
Search over 15 billion files
© 1997-2017