Clean up the docs a bit.
$Data::Dumper::Indent = 2;
$Data::Dumper::Useqq = 1;
-our $VERSION = '1.7.1';
+our $VERSION = '1.8.0';
use vars qw/ %opt $PSQL $res $COM $SQL $db /;
'queryname=s', ## used by query_runtime only
'query=s', ## used by custom_query only
'checktype=s', ## used by custom_query only
+ 'reverse', ## used by custom_query only
'repinfo=s', ## used by replicate_row only
)
and keys %opt
my $query = $opt{query} or ndie q{Must provide a query string};
+ my $reverse = $opt{reverse} || 0;
+
my $info = run_command($query);
for $db (@{$info->{db}}) {
if (length $critical) {
if (($valtype eq 'string' and $data eq $critical)
or
- ($data >= $critical)) { ## covers integer, time, size
+ ($reverse ? $data <= $critical : $data >= $critical)) { ## covers integer, time, size
add_critical "$data";
$gotmatch = 1;
}
if (length $warning and ! $gotmatch) {
if (($valtype eq 'string' and $data eq $warning)
or
- ($data >= $warning)) {
+ ($reverse ? $data <= $warning : $data >= $warning)) {
add_warning "$data";
$gotmatch = 1;
}
=head1 VERSION
-This documents describes B<check_postgres.pl> version 1.7.1
+This documents describes B<check_postgres.pl> version 1.8.0
=head1 SYNOPSIS
=head1 DATABASE CONNECTION OPTIONS
-Almost all actions accept a common set of options, most dealing with connecting to the databases.
+All actions accept a common set of database options. At least one is required.
=over 4
=item B<-p PORT> or B<--port=PORT>
Connects using the specified PORT number. Can be a comma-separated list of port numbers, and multiple
-port arguments are allowed. If no port number is given, we default to port 5432.
+port arguments are allowed. If no port number is given, the default is 5432.
=item B<-db NAME> or B<--dbname=NAME>
Specifies which database to connect to. Can be a comma-separated list of names, and multiple dbname
-arguments are allowed. If no dbname option is provided, defaults to 'postgres' if the psql
-version is version 8 or greater, and 'template1' otherwise.
+arguments are allowed. If no dbname option is provided, defaults to 'postgres' if psql
+is version 8 or greater, and 'template1' otherwise.
=item B<-u USERNAME> or B<--dbuser=USERNAME>
The name of the database user to connect as. Can be a comma-separated list of usernames, and multiple
-dbuser arguments are allowed. If this is not provided, defaults to 'postgres'.
+dbuser arguments are allowed. If this is not provided, the default is 'postgres'.
=item B<--dbpass=PASSWORD>
=back
-Connection options can be grouped: --host=a,b --host=c --port=1234 --port=3344
+The database connection options can be grouped: --host=a,b --host=c --port=1234 --port=3344
would connect to a-1234, b-1234, and c-3344. Note that once set, an option
carries over until it is changed again.
Examples:
--host=a,b --port=5433 --db=c
- Connects twice to port 5433, using database c, to hosts a and b
- a-5433-c b-5433-c
+ Connects twice to port 5433, using database c, to hosts a and b: a-5433-c b-5433-c
--host=a,b --port=5433 --db=c,d
Connects four times: a-5433-c a-5433-d b-5433-c b-5433-d
=head1 OTHER OPTIONS
-Other common options include:
+Other options include:
=over 4
-=item B<--output=VAL>
+=item B<--action=NAME>
-Determines the format of the output, for use in various programs. The default is 'nagios'. No
-other systems are supported yet.
+States what action we are running. Required unless using a symlinked file,
+in which case the name of the file is used to figure out the action.
-=item B<PSQL=PATH>
+=item B<--warning=VAL or -w VAL>
-Tells the script where to find the psql program. Useful if you have more than
-one version of the psql executable on your system, or if there is no psql program
-in your path. Note that this option is in all uppercase. By default, this option
-is I<not allowed>. To enable it, you must change the C<$NO_PSQL_OPTION> near the
-top of the script to 0. Avoid using this option if you can, and instead hard-code
-your psql location into the C<$PSQL> variable, also near the top of the script.
+Sets the threshold at which a warning alert is fired. The valid options for this
+option depends on the action used.
+
+=item B<--critical=VAL or -c VAL>
+
+Sets the threshold at which a critical alert is fired. The valid options for this
+option depends on the action used.
=item B<-t VAL> or B<--timeout=VAL>
or higher (in other words, issuing C<-v -v -v>) turns on debugging information for this
program which is sent to stderr.
-=item B<--test>
-
-Enables test mode. See the L</"TEST MODE"> section below.
-
=item B<--showperf=VAL>
-Determines if we output performance data in standard Nagios format
+Determines if we output additional performance data in standard Nagios format
(at end of string, after a pipe symbol, using name=value).
VAL should be 0 or 1. The default is 1.
=item B<--perflimit=i>
-Sets a limit s to how many items of interest are reported back when using the
+Sets a limit as to how many items of interest are reported back when using the
B<showperf> option. This only has an effect for actions that return a large
number of items, such as B<table_size>. The default is 0, or no limit. Be
careful when using this with the B<--include> or B<--exclude> options, as
Determines if the time taken to run each query is shown in the output. VAL
should be 0 or 1. The default is 1. No effect unless B<showperf> is on.
-=item B<--action=NAME>
+=item B<--test>
-States what action we are running. Required unless using a symlinked file,
-in which case the name of the file is used to figure out the action.
+Enables test mode. See the L</"TEST MODE"> section below.
+
+=item B<--PSQL=PATH>
+
+Tells the script where to find the psql program. Useful if you have more than
+one version of the psql executable on your system, or if there is no psql program
+in your path. Note that this option is in all uppercase. By default, this option
+is I<not allowed>. To enable it, you must change the C<$NO_PSQL_OPTION> near the
+top of the script to 0. Avoid using this option if you can, and instead hard-code
+your psql location into the C<$PSQL> variable, also near the top of the script.
+
+=item B<--symlinks>
+
+Creates symlinks to the main program for each action.
+
+=item B<--output=VAL>
+
+Determines the format of the output, for use in various programs. The default is 'nagios'. No
+other systems are supported yet.
=back
terabytes, or exabytes. Each may be abbreviated to the first letter. If no units are given,
bytes are assumed. The first column should be an integer representing the number of bytes to check.
+Normally, an alert is triggered if the values returned are B<greater than> or equal to the critical or warning
+value. However, an option of B<--reverse> will trigger the alert if the returned value is
+B<lower than> or equal to the critical or warning value.
+
Example 1: Warn if any relation over 100 pages is named "rad":
check_postgres_custom_query --checktype=string -w "rad" --query="SELECT relname FROM pg_class WHERE relpages > 100" --port=5432
check_postgres_custom_query --port=5432 --critical='5MB'--checktype=size --query="SELECT foobar()"
+Example 2: Warn if the function "snazzo" returns less than 42:
+
+ check_postgres_custom_query --port=5432 --critical=42 --query="SELECT snazzo()" --reverse
+
If you come up with a useful custom_query, consider sending in a patch to this program
to make it into a standard action that other people can use.
This action requires no other arguments, and does not connect to any databases,
but simply creates symlinks in the current directory for each action, in the form
B<check_postgres_E<lt>action_nameE<gt>>.
- If the file already exists, it will not be overwritten. If the action is rebuild_symlinks_force,
+If the file already exists, it will not be overwritten. If the action is rebuild_symlinks_force,
then symlinks will be overwritten. The option --symlinks is a shorter way of saying
--action=rebuild_symlinks
To help in setting things up, this program can be run in a "test mode" by
specifying the B<--test> option. This will perform some basic tests to
make sure that the databases can be contacted, and that certain per-action
-prerequisites are met. Currently, we check that the user is a superuser
-if required by that action, and that the version of Postgres is new enough
-for those actions that depend on a specific version.
+prerequisites are met, such as whether the user is a superuser, if the version
+of Postgres is new enough, and if stats_row_level is on.
=head1 DEPENDENCIES
=over 4
+=item B<Version 1.8.0> (June 3, 2008)
+
+Add the --reverse option to the custom_query action.
+
=item B<Version 1.7.1> (June 2, 2008)
Fix query_time action: account for race condition in which zero rows appear in pg_stat_activity.
-----BEGIN PGP SIGNATURE-----
-iEYEABEDAAYFAkhEILoACgkQvJuQZxSWSsgewACfbEZ4sL+RqC10h4PNWfS7Ozjv
-XgMAn0pSqw1kO/CkIxouURof3Kbfqker
-=5aGH
+iEYEABEDAAYFAkhF2lMACgkQvJuQZxSWSsg3agCdEGFl7OfdMJ5Dpx7bIQ4fpbcM
+amkAnRT4rvQ3bqMsc5zozEG/CE8rMGQ6
+=3jdI
-----END PGP SIGNATURE-----
</p>
<hr />
<h1><a name="version">VERSION</a></h1>
-<p>This documents describes <strong>check_postgres.pl</strong> version 1.7.1</p>
+<p>This documents describes <strong>check_postgres.pl</strong> version 1.8.0</p>
<p>
</p>
<hr />
</p>
<hr />
<h1><a name="database_connection_options">DATABASE CONNECTION OPTIONS</a></h1>
-<p>Almost all actions accept a common set of options, most dealing with connecting to the databases.</p>
+<p>All actions accept a common set of database options. At least one is required.</p>
<dl>
<dt><strong><a name="h_name_or_host_name" class="item"><strong>-H NAME</strong> or <strong>--host=NAME</strong></a></strong>
<dd>
<p>Connects using the specified PORT number. Can be a comma-separated list of port numbers, and multiple
-port arguments are allowed. If no port number is given, we default to port 5432.</p>
+port arguments are allowed. If no port number is given, the default is 5432.</p>
</dd>
</li>
<dt><strong><a name="db_name_or_dbname_name" class="item"><strong>-db NAME</strong> or <strong>--dbname=NAME</strong></a></strong>
<dd>
<p>Specifies which database to connect to. Can be a comma-separated list of names, and multiple dbname
-arguments are allowed. If no dbname option is provided, defaults to 'postgres' if the psql
-version is version 8 or greater, and 'template1' otherwise.</p>
+arguments are allowed. If no dbname option is provided, defaults to 'postgres' if psql
+is version 8 or greater, and 'template1' otherwise.</p>
</dd>
</li>
<dt><strong><a name="u_username_or_dbuser_username" class="item"><strong>-u USERNAME</strong> or <strong>--dbuser=USERNAME</strong></a></strong>
<dd>
<p>The name of the database user to connect as. Can be a comma-separated list of usernames, and multiple
-dbuser arguments are allowed. If this is not provided, defaults to 'postgres'.</p>
+dbuser arguments are allowed. If this is not provided, the default is 'postgres'.</p>
</dd>
</li>
<dt><strong><a name="dbpass_password" class="item"><strong>--dbpass=PASSWORD</strong></a></strong>
</dd>
</li>
</dl>
-<p>Connection options can be grouped: --host=a,b --host=c --port=1234 --port=3344
+<p>The database connection options can be grouped: --host=a,b --host=c --port=1234 --port=3344
would connect to a-1234, b-1234, and c-3344. Note that once set, an option
carries over until it is changed again.</p>
<p>Examples:</p>
<pre>
--host=a,b --port=5433 --db=c
- Connects twice to port 5433, using database c, to hosts a and b
- a-5433-c b-5433-c</pre>
+ Connects twice to port 5433, using database c, to hosts a and b: a-5433-c b-5433-c</pre>
<pre>
--host=a,b --port=5433 --db=c,d
Connects four times: a-5433-c a-5433-d b-5433-c b-5433-d</pre>
</p>
<hr />
<h1><a name="other_options">OTHER OPTIONS</a></h1>
-<p>Other common options include:</p>
+<p>Other options include:</p>
<dl>
-<dt><strong><a name="output_val" class="item"><strong>--output=VAL</strong></a></strong>
+<dt><strong><a name="action_name" class="item"><strong>--action=NAME</strong></a></strong>
<dd>
-<p>Determines the format of the output, for use in various programs. The default is 'nagios'. No
-other systems are supported yet.</p>
+<p>States what action we are running. Required unless using a symlinked file,
+in which case the name of the file is used to figure out the action.</p>
</dd>
</li>
-<dt><strong><a name="psql_path" class="item"><strong>PSQL=PATH</strong></a></strong>
+<dt><strong><a name="warning_val_or_w_val" class="item"><strong>--warning=VAL or -w VAL</strong></a></strong>
<dd>
-<p>Tells the script where to find the psql program. Useful if you have more than
-one version of the psql executable on your system, or if there is no psql program
-in your path. Note that this option is in all uppercase. By default, this option
-is <em>not allowed</em>. To enable it, you must change the <code>$NO_PSQL_OPTION</code> near the
-top of the script to 0. Avoid using this option if you can, and instead hard-code
-your psql location into the <code>$PSQL</code> variable, also near the top of the script.</p>
+<p>Sets the threshold at which a warning alert is fired. The valid options for this
+option depends on the action used.</p>
+</dd>
+</li>
+<dt><strong><a name="critical_val_or_c_val" class="item"><strong>--critical=VAL or -c VAL</strong></a></strong>
+
+<dd>
+<p>Sets the threshold at which a critical alert is fired. The valid options for this
+option depends on the action used.</p>
</dd>
</li>
<dt><strong><a name="t_val_or_timeout_val" class="item"><strong>-t VAL</strong> or <strong>--timeout=VAL</strong></a></strong>
program which is sent to stderr.</p>
</dd>
</li>
-<dt><strong><a name="test" class="item"><strong>--test</strong></a></strong>
-
-<dd>
-<p>Enables test mode. See the <a href="#test_mode">TEST MODE</a> section below.</p>
-</dd>
-</li>
<dt><strong><a name="showperf_val" class="item"><strong>--showperf=VAL</strong></a></strong>
<dd>
-<p>Determines if we output performance data in standard Nagios format
+<p>Determines if we output additional performance data in standard Nagios format
(at end of string, after a pipe symbol, using name=value).
VAL should be 0 or 1. The default is 1.</p>
</dd>
<dt><strong><a name="perflimit_i" class="item"><strong>--perflimit=i</strong></a></strong>
<dd>
-<p>Sets a limit s to how many items of interest are reported back when using the
+<p>Sets a limit as to how many items of interest are reported back when using the
<strong>showperf</strong> option. This only has an effect for actions that return a large
number of items, such as <strong>table_size</strong>. The default is 0, or no limit. Be
careful when using this with the <strong>--include</strong> or <strong>--exclude</strong> options, as
should be 0 or 1. The default is 1. No effect unless <strong>showperf</strong> is on.</p>
</dd>
</li>
-<dt><strong><a name="action_name" class="item"><strong>--action=NAME</strong></a></strong>
+<dt><strong><a name="test" class="item"><strong>--test</strong></a></strong>
<dd>
-<p>States what action we are running. Required unless using a symlinked file,
-in which case the name of the file is used to figure out the action.</p>
+<p>Enables test mode. See the <a href="#test_mode">TEST MODE</a> section below.</p>
+</dd>
+</li>
+<dt><strong><a name="psql_path" class="item"><strong>--PSQL=PATH</strong></a></strong>
+
+<dd>
+<p>Tells the script where to find the psql program. Useful if you have more than
+one version of the psql executable on your system, or if there is no psql program
+in your path. Note that this option is in all uppercase. By default, this option
+is <em>not allowed</em>. To enable it, you must change the <code>$NO_PSQL_OPTION</code> near the
+top of the script to 0. Avoid using this option if you can, and instead hard-code
+your psql location into the <code>$PSQL</code> variable, also near the top of the script.</p>
+</dd>
+</li>
+<dt><strong><a name="symlinks" class="item"><strong>--symlinks</strong></a></strong>
+
+<dd>
+<p>Creates symlinks to the main program for each action.</p>
+</dd>
+</li>
+<dt><strong><a name="output_val" class="item"><strong>--output=VAL</strong></a></strong>
+
+<dd>
+<p>Determines the format of the output, for use in various programs. The default is 'nagios'. No
+other systems are supported yet.</p>
</dd>
</li>
</dl>
bytes are assumed. The first column should be an integer representing the number of bytes to check.</p>
</dd>
<dd>
+<p>Normally, an alert is triggered if the values returned are <strong>greater than</strong> or equal to the critical or warning
+value. However, an option of <strong>--reverse</strong> will trigger the alert if the returned value is
+<strong>lower than</strong> or equal to the critical or warning value.</p>
+</dd>
+<dd>
<p>Example 1: Warn if any relation over 100 pages is named "rad":</p>
</dd>
<dd>
check_postgres_custom_query --port=5432 --critical='5MB'--checktype=size --query="SELECT foobar()"</pre>
</dd>
<dd>
+<p>Example 2: Warn if the function "snazzo" returns less than 42:</p>
+</dd>
+<dd>
+<pre>
+ check_postgres_custom_query --port=5432 --critical=42 --query="SELECT snazzo()" --reverse</pre>
+</dd>
+<dd>
<p>If you come up with a useful custom_query, consider sending in a patch to this program
to make it into a standard action that other people can use.</p>
</dd>
<p>This action requires no other arguments, and does not connect to any databases,
but simply creates symlinks in the current directory for each action, in the form
<strong>check_postgres_<action_name></strong>.
- If the file already exists, it will not be overwritten. If the action is rebuild_symlinks_force,
+If the file already exists, it will not be overwritten. If the action is rebuild_symlinks_force,
then symlinks will be overwritten. The option --symlinks is a shorter way of saying
--action=rebuild_symlinks</p>
</dd>
<p>To help in setting things up, this program can be run in a "test mode" by
specifying the <strong>--test</strong> option. This will perform some basic tests to
make sure that the databases can be contacted, and that certain per-action
-prerequisites are met. Currently, we check that the user is a superuser
-if required by that action, and that the version of Postgres is new enough
-for those actions that depend on a specific version.</p>
+prerequisites are met, such as whether the user is a superuser, if the version
+of Postgres is new enough, and if stats_row_level is on.</p>
<p>
</p>
<hr />
<h1><a name="history">HISTORY</a></h1>
<p>Items not specifically attributed are by Greg Sabino Mullane.</p>
<dl>
+<dt><strong><a name="0" class="item"><strong>Version 1.8.0</strong> (June 3, 2008)</a></strong>
+
+<dd>
+<p>Add the --reverse option to the custom_query action.</p>
+</dd>
+</li>
<dt><strong><a name="1" class="item"><strong>Version 1.7.1</strong> (June 2, 2008)</a></strong>
<dd>
Thanks to Dustin Black for the bug report.</p>
</dd>
</li>
-<dt><strong><a name="0" class="item"><strong>Version 1.7.0</strong> (May 11, 2008)</a></strong>
+<dt><strong><strong>Version 1.7.0</strong> (May 11, 2008)</strong>
<dd>
<p>Add --replicate_row action</p>
projects / check_postgres.git / commitdiff