Code

check_pgsql: Determine connection time in µs-resolution.
[nagiosplug.git] / plugins / check_pgsql.c
index 0f6eda479dee2f5c0862f853e0111310f9dc0b47..4ab28eabeb07e7b4c9693e2b8bf374b14e9f9d24 100644 (file)
@@ -3,7 +3,7 @@
 * Nagios check_pgsql plugin
 * 
 * License: GPL
-* Copyright (c) 1999-2007 Nagios Plugins Development Team
+* Copyright (c) 1999-2011 Nagios Plugins Development Team
 * 
 * Description:
 * 
@@ -29,7 +29,7 @@
 *****************************************************************************/
 
 const char *progname = "check_pgsql";
-const char *copyright = "1999-2007";
+const char *copyright = "1999-2011";
 const char *email = "nagiosplug-devel@lists.sourceforge.net";
 
 #include "common.h"
@@ -42,6 +42,20 @@ const char *email = "nagiosplug-devel@lists.sourceforge.net";
 #define DEFAULT_DB "template1"
 #define DEFAULT_HOST "127.0.0.1"
 
+/* return the PSQL server version as a 3-tuple */
+#define PSQL_SERVER_VERSION3(server_version) \
+       (server_version) / 10000, \
+       (server_version) / 100 - (int)((server_version) / 10000) * 100, \
+       (server_version) - (int)((server_version) / 100) * 100
+/* return true if the given host is a UNIX domain socket */
+#define PSQL_IS_UNIX_DOMAIN_SOCKET(host) \
+       ((NULL == (host)) || ('\0' == *(host)) || ('/' == *(host)))
+/* return a 3-tuple identifying a host/port independent of the socket type */
+#define PSQL_SOCKET3(host, port) \
+       ((NULL == (host)) || ('\0' == *(host))) ? DEFAULT_PGSOCKET_DIR : host, \
+       PSQL_IS_UNIX_DOMAIN_SOCKET (host) ? "/.s.PGSQL." : ":", \
+       port
+
 enum {
        DEFAULT_PORT = 5432,
        DEFAULT_WARN = 2,
@@ -66,6 +80,7 @@ char *pgtty = NULL;
 char dbName[NAMEDATALEN] = DEFAULT_DB;
 char *pguser = NULL;
 char *pgpasswd = NULL;
+char *pgparams = NULL;
 double twarn = (double)DEFAULT_WARN;
 double tcrit = (double)DEFAULT_CRIT;
 char *pgquery = NULL;
@@ -116,9 +131,6 @@ Please note that all tags must be lowercase to use the DocBook XML DTD.
 <sect2>
 <title>Future Enhancements</title>
 <para>ToDo List</para>
-<itemizedlist>
-<listitem>Add option to get password from a secured file rather than the command line</listitem>
-</itemizedlist>
 </sect2>
 
 
@@ -133,8 +145,11 @@ int
 main (int argc, char **argv)
 {
        PGconn *conn;
+       char *conninfo = NULL;
 
-       int elapsed_time;
+       struct timeval start_timeval;
+       struct timeval end_timeval;
+       double elapsed_time;
        int status = STATE_UNKNOWN;
        int query_status = STATE_UNKNOWN;
 
@@ -164,20 +179,41 @@ main (int argc, char **argv)
        }
        alarm (timeout_interval);
 
-       if (verbose)
-               printf("Connecting to database:\n DB: %s\n User: %s\n Host: %s\n Port: %d\n", dbName,
-               (pguser != NULL) ? pguser : "unspecified",
-               (pghost != NULL) ? pghost : "unspecified",
-               (pgport != NULL) ? atoi(pgport) : DEFAULT_PORT);
+       if (pgparams)
+               asprintf (&conninfo, "%s ", pgparams);
+
+       asprintf (&conninfo, "%sdbname = '%s'", conninfo ? conninfo : "", dbName);
+       if (pghost)
+               asprintf (&conninfo, "%s host = '%s'", conninfo, pghost);
+       if (pgport)
+               asprintf (&conninfo, "%s port = '%s'", conninfo, pgport);
+       if (pgoptions)
+               asprintf (&conninfo, "%s options = '%s'", conninfo, pgoptions);
+       /* if (pgtty) -- ignored by PQconnectdb */
+       if (pguser)
+               asprintf (&conninfo, "%s user = '%s'", conninfo, pguser);
+
+       if (verbose) /* do not include password (see right below) in output */
+               printf ("Connecting to PostgreSQL using conninfo: %s%s\n", conninfo,
+                               pgpasswd ? " password = <hidden>" : "");
+
+       if (pgpasswd)
+               asprintf (&conninfo, "%s password = '%s'", conninfo, pgpasswd);
 
        /* make a connection to the database */
-       time (&start_time);
-       conn =
-               PQsetdbLogin (pghost, pgport, pgoptions, pgtty, dbName, pguser, pgpasswd);
-       time (&end_time);
-       elapsed_time = (int) (end_time - start_time);
+       gettimeofday (&start_timeval, NULL);
+       conn = PQconnectdb (conninfo);
+       gettimeofday (&end_timeval, NULL);
+
+       while (start_timeval.tv_usec > end_timeval.tv_usec) {
+               --end_timeval.tv_sec;
+               end_timeval.tv_usec += 1000000;
+       }
+       elapsed_time = (double)(end_timeval.tv_sec - start_timeval.tv_sec)
+               + (double)(end_timeval.tv_usec - start_timeval.tv_usec) / 1000000.0;
+
        if (verbose)
-               printf("Time elapsed: %d\n", elapsed_time);
+               printf("Time elapsed: %f\n", elapsed_time);
 
        /* check to see that the backend connection was successfully made */
        if (verbose)
@@ -197,10 +233,24 @@ main (int argc, char **argv)
        else {
                status = STATE_OK;
        }
-       printf (_(" %s - database %s (%d sec.)|%s\n"),
+
+       if (verbose) {
+               char *server_host = PQhost (conn);
+               int server_version = PQserverVersion (conn);
+
+               printf ("Successfully connected to database %s (user %s) "
+                               "at server %s%s%s (server version: %d.%d.%d, "
+                               "protocol version: %d, pid: %d)\n",
+                               PQdb (conn), PQuser (conn),
+                               PSQL_SOCKET3 (server_host, PQport (conn)),
+                               PSQL_SERVER_VERSION3 (server_version),
+                               PQprotocolVersion (conn), PQbackendPID (conn));
+       }
+
+       printf (_(" %s - database %s (%f sec.)|%s\n"),
                state_text(status), dbName, elapsed_time,
                fperfdata("time", elapsed_time, "s",
-                        (int)twarn, twarn, (int)tcrit, tcrit, TRUE, 0, FALSE,0));
+                        !!(twarn > 0.0), twarn, !!(tcrit > 0.0), tcrit, TRUE, 0, FALSE,0));
 
        if (pgquery)
                query_status = do_query (conn, pgquery);
@@ -232,6 +282,7 @@ process_arguments (int argc, char **argv)
                {"authorization", required_argument, 0, 'a'},
                {"port", required_argument, 0, 'P'},
                {"database", required_argument, 0, 'd'},
+               {"option", required_argument, 0, 'o'},
                {"query", required_argument, 0, 'q'},
                {"query_critical", required_argument, 0, 'C'},
                {"query_warning", required_argument, 0, 'W'},
@@ -240,7 +291,7 @@ process_arguments (int argc, char **argv)
        };
 
        while (1) {
-               c = getopt_long (argc, argv, "hVt:c:w:H:P:d:l:p:a:q:C:W:v",
+               c = getopt_long (argc, argv, "hVt:c:w:H:P:d:l:p:a:o:q:C:W:v",
                                 longopts, &option);
 
                if (c == EOF)
@@ -280,7 +331,7 @@ process_arguments (int argc, char **argv)
                        query_warning = optarg;
                        break;
                case 'H':     /* host */
-                       if (!is_host (optarg))
+                       if ((*optarg != '/') && (!is_host (optarg)))
                                usage2 (_("Invalid hostname/address"), optarg);
                        else
                                pghost = optarg;
@@ -307,6 +358,12 @@ process_arguments (int argc, char **argv)
                case 'a':
                        pgpasswd = optarg;
                        break;
+               case 'o':
+                       if (pgparams)
+                               asprintf (&pgparams, "%s %s", pgparams, optarg);
+                       else
+                               asprintf (&pgparams, "%s", optarg);
+                       break;
                case 'q':
                        pgquery = optarg;
                        break;
@@ -455,8 +512,6 @@ print_help (void)
 
        printf (UT_HOST_PORT, 'P', myport);
 
-       printf (UT_IPv46);
-
        printf (" %s\n", "-d, --database=STRING");
        printf ("    %s", _("Database to check "));
        printf (_("(default: %s)"), DEFAULT_DB);
@@ -464,6 +519,8 @@ print_help (void)
        printf ("    %s\n", _("Login name of user"));
        printf (" %s\n", "-p, --password = STRING");
        printf ("    %s\n", _("Password (BIG SECURITY ISSUE)"));
+       printf (" %s\n", "-o, --option = STRING");
+       printf ("    %s\n", _("Connection parameters (keyword = value), see below"));
 
        printf (UT_WARN_CRIT);
 
@@ -495,6 +552,13 @@ print_help (void)
        printf (" %s\n", _("See the chapter \"Monitoring Database Activity\" of the PostgreSQL manual"));
        printf (" %s\n\n", _("for details about how to access internal statistics of the database server."));
 
+       printf (" %s\n", _("For a list of available connection parameters which may be used with the -o"));
+       printf (" %s\n", _("command line option, see the documentation for PQconnectdb() in the chapter"));
+       printf (" %s\n", _("\"libpq - C Library\" of the PostgreSQL manual. For example, this may be"));
+       printf (" %s\n", _("used to specify a service name in pg_service.conf to be used for additional"));
+       printf (" %s\n", _("connection parameters: -o 'service=<name>' or to specify the SSL mode:"));
+       printf (" %s\n\n", _("-o 'sslmode=require'."));
+
        printf (" %s\n", _("The plugin will connect to a local postmaster if no host is specified. To"));
        printf (" %s\n", _("connect to a remote host, be sure that the remote postmaster accepts TCP/IP"));
        printf (" %s\n\n", _("connections (start the postmaster with the -i option)."));
@@ -578,7 +642,7 @@ do_query (PGconn *conn, char *query)
                                                ? _("CRITICAL")
                                                : _("UNKNOWN"));
        printf (_("'%s' returned %f"), query, value);
-       printf ("|query=%f;%s;%s;0\n", value,
+       printf ("|query=%f;%s;%s;;\n", value,
                        query_warning ? query_warning : "",
                        query_critical ? query_critical : "");
        return my_status;