From: Greg Sabino Mullane Date: Thu, 25 Sep 2008 22:23:54 +0000 (-0400) Subject: Add two new actions from Robert Treat: fsm_pages and fsm_relations. X-Git-Tag: 2.9.0~256 X-Git-Url: http://git.postgresql.org/gitweb/static/gitweb.js?a=commitdiff_plain;h=1f3a4b45de3f4f1eb80a771686fd3e84ce178ede;p=check_postgres.git Add two new actions from Robert Treat: fsm_pages and fsm_relations. Bump version to 2.2.0 --- diff --git a/.perlcriticrc b/.perlcriticrc index 98f0b8288..8c4275803 100644 --- a/.perlcriticrc +++ b/.perlcriticrc @@ -4,7 +4,7 @@ verbose = 8 severity = 1 [Documentation::PodSpelling] -stop_words = Mullane Nagios Slony nols salesrep psql dbname postgres USERNAME usernames dbuser pgpass nagios stderr showperf symlinked timesync criticals quirm lancre exabytes sami includeuser excludeuser flagg tardis WAL tablespaces tablespace perflimit burrick mallory grimm oskar ExclusiveLock garrett artemus queryname speedtest checksum checksums morpork klatch pluto faceoff slon greg watson franklin wilkins scott Sabino Seklecki dbpass autovacuum Astill refactoring NAGIOS localhost cronjob symlink symlinks backends snazzo logfile syslog parens plugin Cwd Ioannis Tambouras schemas SQL MRTG mrtg uptime datallowconn dbhost dbport ok +stop_words = Mullane Nagios Slony nols salesrep psql dbname postgres USERNAME usernames dbuser pgpass nagios stderr showperf symlinked timesync criticals quirm lancre exabytes sami includeuser excludeuser flagg tardis WAL tablespaces tablespace perflimit burrick mallory grimm oskar ExclusiveLock garrett artemus queryname speedtest checksum checksums morpork klatch pluto faceoff slon greg watson franklin wilkins scott Sabino Seklecki dbpass autovacuum Astill refactoring NAGIOS localhost cronjob symlink symlinks backends snazzo logfile syslog parens plugin Cwd Ioannis Tambouras schemas SQL MRTG mrtg uptime datallowconn dbhost dbport ok contrib pageslots robert dylan emma fsm ## Severity 5: [-Subroutines::ProhibitNestedSubs] diff --git a/check_postgres.pl b/check_postgres.pl index 3e32dcb24..4cc332915 100755 --- a/check_postgres.pl +++ b/check_postgres.pl @@ -28,7 +28,7 @@ $Data::Dumper::Varname = 'POSTGRES'; $Data::Dumper::Indent = 2; $Data::Dumper::Useqq = 1; -our $VERSION = '2.1.5'; +our $VERSION = '2.2.0'; use vars qw/ %opt $PSQL $res $COM $SQL $db /; @@ -123,6 +123,7 @@ die $USAGE unless 'checktype=s', ## used by custom_query only 'reverse', ## used by custom_query only 'repinfo=s', ## used by replicate_row only + 'schema=s', ## used by fsm_* checks only ) and keys %opt and ! @ARGV; @@ -185,6 +186,8 @@ our $action_info = { custom_query => [0, 'Run a custom query.'], database_size => [0, 'Report if a database is too big.'], disk_space => [1, 'Checks space of local disks Postgres is using.'], + fsm_pages => [1, 'Checks percentage of pages used in free space map.'], + fsm_relations => [1, 'Checks percentage of relations used in free space map.'], index_size => [0, 'Checks the size of indexes only.'], table_size => [0, 'Checks the size of tables only.'], relation_size => [0, 'Checks the size of tables and indexes.'], @@ -497,6 +500,8 @@ our %testaction = ( txn_idle => 'ON: stats_command_string(<8.3) VERSION: 8.0', txn_time => 'VERSION: 8.3', wal_files => 'VERSION: 8.1', + fsm_pages => 'VERSION: 8.2', + fsm_relations => 'VERSION: 8.2', ); if ($opt{test}) { print "BEGIN TEST MODE\n"; @@ -679,6 +684,12 @@ check_replicate_row() if $action eq 'replicate_row'; ## See how close we are to autovacuum_freeze_max_age check_autovac_freeze() if $action eq 'autovac_freeze'; +## See how many pages we have used up compared to max_fsm_pages +check_fsm_pages() if $action eq 'fsm_pages'; + +## See how many relations we have used up compared to max_fsm_relations +check_fsm_relations() if $action eq 'fsm_relations'; + finishup(); exit 0; @@ -2032,6 +2043,110 @@ sub check_disk_space { } ## end of check_disk_space +sub check_fsm_pages { + + ## Check on the percentage of free space map pages in use + ## Supports: Nagios + ## Must run as superuser + ## Requires pg_freespacemap contrib module + ## Takes an optional --schema argument, defaults to 'public' + ## Critical and warning are a percentage of max_fsm_pages + ## Example: --critical=95 + + my ($warning, $critical) = validate_range + ({ + type => 'percent', + default_warning => '85%', + default_critical => '95%', + }); + + my $schema = ($opt{schema}) ? $opt{schema} : 'public'; + + (my $w = $warning) =~ s/\D//; + (my $c = $critical) =~ s/\D//; + my $SQL = qq{SELECT pages, maxx, ROUND(100*(pages/maxx)) AS percent\n}. + qq{FROM (SELECT\n}. + qq{ (SUM(GREATEST(interestingpages,storedpages))+COUNT(DISTINCT(relfilenode)))*8 AS pages,\n}. + qq{ (SELECT setting::NUMERIC FROM pg_settings WHERE name = 'max_fsm_pages') AS maxx\n}. + qq{ FROM $schema.pg_freespacemap_relations) x}; + + my $info = run_command($SQL, {regex => qr[\w+] } ); + + for $db (@{$info->{db}}) { + SLURP: while ($db->{slurp} =~ /\s*(\d+) \|\s+(\d+) \|\s+(\d+)$/gsm) { + my ($pages,$max,$percent) = ($1,$2,$3); + + my $msg = "fsm page slots used: $pages of $max ($percent%)"; + if (length $critical and $percent >= $c) { + add_critical $msg; + } + elsif (length $warning and $percent >= $w) { + add_warning $msg; + } + else { + add_ok $msg; + } + } + + } + + return; + +} ## end of check_fsm_pages + + +sub check_fsm_relations { + + ## Check on the % of free space map relations in use + ## Supports: Nagios + ## Must run as superuser + ## Requires pg_freespacemap contrib module + ## Takes an optional --schema argument, defaults to 'public' + ## Critical and warning are a percentage of max_fsm_relations + ## Example: --critical=95 + + my ($warning, $critical) = validate_range + ({ + type => 'percent', + default_warning => '85%', + default_critical => '95%', + }); + + my $schema = ($opt{schema}) ? $opt{schema} : 'public'; + + (my $w = $warning) =~ s/\D//; + (my $c = $critical) =~ s/\D//; + + my $SQL = qq{SELECT maxx, cur, ROUND(100*(cur/maxx))\n}. + qq{FROM (SELECT\n}. + qq{ (SELECT COUNT(*) FROM $schema.pg_freespacemap_relations) AS cur,\n}. + qq{ (SELECT setting::NUMERIC FROM pg_settings WHERE name='max_fsm_relations') AS maxx) x\n}; + + my $info = run_command($SQL, {regex => qr[\w+] } ); + + for $db (@{$info->{db}}) { + SLURP: while ($db->{slurp} =~ /\s*(\d+) \|\s+(\d+) \|\s+(\d+)$/gsm) { + my ($max,$cur,$percent) = ($1,$2,$3); + + my $msg = "fsm relations used: $cur of $max ($percent%)"; + if (length $critical and $percent >= $c) { + add_critical $msg; + } + elsif (length $warning and $percent >= $w) { + add_warning $msg; + } + else { + add_ok $msg; + } + } + + } + + return; + +} ## end of check_fsm_relations + + sub check_wal_files { ## Check on the number of WAL files in use @@ -2723,9 +2838,11 @@ sub check_txn_time { my $found = 0; for $db (@{$info->{db}}) { + if (!exists $db->{ok}) { ndie 'Query failed'; } + if ($db->{slurp} !~ /\w/ and $USERWHERECLAUSE) { add_ok 'T-EXCLUDE-USEROK'; next; @@ -3294,7 +3411,7 @@ sub check_replicate_row { =head1 NAME B - a Postgres monitoring script for Nagios, MRTG, and others -This documents describes check_postgres.pl version 2.1.5 +This documents describes check_postgres.pl version 2.2.0 =head1 SYNOPSIS @@ -3790,6 +3907,41 @@ Example 2: Check that all file systems starting with /dev/sda are smaller than 1 For MRTG output, returns the size in bytes of the file system on the first line, and the name of the file system on the fourth line. +=head2 B + +(C) Checks how close a cluster is to the Postgres B setting. +This action will only work for databases of 8.2 or higher, and it requires the contrib +module B be installed. The I<--warning> and I<--critical> options should be expressed +as percentages. The number of used pages in the free-space-map is determined by looking in the +pg_freespacemap_relations view, and running a formula based on the formula used for +outputting free-space-map pageslots in the vacuum verbose command. The default values are B<85%> for the +warning and B<95%> for the critical. + +Example 1: Give a warning when our cluster has used up 76% of the free-space pageslots, with pg_freespacemap installed in database robert + + check_postgres_autovac_freeze --dbname=robert --warning="76%" + +While you need to pass in the name of the database where pg_freespacemap is installed (and optionally a schema name if you have +installed the module in a non-standard schema), you only need to run this check once per cluster. Also, checking this information +does require obtaining special locks on the free-space-map, so it is recommend you do not run this check with short intervals. + +=head2 B + +(C) Checks how close a cluster is to the Postgres B setting. +This action will only work for databases of 8.2 or higher, and it requires the contrib module B be +installed. The I<--warning> and I<--critical> options should be expressed as percentages. The number of used relations +in the free-space-map is determined by looking in the pg_freespacemap_relations view. The default values are B<85%> for +the warning and B<95%> for the critical. + +Example 1: Give a warning when our cluster has used up 80% of the free-space relations, with pg_freespacemap installed in database dylan, in non-standard schema emma + + check_postgres_autovac_freeze --dbname=dylan --warning="75%" --schema=emma + +While you need to pass in the name of the database where pg_freespacemap is installed (and optionally a schema name +if you have installed the module in a non-standard schema), you only need to run this check once per cluster. Also, +checking this information does require obtaining special locks on the free-space-map, so it is recommend you do not +run this check with short intervals. + =head2 B =head2 B @@ -4366,9 +4518,9 @@ Items not specifically attributed are by Greg Sabino Mullane. =over 4 -=item B (September 23, 2008) +=item B (September 2008) - Don't use STDERR bareword. (Chris Butler) + Add fsm_pages and fsm_relations actions. (Robert Treat) =item B (September 22, 2008) diff --git a/check_postgres.pl.html b/check_postgres.pl.html index 550b668af..f298219a2 100644 --- a/check_postgres.pl.html +++ b/check_postgres.pl.html @@ -42,6 +42,8 @@
  • custom_query
  • database_size
  • disk_space
    • +
  • fsm_pages
    • +
  • fsm_relations
  • index_size
  • table_size
  • relation_size
    • @@ -87,7 +89,7 @@

    NAME

    check_postgres.pl - a Postgres monitoring script for Nagios, MRTG, and others -This documents describes check_postgres.pl version 2.1.4

    +This documents describes check_postgres.pl version 2.2.0

    @@ -395,7 +397,7 @@ is reached. The default values for --warning and --critical ar You can also filter the databases by use of the --include and --exclude options. See the BASIC FILTERING section for more details.

    -

    Example 1: Give a warning when the number of connections on host quirm reaches 120, and a critical if it reaches 140.

    +

    Example 1: Give a warning when the number of connections on host quirm reaches 120, and a critical if it reaches 150.

       check_postgres_backends --host=quirm --warning=120 --critical=150

    Example 2: Give a critical when we reach 75% of our max_connections setting on hosts lancre or lancre2.

    @@ -432,7 +434,7 @@ before they can be considered by this test. If you really want to adjust these values, you can look for the variables $MINPAGES and $MINIPAGES at the top of the check_bloat subroutine.

    The schema named 'information_schema' is excluded from this test, as the only tables -it contains are small ans do not change.

    +it contains are small and do not change.

    Please note that the values computed by this action are not precise, and should be used as a guideline only. Great effort was made to estimate the correct size of a table, but in the end it is only an estimate. The correct @@ -488,7 +490,7 @@ value. However, an option of --reverse will trigger the alert if the re

    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
    -

    Example 2: Give a critical if the "foobar" function returns over 5GB of bytes:

    +

    Example 2: Give a critical if the "foobar" function returns a number over 5MB:

       check_postgres_custom_query --port=5432 --critical='5MB'--checktype=size --query="SELECT foobar()"

    Example 2: Warn if the function "snazzo" returns less than 42:

    @@ -556,6 +558,37 @@ maps to a file system: these can be included or excluded. See the and the name of the file system on the fourth line.

    +

    fsm_pages

    +

    (symlink: check_postgres_fsm_pages) Checks how close a cluster is to the Postgres max_fsm_pages setting. +This action will only work for databases of 8.2 or higher, and it requires the contrib +module pg_freespacemap be installed. The --warning and --critical options should be expressed +as percentages. The number of used pages in the free-space-map is determined by looking in the +pg_freespacemap_relations view, and running a formula based on the formula used for +outputting free-space-map pageslots in the vacuum verbose command. The default values are 85% for the +warning and 95% for the critical.

    +

    Example 1: Give a warning when our cluster has used up 76% of the free-space pageslots, with pg_freespacemap installed in database robert

    +
    +  check_postgres_autovac_freeze --dbname=robert --warning="76%"
    +

    While you need to pass in the name of the database where pg_freespacemap is installed (and optionally a schema name if you have +installed the module in a non-standard schema), you only need to run this check once per cluster. Also, checking this information +does require obtaining special locks on the free-space-map, so it is recommend you do not run this check with short intervals.

    +

    +

    +

    fsm_relations

    +

    (symlink: check_postgres_fsm_relations) Checks how close a cluster is to the Postgres max_fsm_relations setting. +This action will only work for databases of 8.2 or higher, and it requires the contrib module pg_freespacemap be +installed. The --warning and --critical options should be expressed as percentages. The number of used relations +in the free-space-map is determined by looking in the pg_freespacemap_relations view. The default values are 85% for +the warning and 95% for the critical.

    +

    Example 1: Give a warning when our cluster has used up 80% of the free-space relations, with pg_freespacemap installed in database dylan, in non-standard schema emma

    +
    +  check_postgres_autovac_freeze --dbname=dylan --warning="75%" --schema=emma
    +

    While you need to pass in the name of the database where pg_freespacemap is installed (and optionally a schema name +if you have installed the module in a non-standard schema), you only need to run this check once per cluster. Also, +checking this information does require obtaining special locks on the free-space-map, so it is recommend you do not +run this check with short intervals.

    +

    +

    index_size

    @@ -1058,6 +1091,12 @@ feature requests, and commit notices, send email to HISTORY

    Items not specifically attributed are by Greg Sabino Mullane.

    +
    Version 2.2.0 (September 2008)
    + +
    +
    + Add fsm_pages and fsm_relations actions. (Robert Treat)
    +
    Version 2.1.4 (September 22, 2008)
    @@ -1085,7 +1124,7 @@ feature requests, and commit notices, send email to Version 2.1.0 (July 18, 2008) +
    Version 2.1.0 (July 18, 2008)
    diff --git a/index.html b/index.html
index 98c41becb..0f16157d7 100644
--- a/index.html
+++ b/index.html
@@ -21,13 +21,13 @@ h1 {
 
 
    check_postgres.pl
    
 
-
    check_postgres.pl is a script for checking the state of one or more Postgres databases and reporting back in a Nagios-friendly manner. It was developed by Greg Sabino Mullane of End Point Corporation and is BSD-licensed. The latest version is 2.1.4, and was released on September 22, 2008.
    
+
    check_postgres.pl is a script for checking the state of one or more Postgres databases and reporting back in a Nagios-friendly manner. It was developed by Greg Sabino Mullane of End Point Corporation and is BSD-licensed. The latest version is 2.2.0, and was released on September 25, 2008.
    
 
 
 
 
diff --git a/t/99_spellcheck.t b/t/99_spellcheck.t
index d9f44cd03..74cfb5c3d 100644
--- a/t/99_spellcheck.t
+++ b/t/99_spellcheck.t
@@ -184,6 +184,7 @@ backends
 burrick
 checksum
 checksums
+contrib
 cperl
 criticals
 cronjob
@@ -193,6 +194,8 @@ dbname
 dbpass
 dbport
 dbuser
+dylan
+emma
 exabytes
 excludeuser
 ExclusiveLock
@@ -200,6 +203,7 @@ faceoff
 finishup
 flagg
 franklin
+fsm
 garrett
 greg
 grimm
@@ -221,6 +225,7 @@ NAGIOS
 nols
 ok
 oskar
+pageslots
 perflimit
 pgpass
 pluto
@@ -230,6 +235,7 @@ PSQL
 queryname
 quirm
 refactoring
+robert
 runtime
 salesrep
 sami