postgresql plugin: Added the ``Interval'' config option.
[collectd.git] / src / postgresql.c
1 /**
2  * collectd - src/postgresql.c
3  * Copyright (C) 2008, 2009  Sebastian Harl
4  * Copyright (C) 2009        Florian Forster
5  *
6  * This program is free software; you can redistribute it and/or modify it
7  * under the terms of the GNU General Public License as published by the
8  * Free Software Foundation; only version 2 of the License is applicable.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with this program; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
18  *
19  * Authors:
20  *   Sebastian Harl <sh at tokkee.org>
21  *   Florian Forster <octo at verplant.org>
22  **/
23
24 /*
25  * This module collects PostgreSQL database statistics.
26  */
27
28 #include "collectd.h"
29 #include "common.h"
30
31 #include "configfile.h"
32 #include "plugin.h"
33
34 #include "utils_db_query.h"
35 #include "utils_complain.h"
36
37 #include <pg_config_manual.h>
38 #include <libpq-fe.h>
39
40 #define log_err(...) ERROR ("postgresql: " __VA_ARGS__)
41 #define log_warn(...) WARNING ("postgresql: " __VA_ARGS__)
42 #define log_info(...) INFO ("postgresql: " __VA_ARGS__)
43
44 #ifndef C_PSQL_DEFAULT_CONF
45 # define C_PSQL_DEFAULT_CONF PKGDATADIR "/postgresql_default.conf"
46 #endif
47
48 /* Appends the (parameter, value) pair to the string
49  * pointed to by 'buf' suitable to be used as argument
50  * for PQconnectdb(). If value equals NULL, the pair
51  * is ignored. */
52 #define C_PSQL_PAR_APPEND(buf, buf_len, parameter, value) \
53         if ((0 < (buf_len)) && (NULL != (value)) && ('\0' != *(value))) { \
54                 int s = ssnprintf (buf, buf_len, " %s = '%s'", parameter, value); \
55                 if (0 < s) { \
56                         buf     += s; \
57                         buf_len -= s; \
58                 } \
59         }
60
61 /* Returns the tuple (major, minor, patchlevel)
62  * for the given version number. */
63 #define C_PSQL_SERVER_VERSION3(server_version) \
64         (server_version) / 10000, \
65         (server_version) / 100 - (int)((server_version) / 10000) * 100, \
66         (server_version) - (int)((server_version) / 100) * 100
67
68 /* Returns true if the given host specifies a
69  * UNIX domain socket. */
70 #define C_PSQL_IS_UNIX_DOMAIN_SOCKET(host) \
71         ((NULL == (host)) || ('\0' == *(host)) || ('/' == *(host)))
72
73 /* Returns the tuple (host, delimiter, port) for a
74  * given (host, port) pair. Depending on the value of
75  * 'host' a UNIX domain socket or a TCP socket is
76  * assumed. */
77 #define C_PSQL_SOCKET3(host, port) \
78         ((NULL == (host)) || ('\0' == *(host))) ? DEFAULT_PGSOCKET_DIR : host, \
79         C_PSQL_IS_UNIX_DOMAIN_SOCKET (host) ? "/.s.PGSQL." : ":", \
80         port
81
82 typedef enum {
83         C_PSQL_PARAM_HOST = 1,
84         C_PSQL_PARAM_DB,
85         C_PSQL_PARAM_USER,
86         C_PSQL_PARAM_INTERVAL,
87 } c_psql_param_t;
88
89 /* Parameter configuration. Stored as `user data' in the query objects. */
90 typedef struct {
91         c_psql_param_t *params;
92         int             params_num;
93 } c_psql_user_data_t;
94
95 typedef struct {
96         PGconn      *conn;
97         c_complain_t conn_complaint;
98
99         int proto_version;
100         int server_version;
101
102         int max_params_num;
103
104         /* user configuration */
105         udb_query_t    **queries;
106         size_t           queries_num;
107
108         int interval;
109
110         char *host;
111         char *port;
112         char *database;
113         char *user;
114         char *password;
115
116         char *sslmode;
117
118         char *krbsrvname;
119
120         char *service;
121 } c_psql_database_t;
122
123 static char *def_queries[] = {
124         "backends",
125         "transactions",
126         "queries",
127         "query_plans",
128         "table_states",
129         "disk_io",
130         "disk_usage"
131 };
132 static int def_queries_num = STATIC_ARRAY_SIZE (def_queries);
133
134 static udb_query_t      **queries       = NULL;
135 static size_t             queries_num   = 0;
136
137 static c_psql_database_t *c_psql_database_new (const char *name)
138 {
139         c_psql_database_t *db;
140
141         db = (c_psql_database_t *)malloc (sizeof (*db));
142         if (NULL == db) {
143                 log_err ("Out of memory.");
144                 exit (5);
145         }
146
147         db->conn = NULL;
148
149         C_COMPLAIN_INIT (&db->conn_complaint);
150
151         db->proto_version = 0;
152         db->server_version = 0;
153
154         db->max_params_num = 0;
155
156         db->queries        = NULL;
157         db->queries_num    = 0;
158
159         db->interval   = 0;
160
161         db->database   = sstrdup (name);
162         db->host       = NULL;
163         db->port       = NULL;
164         db->user       = NULL;
165         db->password   = NULL;
166
167         db->sslmode    = NULL;
168
169         db->krbsrvname = NULL;
170
171         db->service    = NULL;
172         return db;
173 } /* c_psql_database_new */
174
175 static void c_psql_database_delete (void *data)
176 {
177         c_psql_database_t *db = data;
178
179         PQfinish (db->conn);
180         db->conn = NULL;
181
182         sfree (db->queries);
183         db->queries_num = 0;
184
185         sfree (db->database);
186         sfree (db->host);
187         sfree (db->port);
188         sfree (db->user);
189         sfree (db->password);
190
191         sfree (db->sslmode);
192
193         sfree (db->krbsrvname);
194
195         sfree (db->service);
196         return;
197 } /* c_psql_database_delete */
198
199 static int c_psql_connect (c_psql_database_t *db)
200 {
201         char  conninfo[4096];
202         char *buf     = conninfo;
203         int   buf_len = sizeof (conninfo);
204         int   status;
205
206         if (! db)
207                 return -1;
208
209         status = ssnprintf (buf, buf_len, "dbname = '%s'", db->database);
210         if (0 < status) {
211                 buf     += status;
212                 buf_len -= status;
213         }
214
215         C_PSQL_PAR_APPEND (buf, buf_len, "host",       db->host);
216         C_PSQL_PAR_APPEND (buf, buf_len, "port",       db->port);
217         C_PSQL_PAR_APPEND (buf, buf_len, "user",       db->user);
218         C_PSQL_PAR_APPEND (buf, buf_len, "password",   db->password);
219         C_PSQL_PAR_APPEND (buf, buf_len, "sslmode",    db->sslmode);
220         C_PSQL_PAR_APPEND (buf, buf_len, "krbsrvname", db->krbsrvname);
221         C_PSQL_PAR_APPEND (buf, buf_len, "service",    db->service);
222
223         db->conn = PQconnectdb (conninfo);
224         db->proto_version = PQprotocolVersion (db->conn);
225         return 0;
226 } /* c_psql_connect */
227
228 static int c_psql_check_connection (c_psql_database_t *db)
229 {
230         _Bool init = 0;
231
232         if (! db->conn) {
233                 init = 1;
234
235                 /* trigger c_release() */
236                 if (0 == db->conn_complaint.interval)
237                         db->conn_complaint.interval = 1;
238
239                 c_psql_connect (db);
240         }
241
242         /* "ping" */
243         PQclear (PQexec (db->conn, "SELECT 42;"));
244
245         if (CONNECTION_OK != PQstatus (db->conn)) {
246                 PQreset (db->conn);
247
248                 /* trigger c_release() */
249                 if (0 == db->conn_complaint.interval)
250                         db->conn_complaint.interval = 1;
251
252                 if (CONNECTION_OK != PQstatus (db->conn)) {
253                         c_complain (LOG_ERR, &db->conn_complaint,
254                                         "Failed to connect to database %s: %s",
255                                         db->database, PQerrorMessage (db->conn));
256                         return -1;
257                 }
258
259                 db->proto_version = PQprotocolVersion (db->conn);
260         }
261
262         db->server_version = PQserverVersion (db->conn);
263
264         if (c_would_release (&db->conn_complaint)) {
265                 char *server_host;
266                 int   server_version;
267
268                 server_host    = PQhost (db->conn);
269                 server_version = PQserverVersion (db->conn);
270
271                 c_do_release (LOG_INFO, &db->conn_complaint,
272                                 "Successfully %sconnected to database %s (user %s) "
273                                 "at server %s%s%s (server version: %d.%d.%d, "
274                                 "protocol version: %d, pid: %d)", init ? "" : "re",
275                                 PQdb (db->conn), PQuser (db->conn),
276                                 C_PSQL_SOCKET3 (server_host, PQport (db->conn)),
277                                 C_PSQL_SERVER_VERSION3 (server_version),
278                                 db->proto_version, PQbackendPID (db->conn));
279
280                 if (3 > db->proto_version)
281                         log_warn ("Protocol version %d does not support parameters.",
282                                         db->proto_version);
283         }
284         return 0;
285 } /* c_psql_check_connection */
286
287 static PGresult *c_psql_exec_query_noparams (c_psql_database_t *db,
288                 udb_query_t *q)
289 {
290         return PQexec (db->conn, udb_query_get_statement (q));
291 } /* c_psql_exec_query_noparams */
292
293 static PGresult *c_psql_exec_query_params (c_psql_database_t *db,
294                 udb_query_t *q, c_psql_user_data_t *data)
295 {
296         char *params[db->max_params_num];
297         char  interval[64];
298         int   i;
299
300         if ((data == NULL) || (data->params_num == 0))
301                 return (c_psql_exec_query_noparams (db, q));
302
303         assert (db->max_params_num >= data->params_num);
304
305         for (i = 0; i < data->params_num; ++i) {
306                 switch (data->params[i]) {
307                         case C_PSQL_PARAM_HOST:
308                                 params[i] = C_PSQL_IS_UNIX_DOMAIN_SOCKET (db->host)
309                                         ? "localhost" : db->host;
310                                 break;
311                         case C_PSQL_PARAM_DB:
312                                 params[i] = db->database;
313                                 break;
314                         case C_PSQL_PARAM_USER:
315                                 params[i] = db->user;
316                                 break;
317                         case C_PSQL_PARAM_INTERVAL:
318                                 ssnprintf (interval, sizeof (interval), "%i", interval_g);
319                                 params[i] = interval;
320                                 break;
321                         default:
322                                 assert (0);
323                 }
324         }
325
326         return PQexecParams (db->conn, udb_query_get_statement (q),
327                         data->params_num, NULL,
328                         (const char *const *) params,
329                         NULL, NULL, /* return text data */ 0);
330 } /* c_psql_exec_query_params */
331
332 static int c_psql_exec_query (c_psql_database_t *db, udb_query_t *q)
333 {
334         PGresult *res;
335
336         c_psql_user_data_t *data;
337
338         const char *host;
339
340         char **column_names;
341         char **column_values;
342         int    column_num;
343
344         int rows_num;
345         int status;
346         int row, col;
347
348         /* The user data may hold parameter information, but may be NULL. */
349         data = udb_query_get_user_data (q);
350
351         /* Versions up to `3' don't know how to handle parameters. */
352         if (3 <= db->proto_version)
353                 res = c_psql_exec_query_params (db, q, data);
354         else if ((NULL == data) || (0 == data->params_num))
355                 res = c_psql_exec_query_noparams (db, q);
356         else {
357                 log_err ("Connection to database \"%s\" does not support parameters "
358                                 "(protocol version %d) - cannot execute query \"%s\".",
359                                 db->database, db->proto_version,
360                                 udb_query_get_name (q));
361                 return -1;
362         }
363
364         column_names = NULL;
365         column_values = NULL;
366
367 #define BAIL_OUT(status) \
368         sfree (column_names); \
369         sfree (column_values); \
370         PQclear (res); \
371         return status
372
373         if (PGRES_TUPLES_OK != PQresultStatus (res)) {
374                 log_err ("Failed to execute SQL query: %s",
375                                 PQerrorMessage (db->conn));
376                 log_info ("SQL query was: %s",
377                                 udb_query_get_statement (q));
378                 BAIL_OUT (-1);
379         }
380
381         rows_num = PQntuples (res);
382         if (1 > rows_num) {
383                 BAIL_OUT (0);
384         }
385
386         column_num = PQnfields (res);
387         column_names = (char **) calloc (column_num, sizeof (char *));
388         if (NULL == column_names) {
389                 log_err ("calloc failed.");
390                 BAIL_OUT (-1);
391         }
392
393         column_values = (char **) calloc (column_num, sizeof (char *));
394         if (NULL == column_values) {
395                 log_err ("calloc failed.");
396                 BAIL_OUT (-1);
397         }
398         
399         for (col = 0; col < column_num; ++col) {
400                 /* Pointers returned by `PQfname' are freed by `PQclear' via
401                  * `BAIL_OUT'. */
402                 column_names[col] = PQfname (res, col);
403                 if (NULL == column_names[col]) {
404                         log_err ("Failed to resolve name of column %i.", col);
405                         BAIL_OUT (-1);
406                 }
407         }
408
409         if (C_PSQL_IS_UNIX_DOMAIN_SOCKET (db->host)
410                         || (0 == strcmp (db->host, "localhost")))
411                 host = hostname_g;
412         else
413                 host = db->host;
414
415         status = udb_query_prepare_result (q, host, "postgresql",
416                         db->database, column_names, (size_t) column_num);
417         if (0 != status) {
418                 log_err ("udb_query_prepare_result failed with status %i.",
419                                 status);
420                 BAIL_OUT (-1);
421         }
422
423         for (row = 0; row < rows_num; ++row) {
424                 for (col = 0; col < column_num; ++col) {
425                         /* Pointers returned by `PQgetvalue' are freed by `PQclear' via
426                          * `BAIL_OUT'. */
427                         column_values[col] = PQgetvalue (res, row, col);
428                         if (NULL == column_values[col]) {
429                                 log_err ("Failed to get value at (row = %i, col = %i).",
430                                                 row, col);
431                                 break;
432                         }
433                 }
434
435                 /* check for an error */
436                 if (col < column_num)
437                         continue;
438
439                 status = udb_query_handle_result (q, column_values);
440                 if (status != 0) {
441                         log_err ("udb_query_handle_result failed with status %i.",
442                                         status);
443                 }
444         } /* for (row = 0; row < rows_num; ++row) */
445
446         BAIL_OUT (0);
447 #undef BAIL_OUT
448 } /* c_psql_exec_query */
449
450 static int c_psql_read (user_data_t *ud)
451 {
452         c_psql_database_t *db;
453         int i;
454
455         if ((ud == NULL) || (ud->data == NULL)) {
456                 log_err ("c_psql_read: Invalid user data.");
457                 return -1;
458         }
459
460         db = ud->data;
461
462         assert (NULL != db->database);
463
464         if (0 != c_psql_check_connection (db))
465                 return -1;
466
467         for (i = 0; i < db->queries_num; ++i)
468         {
469                 udb_query_t *q;
470
471                 q = db->queries[i];
472
473                 if ((0 != db->server_version)
474                         && (udb_query_check_version (q, db->server_version) <= 0))
475                         return -1;
476
477                 c_psql_exec_query (db, q);
478         }
479         return 0;
480 } /* c_psql_read */
481
482 static int c_psql_shutdown (void)
483 {
484         plugin_unregister_read_group ("postgresql");
485
486         udb_query_free (queries, queries_num);
487         queries = NULL;
488         queries_num = 0;
489
490         return 0;
491 } /* c_psql_shutdown */
492
493 static int config_set_s (char *name, char **var, const oconfig_item_t *ci)
494 {
495         if ((0 != ci->children_num) || (1 != ci->values_num)
496                         || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
497                 log_err ("%s expects a single string argument.", name);
498                 return 1;
499         }
500
501         sfree (*var);
502         *var = sstrdup (ci->values[0].value.string);
503         return 0;
504 } /* config_set_s */
505
506 static int config_set_i (char *name, int *var,
507                 const oconfig_item_t *ci, int min)
508 {
509         int value;
510
511         if ((0 != ci->children_num) || (1 != ci->values_num)
512                         || (OCONFIG_TYPE_NUMBER != ci->values[0].type)) {
513                 log_err ("%s expects a single number argument.", name);
514                 return 1;
515         }
516
517         value = (int)ci->values[0].value.number;
518
519         if (value < min) {
520                 log_err ("%s expects a number greater or equal to %i.", name, min);
521                 return 1;
522         }
523
524         *var = value;
525         return 0;
526 } /* config_set_s */
527
528 static int config_query_param_add (udb_query_t *q, oconfig_item_t *ci)
529 {
530         c_psql_user_data_t *data;
531         const char *param_str;
532
533         c_psql_param_t *tmp;
534
535         data = udb_query_get_user_data (q);
536         if (NULL == data) {
537                 data = (c_psql_user_data_t *) smalloc (sizeof (*data));
538                 if (NULL == data) {
539                         log_err ("Out of memory.");
540                         return -1;
541                 }
542                 memset (data, 0, sizeof (*data));
543                 data->params = NULL;
544         }
545
546         tmp = (c_psql_param_t *) realloc (data->params,
547                         (data->params_num + 1) * sizeof (c_psql_param_t));
548         if (NULL == tmp) {
549                 log_err ("Out of memory.");
550                 return -1;
551         }
552         data->params = tmp;
553
554         param_str = ci->values[0].value.string;
555         if (0 == strcasecmp (param_str, "hostname"))
556                 data->params[data->params_num] = C_PSQL_PARAM_HOST;
557         else if (0 == strcasecmp (param_str, "database"))
558                 data->params[data->params_num] = C_PSQL_PARAM_DB;
559         else if (0 == strcasecmp (param_str, "username"))
560                 data->params[data->params_num] = C_PSQL_PARAM_USER;
561         else if (0 == strcasecmp (param_str, "interval"))
562                 data->params[data->params_num] = C_PSQL_PARAM_INTERVAL;
563         else {
564                 log_err ("Invalid parameter \"%s\".", param_str);
565                 return 1;
566         }
567
568         data->params_num++;
569         udb_query_set_user_data (q, data);
570
571         return (0);
572 } /* config_query_param_add */
573
574 static int config_query_callback (udb_query_t *q, oconfig_item_t *ci)
575 {
576         if (0 == strcasecmp ("Param", ci->key))
577                 return config_query_param_add (q, ci);
578
579         log_err ("Option not allowed within a Query block: `%s'", ci->key);
580
581         return (-1);
582 } /* config_query_callback */
583
584 static int c_psql_config_database (oconfig_item_t *ci)
585 {
586         c_psql_database_t *db;
587
588         char cb_name[DATA_MAX_NAME_LEN];
589         struct timespec cb_interval;
590         user_data_t ud;
591
592         int i;
593
594         if ((1 != ci->values_num)
595                         || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
596                 log_err ("<Database> expects a single string argument.");
597                 return 1;
598         }
599
600         memset (&ud, 0, sizeof (ud));
601
602         db = c_psql_database_new (ci->values[0].value.string);
603
604         for (i = 0; i < ci->children_num; ++i) {
605                 oconfig_item_t *c = ci->children + i;
606
607                 if (0 == strcasecmp (c->key, "Host"))
608                         config_set_s ("Host", &db->host, c);
609                 else if (0 == strcasecmp (c->key, "Port"))
610                         config_set_s ("Port", &db->port, c);
611                 else if (0 == strcasecmp (c->key, "User"))
612                         config_set_s ("User", &db->user, c);
613                 else if (0 == strcasecmp (c->key, "Password"))
614                         config_set_s ("Password", &db->password, c);
615                 else if (0 == strcasecmp (c->key, "SSLMode"))
616                         config_set_s ("SSLMode", &db->sslmode, c);
617                 else if (0 == strcasecmp (c->key, "KRBSrvName"))
618                         config_set_s ("KRBSrvName", &db->krbsrvname, c);
619                 else if (0 == strcasecmp (c->key, "Service"))
620                         config_set_s ("Service", &db->service, c);
621                 else if (0 == strcasecmp (c->key, "Query"))
622                         udb_query_pick_from_list (c, queries, queries_num,
623                                         &db->queries, &db->queries_num);
624                 else if (0 == strcasecmp (c->key, "Interval"))
625                         config_set_i ("Interval", &db->interval, c, /* min = */ 1);
626                 else
627                         log_warn ("Ignoring unknown config key \"%s\".", c->key);
628         }
629
630         /* If no `Query' options were given, add the default queries.. */
631         if (db->queries_num == 0)
632         {
633                 for (i = 0; i < def_queries_num; i++)
634                         udb_query_pick_from_list_by_name (def_queries[i],
635                                         queries, queries_num,
636                                         &db->queries, &db->queries_num);
637         }
638
639         for (i = 0; (size_t)i < db->queries_num; ++i) {
640                 c_psql_user_data_t *data;
641                 data = udb_query_get_user_data (db->queries[i]);
642                 if ((data != NULL) && (data->params_num > db->max_params_num))
643                         db->max_params_num = data->params_num;
644         }
645
646         ud.data = db;
647         ud.free_func = c_psql_database_delete;
648
649         ssnprintf (cb_name, sizeof (cb_name), "postgresql-%s", db->database);
650
651         memset (&cb_interval, 0, sizeof (cb_interval));
652         if (db->interval > 0)
653                 cb_interval.tv_sec = (time_t)db->interval;
654
655         plugin_register_complex_read ("postgresql", cb_name, c_psql_read,
656                         /* interval = */ &cb_interval, &ud);
657         return 0;
658 } /* c_psql_config_database */
659
660 static int c_psql_config (oconfig_item_t *ci)
661 {
662         static int have_def_config = 0;
663
664         int i;
665
666         if (0 == have_def_config) {
667                 oconfig_item_t *c;
668
669                 have_def_config = 1;
670
671                 c = oconfig_parse_file (C_PSQL_DEFAULT_CONF);
672                 if (NULL == c)
673                         log_err ("Failed to read default config ("C_PSQL_DEFAULT_CONF").");
674                 else
675                         c_psql_config (c);
676
677                 if (NULL == queries)
678                         log_err ("Default config ("C_PSQL_DEFAULT_CONF") did not define "
679                                         "any queries - please check your installation.");
680         }
681
682         for (i = 0; i < ci->children_num; ++i) {
683                 oconfig_item_t *c = ci->children + i;
684
685                 if (0 == strcasecmp (c->key, "Query"))
686                         udb_query_create (&queries, &queries_num, c,
687                                         /* callback = */ config_query_callback,
688                                         /* legacy mode = */ 1);
689                 else if (0 == strcasecmp (c->key, "Database"))
690                         c_psql_config_database (c);
691                 else
692                         log_warn ("Ignoring unknown config key \"%s\".", c->key);
693         }
694         return 0;
695 } /* c_psql_config */
696
697 void module_register (void)
698 {
699         plugin_register_complex_config ("postgresql", c_psql_config);
700         plugin_register_shutdown ("postgresql", c_psql_shutdown);
701 } /* module_register */
702
703 /* vim: set sw=4 ts=4 tw=78 noexpandtab : */