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;
123 static char *def_queries[] = {
132 static int def_queries_num = STATIC_ARRAY_SIZE (def_queries);
134 static udb_query_t **queries = NULL;
135 static size_t queries_num = 0;
137 static c_psql_database_t *c_psql_database_new (const char *name)
139 c_psql_database_t *db;
141 db = (c_psql_database_t *)malloc (sizeof (*db));
143 log_err ("Out of memory.");
149 C_COMPLAIN_INIT (&db->conn_complaint);
151 db->proto_version = 0;
152 db->server_version = 0;
154 db->max_params_num = 0;
161 db->database = sstrdup (name);
169 db->krbsrvname = NULL;
173 } /* c_psql_database_new */
175 static void c_psql_database_delete (void *data)
177 c_psql_database_t *db = data;
185 sfree (db->database);
189 sfree (db->password);
193 sfree (db->krbsrvname);
197 } /* c_psql_database_delete */
199 static int c_psql_connect (c_psql_database_t *db)
202 char *buf = conninfo;
203 int buf_len = sizeof (conninfo);
209 status = ssnprintf (buf, buf_len, "dbname = '%s'", db->database);
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);
223 db->conn = PQconnectdb (conninfo);
224 db->proto_version = PQprotocolVersion (db->conn);
226 } /* c_psql_connect */
228 static int c_psql_check_connection (c_psql_database_t *db)
235 /* trigger c_release() */
236 if (0 == db->conn_complaint.interval)
237 db->conn_complaint.interval = 1;
243 PQclear (PQexec (db->conn, "SELECT 42;"));
245 if (CONNECTION_OK != PQstatus (db->conn)) {
248 /* trigger c_release() */
249 if (0 == db->conn_complaint.interval)
250 db->conn_complaint.interval = 1;
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));
259 db->proto_version = PQprotocolVersion (db->conn);
262 db->server_version = PQserverVersion (db->conn);
264 if (c_would_release (&db->conn_complaint)) {
268 server_host = PQhost (db->conn);
269 server_version = PQserverVersion (db->conn);
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));
280 if (3 > db->proto_version)
281 log_warn ("Protocol version %d does not support parameters.",
285 } /* c_psql_check_connection */
287 static PGresult *c_psql_exec_query_noparams (c_psql_database_t *db,
290 return PQexec (db->conn, udb_query_get_statement (q));
291 } /* c_psql_exec_query_noparams */
293 static PGresult *c_psql_exec_query_params (c_psql_database_t *db,
294 udb_query_t *q, c_psql_user_data_t *data)
296 char *params[db->max_params_num];
300 if ((data == NULL) || (data->params_num == 0))
301 return (c_psql_exec_query_noparams (db, q));
303 assert (db->max_params_num >= data->params_num);
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;
311 case C_PSQL_PARAM_DB:
312 params[i] = db->database;
314 case C_PSQL_PARAM_USER:
315 params[i] = db->user;
317 case C_PSQL_PARAM_INTERVAL:
318 ssnprintf (interval, sizeof (interval), "%i",
319 db->interval > 0 ? db->interval : interval_g);
320 params[i] = interval;
327 return PQexecParams (db->conn, udb_query_get_statement (q),
328 data->params_num, NULL,
329 (const char *const *) params,
330 NULL, NULL, /* return text data */ 0);
331 } /* c_psql_exec_query_params */
333 static int c_psql_exec_query (c_psql_database_t *db, udb_query_t *q)
337 c_psql_user_data_t *data;
342 char **column_values;
349 /* The user data may hold parameter information, but may be NULL. */
350 data = udb_query_get_user_data (q);
352 /* Versions up to `3' don't know how to handle parameters. */
353 if (3 <= db->proto_version)
354 res = c_psql_exec_query_params (db, q, data);
355 else if ((NULL == data) || (0 == data->params_num))
356 res = c_psql_exec_query_noparams (db, q);
358 log_err ("Connection to database \"%s\" does not support parameters "
359 "(protocol version %d) - cannot execute query \"%s\".",
360 db->database, db->proto_version,
361 udb_query_get_name (q));
366 column_values = NULL;
368 #define BAIL_OUT(status) \
369 sfree (column_names); \
370 sfree (column_values); \
374 if (PGRES_TUPLES_OK != PQresultStatus (res)) {
375 log_err ("Failed to execute SQL query: %s",
376 PQerrorMessage (db->conn));
377 log_info ("SQL query was: %s",
378 udb_query_get_statement (q));
382 rows_num = PQntuples (res);
387 column_num = PQnfields (res);
388 column_names = (char **) calloc (column_num, sizeof (char *));
389 if (NULL == column_names) {
390 log_err ("calloc failed.");
394 column_values = (char **) calloc (column_num, sizeof (char *));
395 if (NULL == column_values) {
396 log_err ("calloc failed.");
400 for (col = 0; col < column_num; ++col) {
401 /* Pointers returned by `PQfname' are freed by `PQclear' via
403 column_names[col] = PQfname (res, col);
404 if (NULL == column_names[col]) {
405 log_err ("Failed to resolve name of column %i.", col);
410 if (C_PSQL_IS_UNIX_DOMAIN_SOCKET (db->host)
411 || (0 == strcmp (db->host, "localhost")))
416 status = udb_query_prepare_result (q, host, "postgresql",
417 db->database, column_names, (size_t) column_num);
419 log_err ("udb_query_prepare_result failed with status %i.",
424 for (row = 0; row < rows_num; ++row) {
425 for (col = 0; col < column_num; ++col) {
426 /* Pointers returned by `PQgetvalue' are freed by `PQclear' via
428 column_values[col] = PQgetvalue (res, row, col);
429 if (NULL == column_values[col]) {
430 log_err ("Failed to get value at (row = %i, col = %i).",
436 /* check for an error */
437 if (col < column_num)
440 status = udb_query_handle_result (q, column_values);
442 log_err ("udb_query_handle_result failed with status %i.",
445 } /* for (row = 0; row < rows_num; ++row) */
449 } /* c_psql_exec_query */
451 static int c_psql_read (user_data_t *ud)
453 c_psql_database_t *db;
456 if ((ud == NULL) || (ud->data == NULL)) {
457 log_err ("c_psql_read: Invalid user data.");
463 assert (NULL != db->database);
465 if (0 != c_psql_check_connection (db))
468 for (i = 0; i < db->queries_num; ++i)
474 if ((0 != db->server_version)
475 && (udb_query_check_version (q, db->server_version) <= 0))
478 c_psql_exec_query (db, q);
483 static int c_psql_shutdown (void)
485 plugin_unregister_read_group ("postgresql");
487 udb_query_free (queries, queries_num);
492 } /* c_psql_shutdown */
494 static int config_set_s (char *name, char **var, const oconfig_item_t *ci)
496 if ((0 != ci->children_num) || (1 != ci->values_num)
497 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
498 log_err ("%s expects a single string argument.", name);
503 *var = sstrdup (ci->values[0].value.string);
507 static int config_set_i (char *name, int *var,
508 const oconfig_item_t *ci, int min)
512 if ((0 != ci->children_num) || (1 != ci->values_num)
513 || (OCONFIG_TYPE_NUMBER != ci->values[0].type)) {
514 log_err ("%s expects a single number argument.", name);
518 value = (int)ci->values[0].value.number;
521 log_err ("%s expects a number greater or equal to %i.", name, min);
529 static int config_query_param_add (udb_query_t *q, oconfig_item_t *ci)
531 c_psql_user_data_t *data;
532 const char *param_str;
536 data = udb_query_get_user_data (q);
538 data = (c_psql_user_data_t *) smalloc (sizeof (*data));
540 log_err ("Out of memory.");
543 memset (data, 0, sizeof (*data));
547 tmp = (c_psql_param_t *) realloc (data->params,
548 (data->params_num + 1) * sizeof (c_psql_param_t));
550 log_err ("Out of memory.");
555 param_str = ci->values[0].value.string;
556 if (0 == strcasecmp (param_str, "hostname"))
557 data->params[data->params_num] = C_PSQL_PARAM_HOST;
558 else if (0 == strcasecmp (param_str, "database"))
559 data->params[data->params_num] = C_PSQL_PARAM_DB;
560 else if (0 == strcasecmp (param_str, "username"))
561 data->params[data->params_num] = C_PSQL_PARAM_USER;
562 else if (0 == strcasecmp (param_str, "interval"))
563 data->params[data->params_num] = C_PSQL_PARAM_INTERVAL;
565 log_err ("Invalid parameter \"%s\".", param_str);
570 udb_query_set_user_data (q, data);
573 } /* config_query_param_add */
575 static int config_query_callback (udb_query_t *q, oconfig_item_t *ci)
577 if (0 == strcasecmp ("Param", ci->key))
578 return config_query_param_add (q, ci);
580 log_err ("Option not allowed within a Query block: `%s'", ci->key);
583 } /* config_query_callback */
585 static int c_psql_config_database (oconfig_item_t *ci)
587 c_psql_database_t *db;
589 char cb_name[DATA_MAX_NAME_LEN];
590 struct timespec cb_interval;
595 if ((1 != ci->values_num)
596 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
597 log_err ("<Database> expects a single string argument.");
601 memset (&ud, 0, sizeof (ud));
603 db = c_psql_database_new (ci->values[0].value.string);
605 for (i = 0; i < ci->children_num; ++i) {
606 oconfig_item_t *c = ci->children + i;
608 if (0 == strcasecmp (c->key, "Host"))
609 config_set_s ("Host", &db->host, c);
610 else if (0 == strcasecmp (c->key, "Port"))
611 config_set_s ("Port", &db->port, c);
612 else if (0 == strcasecmp (c->key, "User"))
613 config_set_s ("User", &db->user, c);
614 else if (0 == strcasecmp (c->key, "Password"))
615 config_set_s ("Password", &db->password, c);
616 else if (0 == strcasecmp (c->key, "SSLMode"))
617 config_set_s ("SSLMode", &db->sslmode, c);
618 else if (0 == strcasecmp (c->key, "KRBSrvName"))
619 config_set_s ("KRBSrvName", &db->krbsrvname, c);
620 else if (0 == strcasecmp (c->key, "Service"))
621 config_set_s ("Service", &db->service, c);
622 else if (0 == strcasecmp (c->key, "Query"))
623 udb_query_pick_from_list (c, queries, queries_num,
624 &db->queries, &db->queries_num);
625 else if (0 == strcasecmp (c->key, "Interval"))
626 config_set_i ("Interval", &db->interval, c, /* min = */ 1);
628 log_warn ("Ignoring unknown config key \"%s\".", c->key);
631 /* If no `Query' options were given, add the default queries.. */
632 if (db->queries_num == 0)
634 for (i = 0; i < def_queries_num; i++)
635 udb_query_pick_from_list_by_name (def_queries[i],
636 queries, queries_num,
637 &db->queries, &db->queries_num);
640 for (i = 0; (size_t)i < db->queries_num; ++i) {
641 c_psql_user_data_t *data;
642 data = udb_query_get_user_data (db->queries[i]);
643 if ((data != NULL) && (data->params_num > db->max_params_num))
644 db->max_params_num = data->params_num;
648 ud.free_func = c_psql_database_delete;
650 ssnprintf (cb_name, sizeof (cb_name), "postgresql-%s", db->database);
652 memset (&cb_interval, 0, sizeof (cb_interval));
653 if (db->interval > 0)
654 cb_interval.tv_sec = (time_t)db->interval;
656 plugin_register_complex_read ("postgresql", cb_name, c_psql_read,
657 /* interval = */ &cb_interval, &ud);
659 } /* c_psql_config_database */
661 static int c_psql_config (oconfig_item_t *ci)
663 static int have_def_config = 0;
667 if (0 == have_def_config) {
672 c = oconfig_parse_file (C_PSQL_DEFAULT_CONF);
674 log_err ("Failed to read default config ("C_PSQL_DEFAULT_CONF").");
679 log_err ("Default config ("C_PSQL_DEFAULT_CONF") did not define "
680 "any queries - please check your installation.");
683 for (i = 0; i < ci->children_num; ++i) {
684 oconfig_item_t *c = ci->children + i;
686 if (0 == strcasecmp (c->key, "Query"))
687 udb_query_create (&queries, &queries_num, c,
688 /* callback = */ config_query_callback,
689 /* legacy mode = */ 1);
690 else if (0 == strcasecmp (c->key, "Database"))
691 c_psql_config_database (c);
693 log_warn ("Ignoring unknown config key \"%s\".", c->key);
696 } /* c_psql_config */
698 void module_register (void)
700 plugin_register_complex_config ("postgresql", c_psql_config);
701 plugin_register_shutdown ("postgresql", c_psql_shutdown);
702 } /* module_register */
704 /* vim: set sw=4 ts=4 tw=78 noexpandtab : */