Changeset eb4ac990d1c5ec58d6843a8b629dd7637295c789

Timestamp:

03/24/10 18:46:44 (3 years ago)

Author:

Mark Harrison <mark@omniti.com>

git-committer:

Mark Harrison <mark@omniti.com> 1269456404 +0000

git-parent:

[d5d274d63e8181bd8caa0ead9af08222e01edd87]

git-author:

Mark Harrison <mark@omniti.com> 1269456404 +0000

Message:

Documentation for check_resmon_metric

git-svn-id: https://labs.omniti.com/resmon/branches/resmon2@285 8c0face9-b7db-6ec6-c4b3-d5f7145c7d55

Files:

• resources/check_resmon_metric (modified) (1 diff)

resources/check_resmon_metric

@@ -1 +1 @@
-#!/usr/bin/perl -w
-# Nagios script to check a resmon monitor's metrics and trigger alerts based
-# on various rules
-
-# Remove the following line to disable embedded perl
-# nagios: +epn
+
+=pod
+
+=head1 NAME
+
+check_resmon_metric - Nagios check to monitor a resmon metric
+
+=head1 SYNOPSIS
+
+check_resmon_metric -H hostname [-P port] -M module_name -C check_name
+                    -m metric_name [ -r regex | [-w warning_threshold]
+                    [-c critical_threshold] ]
+
+=head1 DESCRIPTION
+
+This is a nagios check script that will connect to a running resmon instance,
+fetch information for a single check, and compare a metric against rules
+provided on the command line, returning the status to nagios based on the
+result.
+
+For numeric metrics, there are options for warning/critical thresholds, and
+for string metrics, there is an option to match against a regular expression.
+
+=head1 OPTIONS
+
+=over
+
+=item -H hostname
+
+The hostname of the resmon instance to connect to. Required.
+
+=item -P port
+
+The port that resmon is listening on. Defaults to 81.
+
+=item -M module_name
+
+The module name of the check you wish to fetch. Required.
+
+=item -C check_name
+
+The check name you wish to fetch. Required.
+
+=item -m metric_name
+
+The name of the metric you wish to evaluate rules against. Required.
+
+=item -w warning_threshold
+
+A numeric threshold (see below) to test the metric against. Will return a
+warning status if the threshold matches. This is only applicable for numeric
+metrics. An error will be returned for string metrics. Optional.
+
+=item -c critical_threshold
+
+A numeric threshold (see below) to test the metric against. Will return a
+critical status if the threshold matches. This is only applicable for numeric
+metrics. An error will be returned for string metrics. If both the critical
+and warning thresholds match a given metric, then the status returned is
+critical.  Optional.
+
+=item -r regex
+
+A regular expression to match the metric against. This is most useful for
+string based metrics. If the regular expression matches, then an ok status
+will be returned, otherwise the status will be critical. This cannot be used
+in conjunction with the warning/critical thresholds. Optional.
+
+=item -A age
+
+This option will cause a check to be critical if it was updated more than age
+seconds ago.
+
+=back
+
+=head1 THRESHOLDS
+
+The warning and critical thresholds are specified in the same way as for other
+nagios plugins, as desribed at
+http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT
+
+Most of the time, you just want to put a number for the threshold. For
+example, '-w 10 -c 20' would go warning if the value is over 10, and critical
+if it is over 20.
+
+For more complex ranges, use the more generalized format of: [@]start:end
+
+=over
+
+=item *
+
+Start and end are both numbers, and either can be negative
+
+=item *
+
+If start is missing, then the colon isn't required, and the range is from 0 to
+end. In other words, if you specify a single number, the range is from 0 to
+the number you specified.
+
+=item *
+
+If end is missing (E.g. 10:), then the range is from start to infinity.
+
+=item *
+
+If start is '~', then the range is from minus infinity to end (as opposed to
+0-end if start is omitted)
+
+=item *
+
+An alert is generated if the test value lies outside the specified range.
+
+=item *
+
+If @ is specified at the beginning, the alerting behavior is flipped. In other
+words, an alert is generated if the value lies within the range.
+
+=back
+
+=head2 EXAMPLES
+
+The following lists example thresholds, and the conditions under which an
+alert is generated.
+
+=over
+
+=item '10'
+
+Ok if: 0 <= X <= 10, Alert if: X < 0 or X > 10
+
+=item '10:'
+
+Ok if: X >= 10, Alert if: X < 10
+
+=item '~:10'
+
+Ok if: X <= 10, Alert if: X > 10
+
+=item '10:20'
+
+Ok if: 10 <= X <= 20, Alert if: X < 10 or X > 20
+
+=item '@10:20'
+
+Ok if: X < 10 or X > 20, Alert if: 10 <= X <= 20
+
+=back
+
+=cut
-
-use vars qw($PROGNAME);