/ 
Nagios-Plugin-OverHTTP-0.15
River stage zero No dependents
/ Nagios::Plugin::OverHTTP::Middleware::StatusPrefix

NAME

Nagios::Plugin::OverHTTP::Middleware::StatusPrefix - Adds plugin name and status to response messages

VERSION

This documentation refers to Nagios::Plugin::OverHTTP::Middleware::StatusPrefix version 0.15

SYNOPSIS

#TODO: Write this

DESCRIPTION

This is a middleware for Nagios::Plugin::OverHTTP that will modify the response by adding the plugin name and status to the beginning of the message as recommended by Nagios plugin guidelines.

PLUGIN OK - Some information
\_________/
     |
Added by middleware

CONSTRUCTOR

This is fully object-oriented, and as such before any method can be used, the constructor needs to be called to create an object to work with.

new

This will construct a new plugin object.

new(%attributes)

%attributes is a HASH where the keys are attributes (specified in the "ATTRIBUTES" section).

new($attributes)

$attributes is a HASHREF where the keys are attributes (specified in the "ATTRIBUTES" section).

ATTRIBUTES

plugin_name

Required. This is a string of the name of the plugin. This will be made all uppercase automatically.

METHODS

rewrite

This takes a Nagios::Plugin::OverHTTP::Response object and rewrites it based on the arguments provided and object creation time and return a Nagios::Plugin::OverHTTP::Response object.

DEPENDENCIES

This module is dependent on the following modules:

AUTHOR

Douglas Christopher Wilson, <doug at somethingdoug.com>

BUGS AND LIMITATIONS

Please report any bugs or feature requests to bug-nagios-plugin-overhttp at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Nagios-Plugin-OverHTTP. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

LICENSE AND COPYRIGHT

Copyright 2010 Douglas Christopher Wilson, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the terms of either:

  • the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version, or

  • the Artistic License version 2.0.