view release on metacpan or  search on metacpan

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

Set and/or get the timeout value

=back

=item write_debugfile()

=over 4

=item Arguments

parameter 1: scalar reference, debug
parameter 2: scalar, open debugfile as 'Writes, Appends, and Creates' mode when 1, otherwise open debugfile in 'Creates, Writes, and Truncates' mode.

=item Function

Write debug to file DEBUGFILE, specified with the command line options '-D, --debugfile=DEBUGFILE'

=back

=back

=head2 Class accessor methods

=over 4

=item setEndTime_and_getResponsTime()

=over 4

=item Arguments

time: scalar, hhmmss.mmmnnn

=item Function

Set endTime and get responstime (-1 when argument time fails)

=back

=back

=head2 Utility methods

=over 4

=item call_system()

=over 4

=item Arguments

command, scalar

=item Function

system call for command

=item Return

returns stateValue => $ERRORS{OK..UNKNOWN}, alert => stdout and error => stderr

=back

=item exit()

=over 4

=item Arguments (optional)

=over 4

=item exit

scalar, exit value

=over 4

=item exit value equals

0 = abnormal exit,

1 = abnormal exit with Performance Data for 'Status'

2 = abnormal exit with Performance Data for 'Compilation', 'Duration/Trendline' and 'Execution'

3 = abnormal exit with Performance Data for 'Status', 'Compilation', 'Duration/Trendline' and 'Execution'

4 = normal exit,

5 = normal exit with Performance Data for 'Status'

6 = normal exit with Performance Data for 'Compilation', 'Duration/Trendline' and 'Execution'

7 = normal exit with Performance Data for 'Status', 'Compilation', 'Duration/Trendline' and 'Execution'

=back

'Trendline' used instead of 'Duration' when command line option '--trendline' is specified.

=back

=item Function

exit plugin function

=item Return

exit Plugin Return Code and Performance Data when exit argument exists

=back

=over 4

=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: