EXPORTS

    OK
    WARNING
    CRITICAL
    UNKNOWN
    DEPENDENT

The following variables are also exported on request:

%ERRORS

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

%STATUS_TEXT

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

CONSTRUCTOR

        Nagios::Plugin->new;

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

        Nagios::Plugin->new(
                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 following named arguments:

shortname

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::Plugin::Getopt" object so you can start doing command line argument processing. See "CONSTRUCTOR" in Nagios::Plugin::Getopt for more about "usage" and the following options:

version

url

blurb

license

extra

plugin

timeout

OPTION HANDLING METHODS

add_arg

Examples:

  # Define --hello argument (named parameters)
  $plugin->add_arg(
    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 details.

getopts()

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 details.

opts()

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.

E.g.

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

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

  # 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.

EXIT METHODS

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.

max_state, max_state_alt

These are wrapper function for Nagios::Plugin::Functions::max_state and Nagios::Plugin::Functions::max_state_alt.

THRESHOLD METHODS

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()".

You can specify $value as an array of values and each will be checked against the thresholds.

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

  $p->nagios_exit(
        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://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT for details and examples of the threshold format.

threshold()

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 script.

MESSAGE METHODS

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_messages) 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 codes.

check_messages()

Check the current set of messages and return an appropriate 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, suitable 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):

PERFORMANCE DATA METHODS

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.sourceforge.net/developer-guidelines.html#AEN202).