README.md
1check_postgres
2==============
3
4[](https://travis-ci.org/bucardo/check_postgres)
5
6This is check_postgres, a monitoring tool for Postgres.
7
8The most complete and up to date information about this script can be found at:
9
10https://bucardo.org/check_postgres/
11
12This document will cover how to install the script.
13
14Quick method
15------------
16
17For the impatient Nagios admin, just copy the "check_postgres.pl" file
18to your Nagios scripts directory, and perhaps symlink entries to that
19file by:
20
21 cd <the directory you just copied the file to>
22 mkdir postgres
23 cd postgres
24 perl ../check_postgres.pl --symlinks
25
26Then join the announce mailing list (see below)
27
28Complete method
29---------------
30
31The better way to install this script is via the standard Perl process:
32
33 perl Makefile.PL
34 make
35 env -i make test
36 make install
37
38The last step usually needs to be done as the root user. You may want to
39copy the script to a place that makes more sense for Nagios, if using it
40for that purpose. See the "Quick" instructions above.
41
42For `make test`, please report any failing tests to check_postgres@bucardo.org.
43The tests need to have some standard Postgres binaries available, such as
44`initdb`, `psql`, and `pg_ctl`. If these are not in your path, or you want to
45use specific ones, please set the environment variable `PGBINDIR` first. More
46details on running the testsuite are available in `README.dev`.
47
48Once `make install` has been done, you should have access to the complete
49documentation by typing:
50
51 man check_postgres
52
53The HTML version of the documentation is also available at:
54
55https://bucardo.org/check_postgres/check_postgres.pl.html
56
57Mailing lists
58-------------
59
60The final step should be to subscribe to the low volume check_postgres-announce
61mailing list, so you learn of new versions and important changes. Information
62on joining can be found at:
63
64https://mail.endcrypt.com/mailman/listinfo/check_postgres-announce
65
66General questions and development issues are discussed on the check_postgres list,
67which we recommend people join as well:
68
69https://mail.endcrypt.com/mailman/listinfo/check_postgres
70
71Development happens via git. You can check out the repository by doing:
72
73 https://github.com/bucardo/check_postgres
74 git clone https://github.com/bucardo/check_postgres.git
75
76COPYRIGHT
77---------
78
79 Copyright (c) 2007-2020 Greg Sabino Mullane
80
81LICENSE INFORMATION
82-------------------
83
84Redistribution and use in source and binary forms, with or without
85modification, are permitted provided that the following conditions are met:
86
87 1. Redistributions of source code must retain the above copyright notice,
88 this list of conditions and the following disclaimer.
89 2. Redistributions in binary form must reproduce the above copyright notice,
90 this list of conditions and the following disclaimer in the documentation
91 and/or other materials provided with the distribution.
92
93THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED
94WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
95MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
96EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
97EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
98OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
99INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
100CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
101IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
102OF SUCH DAMAGE.
103
){kind=link}