1 /******************************************************************************
2 *
3 * Program: PostgreSQL plugin for Nagios
4 * License: GPL
5 *
6 * License Information:
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 *
22 * $Id$
23 *
24 *****************************************************************************/
26 #define PROGNAME "check_pgsql"
27 #define REVISION "$Revision$"
28 #define COPYRIGHT "1999-2001"
29 #define AUTHOR "Karl DeBisschop"
30 #define EMAIL "kdebisschop@users.sourceforge.net"
31 #define SUMMARY "Tests to see if a PostgreSQL DBMS is accepting connections.\n"
33 #define OPTIONS "\
34 \[-c critical_time] [-w warning_time] [-t timeout] [-H host]\n\
35 [-P port] [-d database] [-l logname] [-p password]"
37 #define LONGOPTIONS "\
38 -c, --critical=INTEGER\n\
39 Exit STATE_CRITICAL if connection time exceeds threshold (default: %d)\n\
40 -w, --warning=INTEGER\n\
41 Exit STATE_WARNING if connection time exceeds threshold (default: %d)\n\
42 -t, --timeout=INTEGER\n\
43 Terminate test if timeout limit is exceeded (default: %d)\n\
44 -H, --hostname=STRING\n\
45 Name or numeric IP address of machine running backend\n\
46 -P, --port=INTEGER\n\
47 Port running backend (default: %s)\n\
48 -d, --database=STRING\n\
49 Database to check (default: %s)\n\
50 -l, --logname = STRING\n\
51 Login name of user\n\
52 -p, --password = STRING\n\
53 Password (BIG SECURITY ISSUE)\n"
55 #define DESCRIPTION "All parameters are optional.\n\
56 \n\
57 This plugin tests a PostgreSQL DBMS to determine whether it is active and\n\
58 accepting queries. In its current operation, it simply connects to the\n\
59 specified database, and then disconnects. If no database is specified, it\n\
60 connects to the template1 database, which is present in every functioning \n\
61 PostgreSQL DBMS.\n\
62 \n\
63 The plugin will connect to a local postmaster if no host is specified. To\n\
64 connect to a remote host, be sure that the remote postmaster accepts TCP/IP\n\
65 connections (start the postmaster with the -i option).\n\
66 \n\
67 Typically, the nagios user (unless the --logname option is used) should be\n\
68 able to connect to the database without a password. The plugin can also send\n\
69 a password, but no effort is made to obsure or encrypt the password.\n"
71 #define DEFAULT_DB "template1"
72 #define DEFAULT_HOST "127.0.0.1"
73 #define DEFAULT_PORT "5432"
74 #define DEFAULT_WARN 2
75 #define DEFAULT_CRIT 8
76 #define DEFAULT_TIMEOUT 30
78 #include "config.h"
79 #include "common.h"
80 #include "utils.h"
81 #include <netdb.h>
82 #include <libpq-fe.h>
84 int process_arguments (int, char **);
85 int validate_arguments (void);
86 void print_usage (void);
87 void print_help (void);
88 int is_pg_dbname (char *);
89 int is_pg_logname (char *);
91 char *pghost = NULL; /* host name of the backend server */
92 char *pgport = NULL; /* port of the backend server */
93 char default_port[4] = DEFAULT_PORT;
94 char *pgoptions = NULL;
95 char *pgtty = NULL;
96 char dbName[NAMEDATALEN] = DEFAULT_DB;
97 char *pguser = NULL;
98 char *pgpasswd = NULL;
99 int twarn = DEFAULT_WARN;
100 int tcrit = DEFAULT_CRIT;
102 PGconn *conn;
103 /*PGresult *res;*/
104 \f
106 /******************************************************************************
108 The (psuedo?)literate programming XML is contained within \@\@\- <XML> \-\@\@
109 tags in the comments. With in the tags, the XML is assembled sequentially.
110 You can define entities in tags. You also have all the #defines available as
111 entities.
113 Please note that all tags must be lowercase to use the DocBook XML DTD.
115 @@-<article>
117 <sect1>
118 <title>Quick Reference</title>
119 <!-- The refentry forms a manpage -->
120 <refentry>
121 <refmeta>
122 <manvolnum>5<manvolnum>
123 </refmeta>
124 <refnamdiv>
125 <refname>&PROGNAME;</refname>
126 <refpurpose>&SUMMARY;</refpurpose>
127 </refnamdiv>
128 </refentry>
129 </sect1>
131 <sect1>
132 <title>FAQ</title>
133 </sect1>
135 <sect1>
136 <title>Theory, Installation, and Operation</title>
138 <sect2>
139 <title>General Description</title>
140 <para>
141 &DESCRIPTION;
142 </para>
143 </sect2>
145 <sect2>
146 <title>Future Enhancements</title>
147 <para>ToDo List</para>
148 <itemizedlist>
149 <listitem>Add option to get password from a secured file rather than the command line</listitem>
150 <listitem>Add option to specify the query to execute</listitem>
151 </itemizedlist>
152 </sect2>
155 <sect2>
156 <title>Functions</title>
157 -@@
158 ******************************************************************************/
160 int
161 main (int argc, char **argv)
162 {
163 int elapsed_time;
165 /* begin, by setting the parameters for a backend connection if the
166 * parameters are null, then the system will try to use reasonable
167 * defaults by looking up environment variables or, failing that,
168 * using hardwired constants */
170 pgoptions = NULL; /* special options to start up the backend server */
171 pgtty = NULL; /* debugging tty for the backend server */
173 if (process_arguments (argc, argv) == ERROR)
174 usage ("Could not parse arguments");
176 /* Set signal handling and alarm */
177 if (signal (SIGALRM, timeout_alarm_handler) == SIG_ERR) {
178 printf ("Cannot catch SIGALRM");
179 return STATE_UNKNOWN;
180 }
181 alarm (timeout_interval);
183 /* make a connection to the database */
184 time (&start_time);
185 conn =
186 PQsetdbLogin (pghost, pgport, pgoptions, pgtty, dbName, pguser, pgpasswd);
187 time (&end_time);
188 elapsed_time = (int) (end_time - start_time);
190 /* check to see that the backend connection was successfully made */
191 if (PQstatus (conn) == CONNECTION_BAD) {
192 printf ("PGSQL: CRITICAL - no connection to '%s' (%s).\n", dbName,
193 PQerrorMessage (conn));
194 PQfinish (conn);
195 return STATE_CRITICAL;
196 }
197 else if (elapsed_time > tcrit) {
198 PQfinish (conn);
199 printf ("PGSQL: CRITICAL - database %s (%d sec.)\n", dbName,
200 elapsed_time);
201 return STATE_CRITICAL;
202 }
203 else if (elapsed_time > twarn) {
204 PQfinish (conn);
205 printf ("PGSQL: WARNING - database %s (%d sec.)\n", dbName, elapsed_time);
206 return STATE_WARNING;
207 }
208 else {
209 PQfinish (conn);
210 printf ("PGSQL: ok - database %s (%d sec.)\n", dbName, elapsed_time);
211 return STATE_OK;
212 }
213 }
214 \f
218 void
219 print_help (void)
220 {
221 print_revision (PROGNAME, REVISION);
222 printf
223 ("Copyright (c) %s %s <%s>\n\n%s\n",
224 COPYRIGHT, AUTHOR, EMAIL, SUMMARY);
225 print_usage ();
226 printf
227 ("\nOptions:\n" LONGOPTIONS "\n" DESCRIPTION "\n",
228 DEFAULT_WARN, DEFAULT_CRIT, DEFAULT_TIMEOUT, DEFAULT_PORT, DEFAULT_DB);
229 support ();
230 }
232 void
233 print_usage (void)
234 {
235 printf ("Usage:\n" " %s %s\n"
236 " %s (-h | --help) for detailed help\n"
237 " %s (-V | --version) for version information\n",
238 PROGNAME, OPTIONS, PROGNAME, PROGNAME);
239 }
240 \f
243 /* process command-line arguments */
244 int
245 process_arguments (int argc, char **argv)
246 {
247 int c;
249 #ifdef HAVE_GETOPT_H
250 int option_index = 0;
251 static struct option long_options[] = {
252 {"help", no_argument, 0, 'h'},
253 {"version", no_argument, 0, 'V'},
254 {"timeout", required_argument, 0, 't'},
255 {"critical", required_argument, 0, 'c'},
256 {"warning", required_argument, 0, 'w'},
257 {"hostname", required_argument, 0, 'H'},
258 {"logname", required_argument, 0, 'l'},
259 {"password", required_argument, 0, 'p'},
260 {"authorization", required_argument, 0, 'a'},
261 {"port", required_argument, 0, 'P'},
262 {"database", required_argument, 0, 'd'},
263 {0, 0, 0, 0}
264 };
265 #endif
267 while (1) {
268 #ifdef HAVE_GETOPT_H
269 c = getopt_long (argc, argv, "+?hVt:c:w:H:P:d:l:p:a:",
270 long_options, &option_index);
271 #else
272 c = getopt (argc, argv, "+?hVt:c:w:H:P:d:l:p:a:");
273 #endif
274 if (c == EOF)
275 break;
277 switch (c) {
278 case '?': /* usage */
279 usage2 ("Unknown argument", optarg);
280 case 'h': /* help */
281 print_help ();
282 exit (STATE_OK);
283 case 'V': /* version */
284 print_revision (PROGNAME, REVISION);
285 exit (STATE_OK);
286 case 't': /* timeout period */
287 if (!is_integer (optarg))
288 usage2 ("Timeout Interval must be an integer", optarg);
289 timeout_interval = atoi (optarg);
290 break;
291 case 'c': /* critical time threshold */
292 if (!is_integer (optarg))
293 usage2 ("Invalid critical threshold", optarg);
294 tcrit = atoi (optarg);
295 break;
296 case 'w': /* warning time threshold */
297 if (!is_integer (optarg))
298 usage2 ("Invalid critical threshold", optarg);
299 twarn = atoi (optarg);
300 break;
301 case 'H': /* host */
302 if (!is_host (optarg))
303 usage2 ("You gave an invalid host name", optarg);
304 pghost = optarg;
305 break;
306 case 'P': /* port */
307 if (!is_integer (optarg))
308 usage2 ("Port must be an integer", optarg);
309 pgport = optarg;
310 break;
311 case 'd': /* database name */
312 if (!is_pg_dbname (optarg))
313 usage2 ("Database name is not valid", optarg);
314 strncpy (dbName, optarg, NAMEDATALEN - 1);
315 dbName[NAMEDATALEN - 1] = 0;
316 break;
317 case 'l': /* login name */
318 if (!is_pg_logname (optarg))
319 usage2 ("user name is not valid", optarg);
320 pguser = optarg;
321 break;
322 case 'p': /* authentication password */
323 case 'a':
324 pgpasswd = optarg;
325 break;
326 }
327 }
329 return validate_arguments ();
330 }
333 /******************************************************************************
335 @@-
336 <sect3>
337 <title>validate_arguments</title>
339 <para>&PROTO_validate_arguments;</para>
341 <para>Given a database name, this function returns TRUE if the string
342 is a valid PostgreSQL database name, and returns false if it is
343 not.</para>
345 <para>Valid PostgreSQL database names are less than &NAMEDATALEN;
346 characters long and consist of letters, numbers, and underscores. The
347 first character cannot be a number, however.</para>
349 </sect3>
350 -@@
351 ******************************************************************************/
353 int
354 validate_arguments ()
355 {
356 return OK;
357 }
358 \f
361 /******************************************************************************
363 @@-
364 <sect3>
365 <title>is_pg_dbname</title>
367 <para>&PROTO_is_pg_dbname;</para>
369 <para>Given a database name, this function returns TRUE if the string
370 is a valid PostgreSQL database name, and returns false if it is
371 not.</para>
373 <para>Valid PostgreSQL database names are less than &NAMEDATALEN;
374 characters long and consist of letters, numbers, and underscores. The
375 first character cannot be a number, however.</para>
377 </sect3>
378 -@@
379 ******************************************************************************/
381 int
382 is_pg_dbname (char *dbname)
383 {
384 char txt[NAMEDATALEN];
385 char tmp[NAMEDATALEN];
386 if (strlen (dbname) > NAMEDATALEN - 1)
387 return (FALSE);
388 strncpy (txt, dbname, NAMEDATALEN - 1);
389 txt[NAMEDATALEN - 1] = 0;
390 if (sscanf (txt, "%[_a-zA-Z]%[^_a-zA-Z0-9]", tmp, tmp) == 1)
391 return (TRUE);
392 if (sscanf (txt, "%[_a-zA-Z]%[_a-zA-Z0-9]%[^_a-zA-Z0-9]", tmp, tmp, tmp) ==
393 2) return (TRUE);
394 return (FALSE);
395 }
397 /**
399 the tango program should eventually create an entity here based on the
400 function prototype
402 @@-
403 <sect3>
404 <title>is_pg_logname</title>
406 <para>&PROTO_is_pg_logname;</para>
408 <para>Given a username, this function returns TRUE if the string is a
409 valid PostgreSQL username, and returns false if it is not. Valid PostgreSQL
410 usernames are less than &NAMEDATALEN; characters long and consist of
411 letters, numbers, dashes, and underscores, plus possibly some other
412 characters.</para>
414 <para>Currently this function only checks string length. Additional checks
415 should be added.</para>
417 </sect3>
418 -@@
419 ******************************************************************************/
421 int
422 is_pg_logname (char *username)
423 {
424 if (strlen (username) > NAMEDATALEN - 1)
425 return (FALSE);
426 return (TRUE);
427 }
429 /******************************************************************************
430 @@-
431 </sect2>
432 </sect1>
433 </article>
434 -@@
435 ******************************************************************************/