search

monitoring-plugins / monitoring-plugin-perl

Perl module Monitoring::Plugin - Nagios::Plugin
http://search.cpan.org/dist/Monitoring-Plugin/
42 stars 20 forks source link

[doc] missing documentation #8

Open glensc opened 8 years ago

glensc commented 8 years ago

http://search.cpan.org/~nierlein/Monitoring-Plugin-0.39/lib/Monitoring/Plugin.pm#CONSTRUCTOR

there's no documentation for version, blurb, license, extra, plugin, timeout parameters

as for example i was looking where to put information about homepage and where to report bugs and copyright years and author.

for homepage and bugs url, i just appended to blurb: https://github.com/glensc/nagios-plugin-check_raid/commit/cd178206287fc2e75d463823618d8e8402215a7b

for license and copyright did not find good solution: i do not want to replace license key, i like that default GPLv2 is printed.

here's example how my plugin worked before starting to use perl-Monitoring-Plugin, and after

➔ ./check_raid-3.2.5.pl --help | head -n10
check_raid, v3.2.5
Copyright (c) 2004-2006 Steve Shipway,
Copyright (c) 2009-2015, Elan Ruusamäe <glen@pld-linux.org>

This plugin reports the current server's RAID status
https://github.com/glensc/nagios-plugin-check_raid

Usage: check_raid [-h] [-V] [-S] [list of devices to ignore]
➔ ./check_raid-4.0.1.pl --help | head -n10
check_raid 4.0.1

This nagios plugin is free software, and comes with ABSOLUTELY NO WARRANTY.
It may be used, redistributed and/or modified under the terms of the GNU
General Public Licence (see http://www.fsf.org/licensing/licenses/gpl.txt).

This plugin checks all RAID volumes (hardware and software) that can be identified.

Usage: check_raid [-h] [-V] [-S] [list of devices to ignore]