| Nagios-Plugin-OverHTTP documentation | Contained in the Nagios-Plugin-OverHTTP distribution. |
Nagios::Plugin::OverHTTP::Formatter - Moose role for output formatters
This documentation refers to Nagios::Plugin::OverHTTP::Formatter version 0.14
package My::Custom::Formatter; use Moose; with 'Nagios::Plugin::OverHTTP::Formatter'; # use the role (required) # Implement the formatter and define # any required methods no Moose; # unimport Moose 1;
This module is a Moose role that defines the required API for formatters.
This must return an integer which may be used as the exit status for the plugin.
This must return a string which may be used as the output to stderr.
Returning a zero-length string will cause nothing to be printed to stderr.
This must return a string which may be used as the output to stdout.
Returning a zero-length string will cause nothing to be printed to stdout.
Required. This is the Nagios::Plugin::OverHTTP::Response object to format.
This provided method is useful to packages that consume this role. This method will take the status as the only argument and will return an integer representing the standard exit code for that status.
# My::Custom::Formatter package
sub exit_code {
my ($self) = @_;
# Just return the default
return $self->standard_status_exit_code($self->response->status);
}
Unable to change the status %s to exit codeThe method standard_status_exit_code was called and the provided argument could not be converted into a known status.
This module is dependent on the following modules:
Douglas Christopher Wilson, <doug at somethingdoug.com>
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.
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:
| Nagios-Plugin-OverHTTP documentation | Contained in the Nagios-Plugin-OverHTTP distribution. |
package Nagios::Plugin::OverHTTP::Formatter; use 5.008001; use strict; use warnings 'all'; ########################################################################### # METADATA our $AUTHORITY = 'cpan:DOUGDUDE'; our $VERSION = '0.14'; ########################################################################### # MOOSE ROLE use Moose::Role 0.74; ########################################################################### # MOOSE TYPES use Nagios::Plugin::OverHTTP::Library qw( Status ); ########################################################################### # MODULES use Carp qw(croak); use Readonly 1.03; ########################################################################### # ALL IMPORTS BEFORE THIS WILL BE ERASED use namespace::clean 0.04 -except => [qw(meta)]; ########################################################################### # PRIVATE CONSTANTS Readonly my $ERROR_BAD_STATUS => q{Unable to change the status %s to exit code}; ########################################################################### # REQUIRED METHODS requires qw( exit_code stderr stdout ); ########################################################################### # ATTRIBUTES has 'response' => ( is => 'ro', isa => 'Nagios::Plugin::OverHTTP::Response', required => 1, ); ########################################################################### # METHODS sub standard_status_exit_code { my ($self, $status) = @_; # Coerse status my $real_status = to_Status($status); if (!defined $real_status) { # Croak on bad status croak sprintf $ERROR_BAD_STATUS, $status; } # The status itself is already the exit code value :) return $real_status; } 1; __END__