-
Notifications
You must be signed in to change notification settings - Fork 173
/
check_postgres.pl.html
2718 lines (1717 loc) · 145 KB
/
check_postgres.pl.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>check_postgres.pl</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
</head>
<body>
<ul id="index">
<li><a href="#NAME">NAME</a></li>
<li><a href="#SYNOPSIS">SYNOPSIS</a></li>
<li><a href="#DESCRIPTION">DESCRIPTION</a>
<ul>
<li><a href="#Output-Modes">Output Modes</a>
<ul>
<li><a href="#Nagios-output">Nagios output</a></li>
<li><a href="#MRTG-output">MRTG output</a></li>
<li><a href="#Simple-output">Simple output</a></li>
<li><a href="#Cacti-output">Cacti output</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#DATABASE-CONNECTION-OPTIONS">DATABASE CONNECTION OPTIONS</a></li>
<li><a href="#OTHER-OPTIONS">OTHER OPTIONS</a></li>
<li><a href="#ACTIONS">ACTIONS</a>
<ul>
<li><a href="#archive_ready">archive_ready</a></li>
<li><a href="#autovac_freeze">autovac_freeze</a></li>
<li><a href="#backends">backends</a></li>
<li><a href="#bloat">bloat</a></li>
<li><a href="#checkpoint">checkpoint</a></li>
<li><a href="#cluster_id">cluster_id</a></li>
<li><a href="#commitratio">commitratio</a></li>
<li><a href="#connection">connection</a></li>
<li><a href="#custom_query">custom_query</a></li>
<li><a href="#database_size">database_size</a></li>
<li><a href="#dbstats">dbstats</a></li>
<li><a href="#disabled_triggers">disabled_triggers</a></li>
<li><a href="#disk_space">disk_space</a></li>
<li><a href="#fsm_pages">fsm_pages</a></li>
<li><a href="#fsm_relations">fsm_relations</a></li>
<li><a href="#hitratio">hitratio</a></li>
<li><a href="#hot_standby_delay">hot_standby_delay</a></li>
<li><a href="#relation_size">relation_size</a></li>
<li><a href="#index_size">index_size</a></li>
<li><a href="#table_size">table_size</a></li>
<li><a href="#indexes_size">indexes_size</a></li>
<li><a href="#total_relation_size">total_relation_size</a></li>
<li><a href="#last_analyze">last_analyze</a></li>
<li><a href="#last_vacuum">last_vacuum</a></li>
<li><a href="#last_autoanalyze">last_autoanalyze</a></li>
<li><a href="#last_autovacuum">last_autovacuum</a></li>
<li><a href="#listener">listener</a></li>
<li><a href="#locks">locks</a></li>
<li><a href="#lockwait">lockwait</a></li>
<li><a href="#logfile">logfile</a></li>
<li><a href="#new_version_bc">new_version_bc</a></li>
<li><a href="#new_version_box">new_version_box</a></li>
<li><a href="#new_version_cp">new_version_cp</a></li>
<li><a href="#new_version_pg">new_version_pg</a></li>
<li><a href="#new_version_tnm">new_version_tnm</a></li>
<li><a href="#partman_premake">partman_premake</a></li>
<li><a href="#pgb_pool_cl_active">pgb_pool_cl_active</a></li>
<li><a href="#pgb_pool_cl_waiting">pgb_pool_cl_waiting</a></li>
<li><a href="#pgb_pool_sv_active">pgb_pool_sv_active</a></li>
<li><a href="#pgb_pool_sv_idle">pgb_pool_sv_idle</a></li>
<li><a href="#pgb_pool_sv_used">pgb_pool_sv_used</a></li>
<li><a href="#pgb_pool_sv_tested">pgb_pool_sv_tested</a></li>
<li><a href="#pgb_pool_sv_login">pgb_pool_sv_login</a></li>
<li><a href="#pgb_pool_maxwait">pgb_pool_maxwait</a></li>
<li><a href="#pgbouncer_backends">pgbouncer_backends</a></li>
<li><a href="#pgbouncer_checksum">pgbouncer_checksum</a></li>
<li><a href="#pgbouncer_maxwait">pgbouncer_maxwait</a></li>
<li><a href="#pgagent_jobs">pgagent_jobs</a></li>
<li><a href="#prepared_txns">prepared_txns</a></li>
<li><a href="#query_runtime">query_runtime</a></li>
<li><a href="#query_time">query_time</a></li>
<li><a href="#replicate_row">replicate_row</a></li>
<li><a href="#replication_slots">replication_slots</a></li>
<li><a href="#same_schema">same_schema</a></li>
<li><a href="#sequence1">sequence</a></li>
<li><a href="#settings_checksum">settings_checksum</a></li>
<li><a href="#slony_status">slony_status</a></li>
<li><a href="#timesync">timesync</a></li>
<li><a href="#txn_idle">txn_idle</a></li>
<li><a href="#txn_time">txn_time</a></li>
<li><a href="#txn_wraparound">txn_wraparound</a></li>
<li><a href="#version">version</a></li>
<li><a href="#wal_files">wal_files</a></li>
<li><a href="#rebuild_symlinks">rebuild_symlinks</a></li>
<li><a href="#rebuild_symlinks_force">rebuild_symlinks_force</a></li>
</ul>
</li>
<li><a href="#BASIC-FILTERING">BASIC FILTERING</a></li>
<li><a href="#USER-NAME-FILTERING">USER NAME FILTERING</a></li>
<li><a href="#TEST-MODE">TEST MODE</a></li>
<li><a href="#FILES">FILES</a></li>
<li><a href="#ENVIRONMENT-VARIABLES">ENVIRONMENT VARIABLES</a></li>
<li><a href="#TIPS-AND-TRICKS">TIPS AND TRICKS</a></li>
<li><a href="#DEPENDENCIES">DEPENDENCIES</a></li>
<li><a href="#DEVELOPMENT">DEVELOPMENT</a></li>
<li><a href="#MAILING-LIST">MAILING LIST</a></li>
<li><a href="#HISTORY">HISTORY</a></li>
<li><a href="#BUGS-AND-LIMITATIONS">BUGS AND LIMITATIONS</a></li>
<li><a href="#AUTHOR">AUTHOR</a></li>
<li><a href="#NAGIOS-EXAMPLES">NAGIOS EXAMPLES</a></li>
<li><a href="#LICENSE-AND-COPYRIGHT">LICENSE AND COPYRIGHT</a></li>
</ul>
<h1 id="NAME">NAME</h1>
<p><b>check_postgres.pl</b> - a Postgres monitoring script for Nagios, MRTG, Cacti, and others</p>
<p>This documents describes check_postgres.pl version 2.26.0</p>
<h1 id="SYNOPSIS">SYNOPSIS</h1>
<pre><code>## Create all symlinks
check_postgres.pl --symlinks
## Check connection to Postgres database 'pluto':
check_postgres.pl --action=connection --db=pluto
## Same things, but using the symlink
check_postgres_connection --db=pluto
## Warn if > 100 locks, critical if > 200, or > 20 exclusive
check_postgres_locks --warning=100 --critical="total=200:exclusive=20"
## Show the current number of idle connections on port 6543:
check_postgres_txn_idle --port=6543 --output=simple
## There are many other actions and options, please keep reading.
The latest news and documentation can always be found at:
https://bucardo.org/check_postgres/</code></pre>
<h1 id="DESCRIPTION">DESCRIPTION</h1>
<p>check_postgres.pl is a Perl script that runs many different tests against one or more Postgres databases. It uses the psql program to gather the information, and outputs the results in one of three formats: Nagios, MRTG, or simple.</p>
<h2 id="Output-Modes">Output Modes</h2>
<p>The output can be changed by use of the <code>--output</code> option. The default output is nagios, although this can be changed at the top of the script if you wish. The current option choices are <b>nagios</b>, <b>mrtg</b>, and <b>simple</b>. To avoid having to enter the output argument each time, the type of output is automatically set if no --output argument is given, and if the current directory has one of the output options in its name. For example, creating a directory named mrtg and populating it with symlinks via the <i>--symlinks</i> argument would ensure that any actions run from that directory will always default to an output of "mrtg" As a shortcut for --output=simple, you can enter --simple, which also overrides the directory naming trick.</p>
<h3 id="Nagios-output">Nagios output</h3>
<p>The default output format is for Nagios, which is a single line of information, along with four specific exit codes:</p>
<dl>
<dt id="OK">0 (OK)</dt>
<dd>
</dd>
<dt id="WARNING">1 (WARNING)</dt>
<dd>
</dd>
<dt id="CRITICAL">2 (CRITICAL)</dt>
<dd>
</dd>
<dt id="UNKNOWN">3 (UNKNOWN)</dt>
<dd>
</dd>
</dl>
<p>The output line is one of the words above, a colon, and then a short description of what was measured. Additional statistics information, as well as the total time the command took, can be output as well: see the documentation on the arguments <i><a href="#showperf-VAL">--showperf</a></i>, <i><a href="#perflimit-i">--perflimit</a></i>, and <i><a href="#showtime-VAL">--showtime</a></i>.</p>
<h3 id="MRTG-output">MRTG output</h3>
<p>The MRTG output is four lines, with the first line always giving a single number of importance. When possible, this number represents an actual value such as a number of bytes, but it may also be a 1 or a 0 for actions that only return "true" or "false", such as check_postgres_version. The second line is an additional stat and is only used for some actions. The third line indicates an "uptime" and is not used. The fourth line is a description and usually indicates the name of the database the stat from the first line was pulled from, but may be different depending on the action.</p>
<p>Some actions accept an optional <i>--mrtg</i> argument to further control the output.</p>
<p>See the documentation on each action for details on the exact MRTG output for each one.</p>
<h3 id="Simple-output">Simple output</h3>
<p>The simple output is simply a truncated version of the MRTG one, and simply returns the first number and nothing else. This is very useful when you just want to check the state of something, regardless of any threshold. You can transform the numeric output by appending KB, MB, GB, TB, or EB to the output argument, for example:</p>
<pre><code>--output=simple,MB</code></pre>
<h3 id="Cacti-output">Cacti output</h3>
<p>The Cacti output consists of one or more items on the same line, with a simple name, a colon, and then a number. At the moment, the only action with explicit Cacti output is 'dbstats', and using the --output option is not needed in this case, as Cacti is the only output for this action. For many other actions, using --simple is enough to make Cacti happy.</p>
<h1 id="DATABASE-CONNECTION-OPTIONS">DATABASE CONNECTION OPTIONS</h1>
<p>All actions accept a common set of database options.</p>
<dl>
<dt id="H-NAME-or---host-NAME"><b>-H NAME</b> or <b>--host=NAME</b></dt>
<dd>
<p>Connect to the host indicated by NAME. Can be a comma-separated list of names. Multiple host arguments are allowed. If no host is given, defaults to the <code>PGHOST</code> environment variable or no host at all (which indicates using a local Unix socket). You may also use "--dbhost".</p>
</dd>
<dt id="p-PORT-or---port-PORT"><b>-p PORT</b> or <b>--port=PORT</b></dt>
<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, defaults to the <code>PGPORT</code> environment variable. If that is not set, it defaults to 5432. You may also use "--dbport"</p>
</dd>
<dt id="db-NAME-or---dbname-NAME"><b>-db NAME</b> or <b>--dbname=NAME</b></dt>
<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 the <code>PGDATABASE</code> environment variable. If that is not set, it defaults to 'postgres' if psql is version 8 or greater, and 'template1' otherwise.</p>
</dd>
<dt id="u-USERNAME-or---dbuser-USERNAME"><b>-u USERNAME</b> or <b>--dbuser=USERNAME</b></dt>
<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, it defaults to the <code>PGUSER</code> environment variable, otherwise it defaults to 'postgres'.</p>
</dd>
<dt id="dbpass-PASSWORD"><b>--dbpass=PASSWORD</b></dt>
<dd>
<p>Provides the password to connect to the database with. Use of this option is highly discouraged. Instead, one should use a .pgpass or pg_service.conf file.</p>
</dd>
<dt id="dbservice-NAME"><b>--dbservice=NAME</b></dt>
<dd>
<p>The name of a service inside of the pg_service.conf file. Before version 9.0 of Postgres, this is a global file, usually found in <i>/etc/pg_service.conf</i>. If you are using version 9.0 or higher of Postgres, you can use the file ".pg_service.conf" in the home directory of the user running the script, e.g. nagios.</p>
<p>This file contains a simple list of connection options. You can also pass additional information when using this option such as --dbservice="maindatabase sslmode=require"</p>
<p>The documentation for this file can be found at <a href="https://www.postgresql.org/docs/current/static/libpq-pgservice.html">https://www.postgresql.org/docs/current/static/libpq-pgservice.html</a></p>
</dd>
<dt id="role-ROLE"><b>--role=ROLE</b></dt>
<dd>
<p>Provides the role to switch to after connecting to the database but before running the given check. This provides the ability to have superuser privileges assigned to a role without LOGIN access for the purposes of audit and other security considerations. Requires a local `psql` version 9.6 or higher.</p>
</dd>
</dl>
<p>The database connection options can be grouped: <i>--host=a,b --host=c --port=1234 --port=3344</i> 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><code>--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
--host=a,b --port=5433 --db=c,d
Connects four times: a-5433-c a-5433-d b-5433-c b-5433-d
--host=a,b --host=foo --port=1234 --port=5433 --db=e,f
Connects six times: a-1234-e a-1234-f b-1234-e b-1234-f foo-5433-e foo-5433-f
--host=a,b --host=x --port=5432,5433 --dbuser=alice --dbuser=bob -db=baz
Connects three times: a-5432-alice-baz b-5433-alice-baz x-5433-bob-baz
--dbservice="foo" --port=5433
Connects using the named service 'foo' in the pg_service.conf file, but overrides the port</code></pre>
<h1 id="OTHER-OPTIONS">OTHER OPTIONS</h1>
<p>Other options include:</p>
<dl>
<dt id="action-NAME"><b>--action=NAME</b></dt>
<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>
</dd>
<dt id="warning-VAL-or--w-VAL"><b>--warning=VAL or -w VAL</b></dt>
<dd>
<p>Sets the threshold at which a warning alert is fired. The valid options for this option depends on the action used.</p>
</dd>
<dt id="critical-VAL-or--c-VAL"><b>--critical=VAL or -c VAL</b></dt>
<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>
<dt id="t-VAL-or---timeout-VAL"><b>-t VAL</b> or <b>--timeout=VAL</b></dt>
<dd>
<p>Sets the timeout in seconds after which the script will abort whatever it is doing and return an UNKNOWN status. The timeout is per Postgres cluster, not for the entire script. The default value is 10; the units are always in seconds.</p>
</dd>
<dt id="assume-standby-mode"><b>--assume-standby-mode</b></dt>
<dd>
<p>If specified, first the check if server in standby mode will be performed (--datadir is required), if so, all checks that require SQL queries will be ignored and "Server in standby mode" with OK status will be returned instead.</p>
<p>Example:</p>
<pre><code>postgres@db$./check_postgres.pl --action=version --warning=8.1 --datadir /var/lib/postgresql/8.3/main/ --assume-standby-mode
POSTGRES_VERSION OK: Server in standby mode | time=0.00</code></pre>
</dd>
<dt id="assume-prod"><b>--assume-prod</b></dt>
<dd>
<p>If specified, check if server in production mode is performed (--datadir is required). The option is only relevant for (<code>symlink: check_postgres_checkpoint</code>).</p>
<p>Example:</p>
<pre><code>postgres@db$./check_postgres.pl --action=checkpoint --datadir /var/lib/postgresql/8.3/main/ --assume-prod
POSTGRES_CHECKPOINT OK: Last checkpoint was 72 seconds ago | age=72;;300 mode=MASTER</code></pre>
</dd>
<dt id="assume-async"><b>--assume-async</b></dt>
<dd>
<p>If specified, indicates that any replication between servers is asynchronous. The option is only relevant for (<code>symlink: check_postgres_same_schema</code>).</p>
<p>Example: postgres@db$./check_postgres.pl --action=same_schema --assume-async --dbhost=star,line</p>
</dd>
<dt id="h-or---help"><b>-h</b> or <b>--help</b></dt>
<dd>
<p>Displays a help screen with a summary of all actions and options.</p>
</dd>
<dt id="man"><b>--man</b></dt>
<dd>
<p>Displays the entire manual.</p>
</dd>
<dt id="V-or---version"><b>-V</b> or <b>--version</b></dt>
<dd>
<p>Shows the current version.</p>
</dd>
<dt id="v-or---verbose"><b>-v</b> or <b>--verbose</b></dt>
<dd>
<p>Set the verbosity level. Can call more than once to boost the level. Setting it to three or higher (in other words, issuing <code>-v -v -v</code>) turns on debugging information for this program which is sent to stderr.</p>
</dd>
<dt id="showperf-VAL"><b>--showperf=VAL</b></dt>
<dd>
<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. Only takes effect if using Nagios output mode.</p>
</dd>
<dt id="perflimit-i"><b>--perflimit=i</b></dt>
<dd>
<p>Sets a limit as to how many items of interest are reported back when using the <i>showperf</i> option. This only has an effect for actions that return a large number of items, such as <b>table_size</b>. The default is 0, or no limit. Be careful when using this with the <i>--include</i> or <i>--exclude</i> options, as those restrictions are done <i>after</i> the query has been run, and thus your limit may not include the items you want. Only takes effect if using Nagios output mode.</p>
</dd>
<dt id="showtime-VAL"><b>--showtime=VAL</b></dt>
<dd>
<p>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 <i>showperf</i> is on. Only takes effect if using Nagios output mode.</p>
</dd>
<dt id="test"><b>--test</b></dt>
<dd>
<p>Enables test mode. See the <a href="#TEST-MODE">"TEST MODE"</a> section below.</p>
</dd>
<dt id="PGBINDIR-PATH"><b>--PGBINDIR=PATH</b></dt>
<dd>
<p>Tells the script where to find the psql binaries. Useful if you have more than one version of the PostgreSQL executables on your system, or if there are not in your path. Note that this option is in all uppercase. By default, this option is <i>not allowed</i>. 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 use environment variable c<PGBINDIR> or hard-coded <code>$PGBINDIR</code> variable, also near the top of the script, to set the path to the PostgreSQL to use.</p>
</dd>
<dt id="PSQL-PATH"><b>--PSQL=PATH</b></dt>
<dd>
<p><i>(deprecated, this option may be removed in a future release!)</i> 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</i>. 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>
<dt id="symlinks"><b>--symlinks</b></dt>
<dd>
<p>Creates symlinks to the main program for each action.</p>
</dd>
<dt id="output-VAL"><b>--output=VAL</b></dt>
<dd>
<p>Determines the format of the output, for use in various programs. The default is 'nagios'. Available options are 'nagios', 'mrtg', 'simple' and 'cacti'.</p>
</dd>
<dt id="mrtg-VAL"><b>--mrtg=VAL</b></dt>
<dd>
<p>Used only for the MRTG or simple output, for a few specific actions.</p>
</dd>
<dt id="debugoutput-VAL"><b>--debugoutput=VAL</b></dt>
<dd>
<p>Outputs the exact string returned by psql, for use in debugging. The value is one or more letters, which determine if the output is displayed or not, where 'a' = all, 'c' = critical, 'w' = warning, 'o' = ok, and 'u' = unknown. Letters can be combined.</p>
</dd>
<dt id="get_method-VAL"><b>--get_method=VAL</b></dt>
<dd>
<p>Allows specification of the method used to fetch information for the <code>new_version_cp</code>, <code>new_version_pg</code>, <code>new_version_bc</code>, <code>new_version_box</code>, and <code>new_version_tnm</code> checks. The following programs are tried, in order, to grab the information from the web: GET, wget, fetch, curl, lynx, links. To force the use of just one (and thus remove the overhead of trying all the others until one of those works), enter one of the names as the argument to get_method. For example, a BSD box might enter the following line in their <code>.check_postgresrc</code> file:</p>
<pre><code>get_method=fetch</code></pre>
</dd>
<dt id="language-VAL"><b>--language=VAL</b></dt>
<dd>
<p>Set the language to use for all output messages. Normally, this is detected by examining the environment variables LC_ALL, LC_MESSAGES, and LANG, but setting this option will override any such detection.</p>
</dd>
</dl>
<h1 id="ACTIONS">ACTIONS</h1>
<p>The action to be run is selected using the --action flag, or by using a symlink to the main file that contains the name of the action inside of it. For example, to run the action "timesync", you may either issue:</p>
<pre><code>check_postgres.pl --action=timesync</code></pre>
<p>or use a program named:</p>
<pre><code>check_postgres_timesync</code></pre>
<p>All the symlinks are created for you in the current directory if use the option --symlinks:</p>
<pre><code>perl check_postgres.pl --symlinks</code></pre>
<p>If the file name already exists, it will not be overwritten. If the file exists and is a symlink, you can force it to overwrite by using "--action=build_symlinks_force".</p>
<p>Most actions take a <i>--warning</i> and a <i>--critical</i> option, indicating at what point we change from OK to WARNING, and what point we go to CRITICAL. Note that because criticals are always checked first, setting the warning equal to the critical is an effective way to turn warnings off and always give a critical.</p>
<p>The current supported actions are:</p>
<h2 id="archive_ready"><b>archive_ready</b></h2>
<p>(<code>symlink: check_postgres_archive_ready</code>) Checks how many WAL files with extension <i>.ready</i> exist in the <i>pg_xlog/archive_status</i> directory (PostgreSQL 10 and later: <i>pg_wal/archive_status</i>), which is found off of your <b>data_directory</b>. If the <i>--lsfunc</i> option is not used then this action must be run as a superuser, in order to access the contents of the <i>pg_xlog/archive_status</i> directory. The minimum version to use this action is Postgres 8.1. The <i>--warning</i> and <i>--critical</i> options are simply the number of <i>.ready</i> files in the <i>pg_xlog/archive_status</i> directory. Usually, these values should be low, turning on the archive mechanism, we usually want it to archive WAL files as fast as possible.</p>
<p>If the archive command fail, number of WAL in your <i>pg_xlog</i> directory will grow until exhausting all the disk space and force PostgreSQL to stop immediately.</p>
<p>To avoid running as a database superuser, a wrapper function around <code>pg_ls_dir()</code> should be defined as a superuser with SECURITY DEFINER, and the <i>--lsfunc</i> option used. This example function, if defined by a superuser, will allow the script to connect as a normal user <i>nagios</i> with <i>--lsfunc=ls_archive_status_dir</i></p>
<pre><code>BEGIN;
CREATE FUNCTION ls_archive_status_dir()
RETURNS SETOF TEXT
AS $$ SELECT pg_ls_dir('pg_xlog/archive_status') $$
LANGUAGE SQL
SECURITY DEFINER;
REVOKE ALL ON FUNCTION ls_archive_status_dir() FROM PUBLIC;
GRANT EXECUTE ON FUNCTION ls_archive_status_dir() to nagios;
COMMIT;</code></pre>
<p>Example 1: Check that the number of ready WAL files is 10 or less on host "pluto", using a wrapper function <code>ls_archive_status_dir</code> to avoid the need for superuser permissions</p>
<pre><code>check_postgres_archive_ready --host=pluto --critical=10 --lsfunc=ls_archive_status_dir</code></pre>
<p>For MRTG output, reports the number of ready WAL files on line 1.</p>
<h2 id="autovac_freeze"><b>autovac_freeze</b></h2>
<p>(<code>symlink: check_postgres_autovac_freeze</code>) Checks how close each database is to the Postgres <b>autovacuum_freeze_max_age</b> setting. This action will only work for databases version 8.2 or higher. The <i>--warning</i> and <i>--critical</i> options should be expressed as percentages. The 'age' of the transactions in each database is compared to the autovacuum_freeze_max_age setting (200 million by default) to generate a rounded percentage. The default values are <b>90%</b> for the warning and <b>95%</b> for the critical. Databases can be filtered by use of the <i>--include</i> and <i>--exclude</i> options. See the <a href="#BASIC-FILTERING">"BASIC FILTERING"</a> section for more details.</p>
<p>Example 1: Give a warning when any databases on port 5432 are above 97%</p>
<pre><code>check_postgres_autovac_freeze --port=5432 --warning="97%"</code></pre>
<p>For MRTG output, the highest overall percentage is reported on the first line, and the highest age is reported on the second line. All databases which have the percentage from the first line are reported on the fourth line, separated by a pipe symbol.</p>
<h2 id="backends"><b>backends</b></h2>
<p>(<code>symlink: check_postgres_backends</code>) Checks the current number of connections for one or more databases, and optionally compares it to the maximum allowed, which is determined by the Postgres configuration variable <b>max_connections</b>. The <i>--warning</i> and <i>--critical</i> options can take one of three forms. First, a simple number can be given, which represents the number of connections at which the alert will be given. This choice does not use the <b>max_connections</b> setting. Second, the percentage of available connections can be given. Third, a negative number can be given which represents the number of connections left until <b>max_connections</b> is reached. The default values for <i>--warning</i> and <i>--critical</i> are '90%' and '95%'. You can also filter the databases by use of the <i>--include</i> and <i>--exclude</i> options. See the <a href="#BASIC-FILTERING">"BASIC FILTERING"</a> section for more details.</p>
<p>To view only non-idle processes, you can use the <i>--noidle</i> argument. Note that the user you are running as (either connecting directly or switching via <i>--role</i>) must be a superuser for this to work properly.</p>
<p>Example 1: Give a warning when the number of connections on host quirm reaches 120, and a critical if it reaches 150.</p>
<pre><code>check_postgres_backends --host=quirm --warning=120 --critical=150</code></pre>
<p>Example 2: Give a critical when we reach 75% of our max_connections setting on hosts lancre or lancre2.</p>
<pre><code>check_postgres_backends --warning='75%' --critical='75%' --host=lancre,lancre2</code></pre>
<p>Example 3: Give a warning when there are only 10 more connection slots left on host plasmid, and a critical when we have only 5 left.</p>
<pre><code>check_postgres_backends --warning=-10 --critical=-5 --host=plasmid</code></pre>
<p>Example 4: Check all databases except those with "test" in their name, but allow ones that are named "pg_greatest". Connect as port 5432 on the first two hosts, and as port 5433 on the third one. We want to always throw a critical when we reach 30 or more connections.</p>
<pre><code>check_postgres_backends --dbhost=hong,kong --dbhost=fooey --dbport=5432 --dbport=5433 --warning=30 --critical=30 --exclude="~test" --include="pg_greatest,~prod"</code></pre>
<p>For MRTG output, the number of connections is reported on the first line, and the fourth line gives the name of the database, plus the current maximum_connections. If more than one database has been queried, the one with the highest number of connections is output.</p>
<h2 id="bloat"><b>bloat</b></h2>
<p>(<code>symlink: check_postgres_bloat</code>) Checks the amount of bloat in tables and indexes. (Bloat is generally the amount of dead unused space taken up in a table or index. This space is usually reclaimed by use of the VACUUM command.) This action requires that stats collection be enabled on the target databases, and requires that ANALYZE is run frequently. The <i>--include</i> and <i>--exclude</i> options can be used to filter out which tables to look at. See the <a href="#BASIC-FILTERING">"BASIC FILTERING"</a> section for more details.</p>
<p>The <i>--warning</i> and <i>--critical</i> options can be specified as sizes, percents, or both. Valid size units are bytes, kilobytes, megabytes, gigabytes, terabytes, exabytes, petabytes, and zettabytes. You can abbreviate all of those with the first letter. Items without units are assumed to be 'bytes'. The default values are '1 GB' and '5 GB'. The value represents the number of "wasted bytes", or the difference between what is actually used by the table and index, and what we compute that it should be.</p>
<p>Note that this action has two hard-coded values to avoid false alarms on smaller relations. Tables must have at least 10 pages, and indexes at least 15, before they can be considered by this test. If you really want to adjust these values, you can look for the variables <i>$MINPAGES</i> and <i>$MINIPAGES</i> at the top of the <code>check_bloat</code> subroutine. These values are ignored if either <i>--exclude</i> or <i>--include</i> is used.</p>
<p>Only the top 10 most bloated relations are shown. You can change this number by using the <i>--perflimit</i> option to set your own limit.</p>
<p>The schema named 'information_schema' is excluded from this test, as the only tables it contains are small and do not change.</p>
<p>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 index size is even more of a guess than the correct table size, but both should give a rough idea of how bloated things are.</p>
<p>Example 1: Warn if any table on port 5432 is over 100 MB bloated, and critical if over 200 MB</p>
<pre><code>check_postgres_bloat --port=5432 --warning='100 M' --critical='200 M'</code></pre>
<p>Example 2: Give a critical if table 'orders' on host 'sami' has more than 10 megs of bloat</p>
<pre><code>check_postgres_bloat --host=sami --include=orders --critical='10 MB'</code></pre>
<p>Example 3: Give a critical if table 'q4' on database 'sales' is over 50% bloated</p>
<pre><code>check_postgres_bloat --db=sales --include=q4 --critical='50%'</code></pre>
<p>Example 4: Give a critical any table is over 20% bloated <i>and</i> has over 150 MB of bloat:</p>
<pre><code>check_postgres_bloat --port=5432 --critical='20% and 150 M'</code></pre>
<p>Example 5: Give a critical any table is over 40% bloated <i>or</i> has over 500 MB of bloat:</p>
<pre><code>check_postgres_bloat --port=5432 --warning='500 M or 40%'</code></pre>
<p>For MRTG output, the first line gives the highest number of wasted bytes for the tables, and the second line gives the highest number of wasted bytes for the indexes. The fourth line gives the database name, table name, and index name information. If you want to output the bloat ratio instead (how many times larger the relation is compared to how large it should be), just pass in <code>--mrtg=ratio</code>.</p>
<h2 id="checkpoint"><b>checkpoint</b></h2>
<p>(<code>symlink: check_postgres_checkpoint</code>) Determines how long since the last checkpoint has been run. This must run on the same server as the database that is being checked (e.g. the -h flag will not work). This check is meant to run on a "warm standby" server that is actively processing shipped WAL files, and is meant to check that your warm standby is truly 'warm'. The data directory must be set, either by the environment variable <code>PGDATA</code>, or passing the <code>--datadir</code> argument. It returns the number of seconds since the last checkpoint was run, as determined by parsing the call to <code>pg_controldata</code>. Because of this, the pg_controldata executable must be available in the current path. Alternatively, you can specify <code>PGBINDIR</code> as the directory that it lives in. It is also possible to use the special options <i>--assume-prod</i> or <i>--assume-standby-mode</i>, if the mode found is not the one expected, a CRITICAL is emitted.</p>
<p>At least one warning or critical argument must be set.</p>
<p>This action requires the Date::Parse module.</p>
<p>For MRTG or simple output, returns the number of seconds.</p>
<h2 id="cluster_id"><b>cluster_id</b></h2>
<p>(<code>symlink: check_postgres_cluster-id</code>) Checks that the Database System Identifier provided by pg_controldata is the same as last time you checked. This must run on the same server as the database that is being checked (e.g. the -h flag will not work). Either the <i>--warning</i> or the <i>--critical</i> option should be given, but not both. The value of each one is the cluster identifier, an integer value. You can run with the special <code>--critical=0</code> option to find out an existing cluster identifier.</p>
<p>Example 1: Find the initial identifier</p>
<pre><code>check_postgres_cluster_id --critical=0 --datadir=/var//lib/postgresql/9.0/main</code></pre>
<p>Example 2: Make sure the cluster is the same and warn if not, using the result from above.</p>
<pre><code>check_postgres_cluster_id --critical=5633695740047915135</code></pre>
<p>For MRTG output, returns a 1 or 0 indicating success of failure of the identifier to match. A identifier must be provided as the <code>--mrtg</code> argument. The fourth line always gives the current identifier.</p>
<h2 id="commitratio"><b>commitratio</b></h2>
<p>(<code>symlink: check_postgres_commitratio</code>) Checks the commit ratio of all databases and complains when they are too low. There is no need to run this command more than once per database cluster. Databases can be filtered with the <i>--include</i> and <i>--exclude</i> options. See the <a href="#BASIC-FILTERING">"BASIC FILTERING"</a> section for more details. They can also be filtered by the owner of the database with the <i>--includeuser</i> and <i>--excludeuser</i> options. See the <a href="#USER-NAME-FILTERING">"USER NAME FILTERING"</a> section for more details.</p>
<p>The warning and critical options should be specified as percentages. There are not defaults for this action: the warning and critical must be specified. The warning value cannot be greater than the critical value. The output returns all databases sorted by commitratio, smallest first.</p>
<p>Example: Warn if any database on host flagg is less than 90% in commitratio, and critical if less then 80%.</p>
<pre><code>check_postgres_database_commitratio --host=flagg --warning='90%' --critical='80%'</code></pre>
<p>For MRTG output, returns the percentage of the database with the smallest commitratio on the first line, and the name of the database on the fourth line.</p>
<h2 id="connection"><b>connection</b></h2>
<p>(<code>symlink: check_postgres_connection</code>) Simply connects, issues a 'SELECT version()', and leaves. Takes no <i>--warning</i> or <i>--critical</i> options.</p>
<p>For MRTG output, simply outputs a 1 (good connection) or a 0 (bad connection) on the first line.</p>
<h2 id="custom_query"><b>custom_query</b></h2>
<p>(<code>symlink: check_postgres_custom_query</code>) Runs a custom query of your choosing, and parses the results. The query itself is passed in through the <code>query</code> argument, and should be kept as simple as possible. If at all possible, wrap it in a view or a function to keep things easier to manage. The query should return one or two columns. It is required that one of the columns be named "result" and is the item that will be checked against your warning and critical values. The second column is for the performance data and any name can be used: this will be the 'value' inside the performance data section.</p>
<p>At least one warning or critical argument must be specified. What these are set to depends on the type of query you are running. There are four types of custom_queries that can be run, specified by the <code>valtype</code> argument. If none is specified, this action defaults to 'integer'. The four types are:</p>
<p><b>integer</b>: Does a simple integer comparison. The first column should be a simple integer, and the warning and critical values should be the same.</p>
<p><b>string</b>: The warning and critical are strings, and are triggered only if the value in the first column matches it exactly. This is case-sensitive.</p>
<p><b>time</b>: The warning and the critical are times, and can have units of seconds, minutes, hours, or days. Each may be written singular or abbreviated to just the first letter. If no units are given, seconds are assumed. The first column should be an integer representing the number of seconds to check.</p>
<p><b>size</b>: The warning and the critical are sizes, and can have units of bytes, kilobytes, megabytes, gigabytes, 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.</p>
<p>Normally, an alert is triggered if the values returned are <b>greater than</b> or equal to the critical or warning value. However, an option of <i>--reverse</i> will trigger the alert if the returned value is <b>lower than</b> or equal to the critical or warning value.</p>
<p>Example 1: Warn if any relation over 100 pages is named "rad", put the number of pages inside the performance data section.</p>
<pre><code>check_postgres_custom_query --valtype=string -w "rad" --query=
"SELECT relname AS result, relpages AS pages FROM pg_class WHERE relpages > 100"</code></pre>
<p>Example 2: Give a critical if the "foobar" function returns a number over 5MB:</p>
<pre><code>check_postgres_custom_query --critical='5MB'--valtype=size --query="SELECT foobar() AS result"</code></pre>
<p>Example 2: Warn if the function "snazzo" returns less than 42:</p>
<pre><code>check_postgres_custom_query --critical=42 --query="SELECT snazzo() AS result" --reverse</code></pre>
<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>
<p>This action does not support MRTG or simple output yet.</p>
<h2 id="database_size"><b>database_size</b></h2>
<p>(<code>symlink: check_postgres_database_size</code>) Checks the size of all databases and complains when they are too big. There is no need to run this command more than once per database cluster. Databases can be filtered with the <i>--include</i> and <i>--exclude</i> options. See the <a href="#BASIC-FILTERING">"BASIC FILTERING"</a> section for more details. They can also be filtered by the owner of the database with the <i>--includeuser</i> and <i>--excludeuser</i> options. See the <a href="#USER-NAME-FILTERING">"USER NAME FILTERING"</a> section for more details.</p>
<p>The warning and critical options can be specified as bytes, kilobytes, megabytes, gigabytes, terabytes, or exabytes. Each may be abbreviated to the first letter as well. If no unit is given, the units are assumed to be bytes. There are not defaults for this action: the warning and critical must be specified. The warning value cannot be greater than the critical value. The output returns all databases sorted by size largest first, showing both raw bytes and a "pretty" version of the size.</p>
<p>Example 1: Warn if any database on host flagg is over 1 TB in size, and critical if over 1.1 TB.</p>
<pre><code>check_postgres_database_size --host=flagg --warning='1 TB' --critical='1.1 t'</code></pre>
<p>Example 2: Give a critical if the database template1 on port 5432 is over 10 MB.</p>
<pre><code>check_postgres_database_size --port=5432 --include=template1 --warning='10MB' --critical='10MB'</code></pre>
<p>Example 3: Give a warning if any database on host 'tardis' owned by the user 'tom' is over 5 GB</p>
<pre><code>check_postgres_database_size --host=tardis --includeuser=tom --warning='5 GB' --critical='10 GB'</code></pre>
<p>For MRTG output, returns the size in bytes of the largest database on the first line, and the name of the database on the fourth line.</p>
<h2 id="dbstats"><b>dbstats</b></h2>
<p>(<code>symlink: check_postgres_dbstats</code>) Reports information from the pg_stat_database view, and outputs it in a Cacti-friendly manner. No other output is supported, as the output is informational and does not lend itself to alerts, such as used with Nagios. If no options are given, all databases are returned, one per line. You can include a specific database by use of the <code>--include</code> option, or you can use the <code>--dbname</code> option.</p>
<p>Eleven items are returned on each line, in the format name:value, separated by a single space. The items are:</p>
<dl>
<dt id="backends1">backends</dt>
<dd>
<p>The number of currently running backends for this database.</p>
</dd>
<dt id="commits">commits</dt>
<dd>
<p>The total number of commits for this database since it was created or reset.</p>
</dd>
<dt id="rollbacks">rollbacks</dt>
<dd>
<p>The total number of rollbacks for this database since it was created or reset.</p>
</dd>
<dt id="read">read</dt>
<dd>
<p>The total number of disk blocks read.</p>
</dd>
<dt id="hit">hit</dt>
<dd>
<p>The total number of buffer hits.</p>
</dd>
<dt id="ret">ret</dt>
<dd>
<p>The total number of rows returned.</p>
</dd>
<dt id="fetch">fetch</dt>
<dd>
<p>The total number of rows fetched.</p>
</dd>
<dt id="ins">ins</dt>
<dd>
<p>The total number of rows inserted.</p>
</dd>
<dt id="upd">upd</dt>
<dd>
<p>The total number of rows updated.</p>
</dd>
<dt id="del">del</dt>
<dd>
<p>The total number of rows deleted.</p>
</dd>
<dt id="dbname">dbname</dt>
<dd>
<p>The name of the database.</p>
</dd>
</dl>
<p>Note that ret, fetch, ins, upd, and del items will always be 0 if Postgres is version 8.2 or lower, as those stats were not available in those versions.</p>
<p>If the dbname argument is given, seven additional items are returned:</p>
<dl>
<dt id="idxscan">idxscan</dt>
<dd>
<p>Total number of user index scans.</p>
</dd>
<dt id="idxtupread">idxtupread</dt>
<dd>
<p>Total number of user index entries returned.</p>
</dd>
<dt id="idxtupfetch">idxtupfetch</dt>
<dd>
<p>Total number of rows fetched by simple user index scans.</p>
</dd>
<dt id="idxblksread">idxblksread</dt>
<dd>
<p>Total number of disk blocks read for all user indexes.</p>
</dd>
<dt id="idxblkshit">idxblkshit</dt>
<dd>
<p>Total number of buffer hits for all user indexes.</p>
</dd>
<dt id="seqscan">seqscan</dt>
<dd>
<p>Total number of sequential scans against all user tables.</p>
</dd>
<dt id="seqtupread">seqtupread</dt>
<dd>
<p>Total number of tuples returned from all user tables.</p>
</dd>
</dl>
<p>Example 1: Grab the stats for a database named "products" on host "willow":</p>
<pre><code>check_postgres_dbstats --dbhost willow --dbname products</code></pre>
<p>The output returned will be like this (all on one line, not wrapped):</p>
<pre><code>backends:82 commits:58374408 rollbacks:1651 read:268435543 hit:2920381758 idxscan:310931294 idxtupread:2777040927
idxtupfetch:1840241349 idxblksread:62860110 idxblkshit:1107812216 seqscan:5085305 seqtupread:5370500520
ret:0 fetch:0 ins:0 upd:0 del:0 dbname:willow</code></pre>
<h2 id="disabled_triggers"><b>disabled_triggers</b></h2>
<p>(<code>symlink: check_postgres_disabled_triggers</code>) Checks on the number of disabled triggers inside the database. The <i>--warning</i> and <i>--critical</i> options are the number of such triggers found, and both default to "1", as in normal usage having disabled triggers is a dangerous event. If the database being checked is 8.3 or higher, the check is for the number of triggers that are in a 'disabled' status (as opposed to being 'always' or 'replica'). The output will show the name of the table and the name of the trigger for each disabled trigger.</p>
<p>Example 1: Make sure that there are no disabled triggers</p>
<pre><code>check_postgres_disabled_triggers</code></pre>
<p>For MRTG output, returns the number of disabled triggers on the first line.</p>
<h2 id="disk_space"><b>disk_space</b></h2>
<p>(<code>symlink: check_postgres_disk_space</code>) Checks on the available physical disk space used by Postgres. This action requires that you have the executable "/bin/df" available to report on disk sizes, and it also needs to be run as a superuser (either connecting directly or switching via <i>--role</i>), so it can examine the <b>data_directory</b> setting inside of Postgres. The <i>--warning</i> and <i>--critical</i> options are given in either sizes or percentages or both. If using sizes, the standard unit types are allowed: bytes, kilobytes, gigabytes, megabytes, gigabytes, terabytes, or exabytes. Each may be abbreviated to the first letter only; no units at all indicates 'bytes'. The default values are '90%' and '95%'.</p>
<p>This command checks the following things to determine all of the different physical disks being used by Postgres.</p>
<p><b>data_directory</b> - The disk that the main data directory is on.</p>
<p><b>log directory</b> - The disk that the log files are on.</p>
<p><b>WAL file directory</b> - The disk that the write-ahead logs are on (e.g. symlinked pg_xlog or pg_wal)</p>
<p><b>tablespaces</b> - Each tablespace that is on a separate disk.</p>
<p>The output shows the total size used and available on each disk, as well as the percentage, ordered by highest to lowest percentage used. Each item above maps to a file system: these can be included or excluded. See the <a href="#BASIC-FILTERING">"BASIC FILTERING"</a> section for more details.</p>
<p>Example 1: Make sure that no file system is over 90% for the database on port 5432.</p>
<pre><code>check_postgres_disk_space --port=5432 --warning='90%' --critical='90%'</code></pre>
<p>Example 2: Check that all file systems starting with <i>/dev/sda</i> are smaller than 10 GB and 11 GB (warning and critical)</p>
<pre><code>check_postgres_disk_space --port=5432 --warning='10 GB' --critical='11 GB' --include="~^/dev/sda"</code></pre>
<p>Example 4: Make sure that no file system is both over 50% <i>and</i> has over 15 GB</p>
<pre><code>check_postgres_disk_space --critical='50% and 15 GB'</code></pre>
<p>Example 5: Issue a warning if any file system is either over 70% full <i>or</i> has more than 1T</p>
<pre><code>check_postgres_disk_space --warning='1T or 75'</code></pre>
<p>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.</p>
<h2 id="fsm_pages"><b>fsm_pages</b></h2>
<p>(<code>symlink: check_postgres_fsm_pages</code>) Checks how close a cluster is to the Postgres <b>max_fsm_pages</b> setting. This action will only work for databases of 8.2 or higher, and it requires the contrib module <b>pg_freespacemap</b> be installed. The <i>--warning</i> and <i>--critical</i> 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%</b> for the warning and <b>95%</b> for the critical.</p>
<p>Example 1: Give a warning when our cluster has used up 76% of the free-space pageslots, with pg_freespacemap installed in database robert</p>
<pre><code>check_postgres_fsm_pages --dbname=robert --warning="76%"</code></pre>
<p>While you need to pass in the name of the database where pg_freespacemap is installed, 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.</p>
<p>For MRTG output, returns the percent of free-space-map on the first line, and the number of pages currently used on the second line.</p>
<h2 id="fsm_relations"><b>fsm_relations</b></h2>
<p>(<code>symlink: check_postgres_fsm_relations</code>) Checks how close a cluster is to the Postgres <b>max_fsm_relations</b> setting. This action will only work for databases of 8.2 or higher, and it requires the contrib module <b>pg_freespacemap</b> be installed. The <i>--warning</i> and <i>--critical</i> 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%</b> for the warning and <b>95%</b> for the critical.</p>
<p>Example 1: Give a warning when our cluster has used up 80% of the free-space relations, with pg_freespacemap installed in database dylan</p>
<pre><code>check_postgres_fsm_relations --dbname=dylan --warning="75%"</code></pre>
<p>While you need to pass in the name of the database where pg_freespacemap is installed, 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.</p>
<p>For MRTG output, returns the percent of free-space-map on the first line, the number of relations currently used on the second line.</p>
<h2 id="hitratio"><b>hitratio</b></h2>
<p>(<code>symlink: check_postgres_hitratio</code>) Checks the hit ratio of all databases and complains when they are too low. There is no need to run this command more than once per database cluster. Databases can be filtered with the <i>--include</i> and <i>--exclude</i> options. See the <a href="#BASIC-FILTERING">"BASIC FILTERING"</a> section for more details. They can also be filtered by the owner of the database with the <i>--includeuser</i> and <i>--excludeuser</i> options. See the <a href="#USER-NAME-FILTERING">"USER NAME FILTERING"</a> section for more details.</p>
<p>The warning and critical options should be specified as percentages. There are not defaults for this action: the warning and critical must be specified. The warning value cannot be greater than the critical value. The output returns all databases sorted by hitratio, smallest first.</p>
<p>Example: Warn if any database on host flagg is less than 90% in hitratio, and critical if less then 80%.</p>
<pre><code>check_postgres_hitratio --host=flagg --warning='90%' --critical='80%'</code></pre>
<p>For MRTG output, returns the percentage of the database with the smallest hitratio on the first line, and the name of the database on the fourth line.</p>
<h2 id="hot_standby_delay"><b>hot_standby_delay</b></h2>
<p>(<code>symlink: check_hot_standby_delay</code>) Checks the streaming replication lag by computing the delta between the current xlog position of a master server and the replay location of a slave connected to it. The slave server must be in hot_standby (e.g. read only) mode, therefore the minimum version to use this action is Postgres 9.0. The <i>--warning</i> and <i>--critical</i> options are the delta between the xlog locations. Since these values are byte offsets in the WAL they should match the expected transaction volume of your application to prevent false positives or negatives.</p>
<p>The first "--dbname", "--host", and "--port", etc. options are considered the master; the second belongs to the slave.</p>
<p>Byte values should be based on the volume of transactions needed to have the streaming replication disconnect from the master because of too much lag, determined by the Postgres configuration variable <b>wal_keep_segments</b>. For units of time, valid units are 'seconds', 'minutes', 'hours', or 'days'. Each may be written singular or abbreviated to just the first letter. When specifying both, in the form '<i>bytes</i> and <i>time</i>', both conditions must be true for the threshold to be met.</p>
<p>You must provide information on how to reach the databases by providing a comma separated list to the --dbhost and --dbport parameters, such as "--dbport=5432,5543". If not given, the action fails.</p>
<p>Example 1: Warn a database with a local replica on port 5433 is behind on any xlog replay at all</p>
<pre><code>check_hot_standby_delay --dbport=5432,5433 --warning='1'</code></pre>
<p>Example 2: Give a critical if the last transaction replica1 receives is more than 10 minutes ago</p>
<pre><code>check_hot_standby_delay --dbhost=master,replica1 --critical='10 min'</code></pre>
<p>Example 3: Allow replica1 to be 1 WAL segment behind, if the master is momentarily seeing more activity than the streaming replication connection can handle, or 10 minutes behind, if the master is seeing very little activity and not processing any transactions, but not both, which would indicate a lasting problem with the replication connection.</p>
<pre><code>check_hot_standby_delay --dbhost=master,replica1 --warning='1048576 and 2 min' --critical='16777216 and 10 min'</code></pre>
<h2 id="relation_size"><b>relation_size</b></h2>
<h2 id="index_size"><b>index_size</b></h2>
<h2 id="table_size"><b>table_size</b></h2>
<h2 id="indexes_size"><b>indexes_size</b></h2>
<h2 id="total_relation_size"><b>total_relation_size</b></h2>
<p>(symlinks: <code>check_postgres_relation_size</code>, <code>check_postgres_index_size</code>, <code>check_postgres_table_size</code>, <code>check_postgres_indexes_size</code>, and <code>check_postgres_total_relation_size</code>)</p>
<p>The actions <b>relation_size</b> and <b>index_size</b> check for a relation (table, index, materialized view), respectively an index that has grown too big, using the <b>pg_relation_size()</b> function.</p>
<p>The action <b>table_size</b> checks tables and materialized views using <b>pg_table_size()</b>, i.e. including relation forks and TOAST table.</p>
<p>The action <b>indexes_size</b> checks tables and materialized views for the size of the attached indexes using <b>pg_indexes_size()</b>.</p>
<p>The action <b>total_relation_size</b> checks relations using <b>pg_total_relation_size()</b>, i.e. including relation forks, indexes and TOAST table.</p>
<p>Relations can be filtered with the <i>--include</i> and <i>--exclude</i> options. See the <a href="#BASIC-FILTERING">"BASIC FILTERING"</a> section for more details. Relations can also be filtered by the user that owns them, by using the <i>--includeuser</i> and <i>--excludeuser</i> options. See the <a href="#USER-NAME-FILTERING">"USER NAME FILTERING"</a> section for more details.</p>
<p>The values for the <i>--warning</i> and <i>--critical</i> options are file sizes, and may have units of bytes, kilobytes, megabytes, gigabytes, terabytes, or exabytes. Each can be abbreviated to the first letter. If no units are given, bytes are assumed. There are no default values: both the warning and the critical option must be given. The return text shows the size of the largest relation found.</p>
<p>If the <i>--showperf</i> option is enabled, <i>all</i> of the relations with their sizes will be given. To prevent this, it is recommended that you set the <i>--perflimit</i> option, which will cause the query to do a <code>ORDER BY size DESC LIMIT (perflimit)</code>.</p>
<p>Example 1: Give a critical if any table is larger than 600MB on host burrick.</p>
<pre><code>check_postgres_table_size --critical='600 MB' --warning='600 MB' --host=burrick</code></pre>
<p>Example 2: Warn if the table products is over 4 GB in size, and give a critical at 4.5 GB.</p>
<pre><code>check_postgres_table_size --host=burrick --warning='4 GB' --critical='4.5 GB' --include=products</code></pre>
<p>Example 3: Warn if any index not owned by postgres goes over 500 MB.</p>
<pre><code>check_postgres_index_size --port=5432 --excludeuser=postgres -w 500MB -c 600MB</code></pre>
<p>For MRTG output, returns the size in bytes of the largest relation, and the name of the database and relation as the fourth line.</p>
<h2 id="last_analyze"><b>last_analyze</b></h2>
<h2 id="last_vacuum"><b>last_vacuum</b></h2>
<h2 id="last_autoanalyze"><b>last_autoanalyze</b></h2>
<h2 id="last_autovacuum"><b>last_autovacuum</b></h2>
<p>(symlinks: <code>check_postgres_last_analyze</code>, <code>check_postgres_last_vacuum</code>, <code>check_postgres_last_autoanalyze</code>, and <code>check_postgres_last_autovacuum</code>) Checks how long it has been since vacuum (or analyze) was last run on each table in one or more databases. Use of these actions requires that the target database is version 8.3 or greater, or that the version is 8.2 and the configuration variable <b>stats_row_level</b> has been enabled. Tables can be filtered with the <i>--include</i> and <i>--exclude</i> options. See the <a href="#BASIC-FILTERING">"BASIC FILTERING"</a> section for more details. Tables can also be filtered by their owner by use of the <i>--includeuser</i> and <i>--excludeuser</i> options. See the <a href="#USER-NAME-FILTERING">"USER NAME FILTERING"</a> section for more details.</p>
<p>The units for <i>--warning</i> and <i>--critical</i> are specified as times. Valid units are seconds, minutes, hours, and days; all can be abbreviated to the first letter. If no units are given, 'seconds' are assumed. The default values are '1 day' and '2 days'. Please note that there are cases in which this field does not get automatically populated. If certain tables are giving you problems, make sure that they have dead rows to vacuum, or just exclude them from the test.</p>
<p>The schema named 'information_schema' is excluded from this test, as the only tables it contains are small and do not change.</p>
<p>Note that the non-'auto' versions will also check on the auto versions as well. In other words, using last_vacuum will report on the last vacuum, whether it was a normal vacuum, or one run by the autovacuum daemon.</p>
<p>Example 1: Warn if any table has not been vacuumed in 3 days, and give a critical at a week, for host wormwood</p>
<pre><code>check_postgres_last_vacuum --host=wormwood --warning='3d' --critical='7d'</code></pre>
<p>Example 2: Same as above, but skip tables belonging to the users 'eve' or 'mallory'</p>
<pre><code>check_postgres_last_vacuum --host=wormwood --warning='3d' --critical='7d' --excludeuser=eve,mallory</code></pre>
<p>For MRTG output, returns (on the first line) the LEAST amount of time in seconds since a table was last vacuumed or analyzed. The fourth line returns the name of the database and name of the table.</p>
<h2 id="listener"><b>listener</b></h2>
<p>(<code>symlink: check_postgres_listener</code>) Confirm that someone is listening for one or more specific strings (using the LISTEN/NOTIFY system), by looking at the pg_listener table. Only one of warning or critical is needed. The format is a simple string representing the LISTEN target, or a tilde character followed by a string for a regular expression check. Note that this check will not work on versions of Postgres 9.0 or higher.</p>
<p>Example 1: Give a warning if nobody is listening for the string bucardo_mcp_ping on ports 5555 and 5556</p>
<pre><code>check_postgres_listener --port=5555,5556 --warning=bucardo_mcp_ping</code></pre>
<p>Example 2: Give a critical if there are no active LISTEN requests matching 'grimm' on database oskar</p>
<pre><code>check_postgres_listener --db oskar --critical=~grimm</code></pre>
<p>For MRTG output, returns a 1 or a 0 on the first, indicating success or failure. The name of the notice must be provided via the <i>--mrtg</i> option.</p>
<h2 id="locks"><b>locks</b></h2>
<p>(<code>symlink: check_postgres_locks</code>) Check the total number of locks on one or more databases. There is no need to run this more than once per database cluster. Databases can be filtered with the <i>--include</i> and <i>--exclude</i> options. See the <a href="#BASIC-FILTERING">"BASIC FILTERING"</a> section for more details.</p>
<p>The <i>--warning</i> and <i>--critical</i> options can be specified as simple numbers, which represent the total number of locks, or they can be broken down by type of lock. Valid lock names are <code>'total'</code>, <code>'waiting'</code>, or the name of a lock type used by Postgres. These names are case-insensitive and do not need the "lock" part on the end, so <b>exclusive</b> will match 'ExclusiveLock'. The format is name=number, with different items separated by colons or semicolons (or any other symbol).</p>
<p>Example 1: Warn if the number of locks is 100 or more, and critical if 200 or more, on host garrett</p>
<pre><code>check_postgres_locks --host=garrett --warning=100 --critical=200</code></pre>
<p>Example 2: On the host artemus, warn if 200 or more locks exist, and give a critical if over 250 total locks exist, or if over 20 exclusive locks exist, or if over 5 connections are waiting for a lock.</p>
<pre><code>check_postgres_locks --host=artemus --warning=200 --critical="total=250:waiting=5:exclusive=20"</code></pre>
<p>For MRTG output, returns the number of locks on the first line, and the name of the database on the fourth line.</p>
<h2 id="lockwait"><b>lockwait</b></h2>
<p>(<code>symlink: check_postgres_lockwait</code>) Check if there are blocking blocks and for how long. There is no need to run this more than once per database cluster. Databases can be filtered with the <i>--include</i> and <i>--exclude</i> options. See the <a href="#BASIC-FILTERING">"BASIC FILTERING"</a> section for more details.</p>
<p>The <i>--warning</i> and <i>--critical</i> options is time, which represent the time for which the lock has been blocking.</p>
<p>Example 1: Warn if a lock has been blocking for more than a minute, critcal if for more than 2 minutes</p>
<pre><code>check_postgres_lockwait --host=garrett --warning='1 min' --critical='2 min'</code></pre>
<p>For MRTG output, returns the number of blocked sessions.</p>
<h2 id="logfile"><b>logfile</b></h2>
<p>(<code>symlink: check_postgres_logfile</code>) Ensures that the logfile is in the expected location and is being logged to. This action issues a command that throws an error on each database it is checking, and ensures that the message shows up in the logs. It scans the various log_* settings inside of Postgres to figure out where the logs should be. If you are using syslog, it does a rough (but not foolproof) scan of <i>/etc/syslog.conf</i>. Alternatively, you can provide the name of the logfile with the <i>--logfile</i> option. This is especially useful if the logs have a custom rotation scheme driven be an external program. The <b>--logfile</b> option supports the following escape characters: <code>%Y %m %d %H</code>, which represent the current year, month, date, and hour respectively. An error is always reported as critical unless the warning option has been passed in as a non-zero value. Other than that specific usage, the <code>--warning</code> and <code>--critical</code> options should <i>not</i> be used.</p>
<p>Example 1: On port 5432, ensure the logfile is being written to the file /home/greg/pg8.2.log</p>
<pre><code>check_postgres_logfile --port=5432 --logfile=/home/greg/pg8.2.log</code></pre>
<p>Example 2: Same as above, but raise a warning, not a critical</p>
<pre><code>check_postgres_logfile --port=5432 --logfile=/home/greg/pg8.2.log -w 1</code></pre>
<p>For MRTG output, returns a 1 or 0 on the first line, indicating success or failure. In case of a failure, the fourth line will provide more detail on the failure encountered.</p>
<h2 id="new_version_bc"><b>new_version_bc</b></h2>
<p>(<code>symlink: check_postgres_new_version_bc</code>) Checks if a newer version of the Bucardo program is available. The current version is obtained by running <code>bucardo_ctl --version</code>. If a major upgrade is available, a warning is returned. If a revision upgrade is available, a critical is returned. (Bucardo is a master to slave, and master to master replication system for Postgres: see <a href="https://bucardo.org/">https://bucardo.org/</a> for more information). See also the information on the <code>--get_method</code> option.</p>