2 * collectd - src/postgresql.c
3 * Copyright (C) 2008, 2009 Sebastian Harl
4 * Copyright (C) 2009 Florian Forster
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.
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.
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
20 * Sebastian Harl <sh at tokkee.org>
21 * Florian Forster <octo at verplant.org>
25 * This module collects PostgreSQL database statistics.
31 #include "configfile.h"
34 #include "utils_db_query.h"
35 #include "utils_complain.h"
37 #include <pg_config_manual.h>
40 #define log_err(...) ERROR ("postgresql: " __VA_ARGS__)
41 #define log_warn(...) WARNING ("postgresql: " __VA_ARGS__)
42 #define log_info(...) INFO ("postgresql: " __VA_ARGS__)
44 #ifndef C_PSQL_DEFAULT_CONF
45 # define C_PSQL_DEFAULT_CONF PKGDATADIR "/postgresql_default.conf"
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
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); \
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
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)))
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
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." : ":", \
83 C_PSQL_PARAM_HOST = 1,
86 C_PSQL_PARAM_INTERVAL,
89 /* Parameter configuration. Stored as `user data' in the query objects. */
91 c_psql_param_t *params;
97 c_complain_t conn_complaint;
104 /* user configuration */
105 udb_query_t **queries;
121 static char *def_queries[] = {
130 static int def_queries_num = STATIC_ARRAY_SIZE (def_queries);
132 static udb_query_t **queries = NULL;
133 static size_t queries_num = 0;
135 static c_psql_database_t *c_psql_database_new (const char *name)
137 c_psql_database_t *db;
139 db = (c_psql_database_t *)malloc (sizeof (*db));
141 log_err ("Out of memory.");
147 C_COMPLAIN_INIT (&db->conn_complaint);
149 db->proto_version = 0;
150 db->server_version = 0;
152 db->max_params_num = 0;
157 db->database = sstrdup (name);
165 db->krbsrvname = NULL;
169 } /* c_psql_database_new */
171 static void c_psql_database_delete (void *data)
173 c_psql_database_t *db = data;
181 sfree (db->database);
185 sfree (db->password);
189 sfree (db->krbsrvname);
193 } /* c_psql_database_delete */
195 static int c_psql_connect (c_psql_database_t *db)
198 char *buf = conninfo;
199 int buf_len = sizeof (conninfo);
205 status = ssnprintf (buf, buf_len, "dbname = '%s'", db->database);
211 C_PSQL_PAR_APPEND (buf, buf_len, "host", db->host);
212 C_PSQL_PAR_APPEND (buf, buf_len, "port", db->port);
213 C_PSQL_PAR_APPEND (buf, buf_len, "user", db->user);
214 C_PSQL_PAR_APPEND (buf, buf_len, "password", db->password);
215 C_PSQL_PAR_APPEND (buf, buf_len, "sslmode", db->sslmode);
216 C_PSQL_PAR_APPEND (buf, buf_len, "krbsrvname", db->krbsrvname);
217 C_PSQL_PAR_APPEND (buf, buf_len, "service", db->service);
219 db->conn = PQconnectdb (conninfo);
220 db->proto_version = PQprotocolVersion (db->conn);
222 } /* c_psql_connect */
224 static int c_psql_check_connection (c_psql_database_t *db)
231 /* trigger c_release() */
232 if (0 == db->conn_complaint.interval)
233 db->conn_complaint.interval = 1;
239 PQclear (PQexec (db->conn, "SELECT 42;"));
241 if (CONNECTION_OK != PQstatus (db->conn)) {
244 /* trigger c_release() */
245 if (0 == db->conn_complaint.interval)
246 db->conn_complaint.interval = 1;
248 if (CONNECTION_OK != PQstatus (db->conn)) {
249 c_complain (LOG_ERR, &db->conn_complaint,
250 "Failed to connect to database %s: %s",
251 db->database, PQerrorMessage (db->conn));
255 db->proto_version = PQprotocolVersion (db->conn);
258 db->server_version = PQserverVersion (db->conn);
260 if (c_would_release (&db->conn_complaint)) {
264 server_host = PQhost (db->conn);
265 server_version = PQserverVersion (db->conn);
267 c_do_release (LOG_INFO, &db->conn_complaint,
268 "Successfully %sconnected to database %s (user %s) "
269 "at server %s%s%s (server version: %d.%d.%d, "
270 "protocol version: %d, pid: %d)", init ? "" : "re",
271 PQdb (db->conn), PQuser (db->conn),
272 C_PSQL_SOCKET3 (server_host, PQport (db->conn)),
273 C_PSQL_SERVER_VERSION3 (server_version),
274 db->proto_version, PQbackendPID (db->conn));
276 if (3 > db->proto_version)
277 log_warn ("Protocol version %d does not support parameters.",
281 } /* c_psql_check_connection */
283 static PGresult *c_psql_exec_query_noparams (c_psql_database_t *db,
286 return PQexec (db->conn, udb_query_get_statement (q));
287 } /* c_psql_exec_query_noparams */
289 static PGresult *c_psql_exec_query_params (c_psql_database_t *db,
290 udb_query_t *q, c_psql_user_data_t *data)
292 char *params[db->max_params_num];
296 if ((data == NULL) || (data->params_num == 0))
297 return (c_psql_exec_query_noparams (db, q));
299 assert (db->max_params_num >= data->params_num);
301 for (i = 0; i < data->params_num; ++i) {
302 switch (data->params[i]) {
303 case C_PSQL_PARAM_HOST:
304 params[i] = C_PSQL_IS_UNIX_DOMAIN_SOCKET (db->host)
305 ? "localhost" : db->host;
307 case C_PSQL_PARAM_DB:
308 params[i] = db->database;
310 case C_PSQL_PARAM_USER:
311 params[i] = db->user;
313 case C_PSQL_PARAM_INTERVAL:
314 ssnprintf (interval, sizeof (interval), "%i", interval_g);
315 params[i] = interval;
322 return PQexecParams (db->conn, udb_query_get_statement (q),
323 data->params_num, NULL,
324 (const char *const *) params,
325 NULL, NULL, /* return text data */ 0);
326 } /* c_psql_exec_query_params */
328 static int c_psql_exec_query (c_psql_database_t *db, udb_query_t *q)
332 c_psql_user_data_t *data;
337 char **column_values;
344 /* The user data may hold parameter information, but may be NULL. */
345 data = udb_query_get_user_data (q);
347 /* Versions up to `3' don't know how to handle parameters. */
348 if (3 <= db->proto_version)
349 res = c_psql_exec_query_params (db, q, data);
350 else if ((NULL == data) || (0 == data->params_num))
351 res = c_psql_exec_query_noparams (db, q);
353 log_err ("Connection to database \"%s\" does not support parameters "
354 "(protocol version %d) - cannot execute query \"%s\".",
355 db->database, db->proto_version,
356 udb_query_get_name (q));
361 column_values = NULL;
363 #define BAIL_OUT(status) \
364 sfree (column_names); \
365 sfree (column_values); \
369 if (PGRES_TUPLES_OK != PQresultStatus (res)) {
370 log_err ("Failed to execute SQL query: %s",
371 PQerrorMessage (db->conn));
372 log_info ("SQL query was: %s",
373 udb_query_get_statement (q));
377 rows_num = PQntuples (res);
382 column_num = PQnfields (res);
383 column_names = (char **) calloc (column_num, sizeof (char *));
384 if (NULL == column_names) {
385 log_err ("calloc failed.");
389 column_values = (char **) calloc (column_num, sizeof (char *));
390 if (NULL == column_values) {
391 log_err ("calloc failed.");
395 for (col = 0; col < column_num; ++col) {
396 /* Pointers returned by `PQfname' are freed by `PQclear' via
398 column_names[col] = PQfname (res, col);
399 if (NULL == column_names[col]) {
400 log_err ("Failed to resolve name of column %i.", col);
405 if (C_PSQL_IS_UNIX_DOMAIN_SOCKET (db->host)
406 || (0 == strcmp (db->host, "localhost")))
411 status = udb_query_prepare_result (q, host, "postgresql",
412 db->database, column_names, (size_t) column_num);
414 log_err ("udb_query_prepare_result failed with status %i.",
419 for (row = 0; row < rows_num; ++row) {
420 for (col = 0; col < column_num; ++col) {
421 /* Pointers returned by `PQgetvalue' are freed by `PQclear' via
423 column_values[col] = PQgetvalue (res, row, col);
424 if (NULL == column_values[col]) {
425 log_err ("Failed to get value at (row = %i, col = %i).",
431 /* check for an error */
432 if (col < column_num)
435 status = udb_query_handle_result (q, column_values);
437 log_err ("udb_query_handle_result failed with status %i.",
440 } /* for (row = 0; row < rows_num; ++row) */
444 } /* c_psql_exec_query */
446 static int c_psql_read (user_data_t *ud)
448 c_psql_database_t *db;
451 if ((ud == NULL) || (ud->data == NULL)) {
452 log_err ("c_psql_read: Invalid user data.");
458 assert (NULL != db->database);
460 if (0 != c_psql_check_connection (db))
463 for (i = 0; i < db->queries_num; ++i)
469 if ((0 != db->server_version)
470 && (udb_query_check_version (q, db->server_version) <= 0))
473 c_psql_exec_query (db, q);
478 static int c_psql_shutdown (void)
480 plugin_unregister_read_group ("postgresql");
482 udb_query_free (queries, queries_num);
487 } /* c_psql_shutdown */
489 static int config_set_s (char *name, char **var, const oconfig_item_t *ci)
491 if ((0 != ci->children_num) || (1 != ci->values_num)
492 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
493 log_err ("%s expects a single string argument.", name);
498 *var = sstrdup (ci->values[0].value.string);
502 static int config_query_param_add (udb_query_t *q, oconfig_item_t *ci)
504 c_psql_user_data_t *data;
505 const char *param_str;
509 data = udb_query_get_user_data (q);
511 data = (c_psql_user_data_t *) smalloc (sizeof (*data));
513 log_err ("Out of memory.");
516 memset (data, 0, sizeof (*data));
520 tmp = (c_psql_param_t *) realloc (data->params,
521 (data->params_num + 1) * sizeof (c_psql_param_t));
523 log_err ("Out of memory.");
528 param_str = ci->values[0].value.string;
529 if (0 == strcasecmp (param_str, "hostname"))
530 data->params[data->params_num] = C_PSQL_PARAM_HOST;
531 else if (0 == strcasecmp (param_str, "database"))
532 data->params[data->params_num] = C_PSQL_PARAM_DB;
533 else if (0 == strcasecmp (param_str, "username"))
534 data->params[data->params_num] = C_PSQL_PARAM_USER;
535 else if (0 == strcasecmp (param_str, "interval"))
536 data->params[data->params_num] = C_PSQL_PARAM_INTERVAL;
538 log_err ("Invalid parameter \"%s\".", param_str);
543 udb_query_set_user_data (q, data);
546 } /* config_query_param_add */
548 static int config_query_callback (udb_query_t *q, oconfig_item_t *ci)
550 if (0 == strcasecmp ("Param", ci->key))
551 return config_query_param_add (q, ci);
553 log_err ("Option not allowed within a Query block: `%s'", ci->key);
556 } /* config_query_callback */
558 static int c_psql_config_database (oconfig_item_t *ci)
560 c_psql_database_t *db;
562 char cb_name[DATA_MAX_NAME_LEN];
567 if ((1 != ci->values_num)
568 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
569 log_err ("<Database> expects a single string argument.");
573 memset (&ud, 0, sizeof (ud));
575 db = c_psql_database_new (ci->values[0].value.string);
577 for (i = 0; i < ci->children_num; ++i) {
578 oconfig_item_t *c = ci->children + i;
580 if (0 == strcasecmp (c->key, "Host"))
581 config_set_s ("Host", &db->host, c);
582 else if (0 == strcasecmp (c->key, "Port"))
583 config_set_s ("Port", &db->port, c);
584 else if (0 == strcasecmp (c->key, "User"))
585 config_set_s ("User", &db->user, c);
586 else if (0 == strcasecmp (c->key, "Password"))
587 config_set_s ("Password", &db->password, c);
588 else if (0 == strcasecmp (c->key, "SSLMode"))
589 config_set_s ("SSLMode", &db->sslmode, c);
590 else if (0 == strcasecmp (c->key, "KRBSrvName"))
591 config_set_s ("KRBSrvName", &db->krbsrvname, c);
592 else if (0 == strcasecmp (c->key, "Service"))
593 config_set_s ("Service", &db->service, c);
594 else if (0 == strcasecmp (c->key, "Query"))
595 udb_query_pick_from_list (c, queries, queries_num,
596 &db->queries, &db->queries_num);
598 log_warn ("Ignoring unknown config key \"%s\".", c->key);
601 /* If no `Query' options were given, add the default queries.. */
602 if (db->queries_num == 0)
604 for (i = 0; i < def_queries_num; i++)
605 udb_query_pick_from_list_by_name (def_queries[i],
606 queries, queries_num,
607 &db->queries, &db->queries_num);
610 for (i = 0; (size_t)i < db->queries_num; ++i) {
611 c_psql_user_data_t *data;
612 data = udb_query_get_user_data (db->queries[i]);
613 if ((data != NULL) && (data->params_num > db->max_params_num))
614 db->max_params_num = data->params_num;
618 ud.free_func = c_psql_database_delete;
620 ssnprintf (cb_name, sizeof (cb_name), "postgresql-%s", db->database);
622 plugin_register_complex_read ("postgresql", cb_name, c_psql_read,
623 /* interval = */ NULL, &ud);
625 } /* c_psql_config_database */
627 static int c_psql_config (oconfig_item_t *ci)
629 static int have_def_config = 0;
633 if (0 == have_def_config) {
638 c = oconfig_parse_file (C_PSQL_DEFAULT_CONF);
640 log_err ("Failed to read default config ("C_PSQL_DEFAULT_CONF").");
645 log_err ("Default config ("C_PSQL_DEFAULT_CONF") did not define "
646 "any queries - please check your installation.");
649 for (i = 0; i < ci->children_num; ++i) {
650 oconfig_item_t *c = ci->children + i;
652 if (0 == strcasecmp (c->key, "Query"))
653 udb_query_create (&queries, &queries_num, c,
654 /* callback = */ config_query_callback,
655 /* legacy mode = */ 1);
656 else if (0 == strcasecmp (c->key, "Database"))
657 c_psql_config_database (c);
659 log_warn ("Ignoring unknown config key \"%s\".", c->key);
662 } /* c_psql_config */
664 void module_register (void)
666 plugin_register_complex_config ("postgresql", c_psql_config);
667 plugin_register_shutdown ("postgresql", c_psql_shutdown);
668 } /* module_register */
670 /* vim: set sw=4 ts=4 tw=78 noexpandtab : */