view release on metacpan or  search on metacpan

lib/ASNMTAP/Asnmtap/Plugins.pod  view on Meta::CPAN

=item Plugin Return Codes

The return codes below are based on the POSIX spec of returning a  positive value. ASNMTAP supports POSIX return codes by default.

Note: Some plugins will on occasion print on STDOUT that an error occurred and error code is 138 or 255 or some such number. These are usually caused by plugins using system commands and having not enough checks to catch unexpected output. Developers...

Numeric Value, Service Status & Status Description:

=over 4

=item 0 OK

The plugin was able to check the service and it appeared to be functioning properly

=item 1 Warning

The plugin was able to check the service, but it appeared to be above some "warning" threshold or did not appear to be working properly

=item 2 Critical

The plugin detected that either the service was not running or it was above some "critical" threshold

=item 3 Unknown

Invalid command line arguments were supplied to the plugin or low-level failures internal to the plugin (such as unable to fork, or open a tcp socket) that prevent it from performing the specified operation. Higher-level errors (such as name resoluti...

=back

=item Threshold range format

Thresholds ranges define the warning and critical levels for plugins to alert on. The theory is that the plugin will do some sort of check which returns back a numerical value, or metric, which is then compared to the warning and critical thresholds.

This is the generalised format for threshold ranges:

[@]start:end

=over 4

=item Notes

=over 4

=item 1

start > end

=item 2

start and ":" is not required if start=0

=item 3

if range is of format "start:" and end is not specified, assume end is infinity

=item 4

to specify negative infinity, use "~"

=item 5

alert is raised if metric is outside start and end range (inclusive of endpoints)

=item 6

if range starts with "@", then alert if inside this range (inclusive of endpoints)

=back

=item Note

Not all plugins are coded to expect ranges in this format. It is planned for a future release to provide standard libraries to parse and compare metrics against ranges. There will also be some work in providing multiple metrics.

=back

=item Performance data

Performance data is defined by Nagios as 'everything after the | of the plugin output', please refer to Nagios documentation for information on capturing this data to logfiles. However, it is the responsibility of the plugin writer to ensure the perf...

=over 4

=item This is the expected format

'label'=value[UOM];[warn];[crit];[min];[max]

=item Notes

=over 4

=item 1.

space separated list of label/value pairs

=item 2.

label can contain any characters

=item 3.

the single quotes for the label are optional. Required if spaces, = or ' are in the label

=item 4.

label length is arbitrary, but ideally the first 19 characters are unique (due to a limitation in RRD). Be aware of a limitation in the amount of data that NRPE returns to Nagios

=item 5.

to specify a quote character, use two single quotes

=item 6.

warn, crit, min or max may be null (for example, if the threshold is not defined or min and max do not apply). Trailing unfilled semicolons can be dropped

=item 7.

min and max are not required if UOM=%

=item 8.

value, min and max in class [-0-9.]. Must all be the same UOM

=item 9.

warn and crit are in the range format (see the Section called Threshold range format). Must be the same UOM

=item 10.