2 * collectd - src/postgresql.c
3 * Copyright (C) 2008, 2009 Sebastian Harl
4 * Copyright (C) 2009 Florian Forster
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * - Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
14 * - Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGE.
31 * Sebastian Harl <sh at tokkee.org>
32 * Florian Forster <octo at verplant.org>
36 * This module collects PostgreSQL database statistics.
42 #include "configfile.h"
45 #include "utils_db_query.h"
46 #include "utils_complain.h"
48 #include <pg_config_manual.h>
51 #define log_err(...) ERROR ("postgresql: " __VA_ARGS__)
52 #define log_warn(...) WARNING ("postgresql: " __VA_ARGS__)
53 #define log_info(...) INFO ("postgresql: " __VA_ARGS__)
55 #ifndef C_PSQL_DEFAULT_CONF
56 # define C_PSQL_DEFAULT_CONF PKGDATADIR "/postgresql_default.conf"
59 /* Appends the (parameter, value) pair to the string
60 * pointed to by 'buf' suitable to be used as argument
61 * for PQconnectdb(). If value equals NULL, the pair
63 #define C_PSQL_PAR_APPEND(buf, buf_len, parameter, value) \
64 if ((0 < (buf_len)) && (NULL != (value)) && ('\0' != *(value))) { \
65 int s = ssnprintf (buf, buf_len, " %s = '%s'", parameter, value); \
72 /* Returns the tuple (major, minor, patchlevel)
73 * for the given version number. */
74 #define C_PSQL_SERVER_VERSION3(server_version) \
75 (server_version) / 10000, \
76 (server_version) / 100 - (int)((server_version) / 10000) * 100, \
77 (server_version) - (int)((server_version) / 100) * 100
79 /* Returns true if the given host specifies a
80 * UNIX domain socket. */
81 #define C_PSQL_IS_UNIX_DOMAIN_SOCKET(host) \
82 ((NULL == (host)) || ('\0' == *(host)) || ('/' == *(host)))
84 /* Returns the tuple (host, delimiter, port) for a
85 * given (host, port) pair. Depending on the value of
86 * 'host' a UNIX domain socket or a TCP socket is
88 #define C_PSQL_SOCKET3(host, port) \
89 ((NULL == (host)) || ('\0' == *(host))) ? DEFAULT_PGSOCKET_DIR : host, \
90 C_PSQL_IS_UNIX_DOMAIN_SOCKET (host) ? "/.s.PGSQL." : ":", \
94 C_PSQL_PARAM_HOST = 1,
97 C_PSQL_PARAM_INTERVAL,
100 /* Parameter configuration. Stored as `user data' in the query objects. */
102 c_psql_param_t *params;
104 } c_psql_user_data_t;
108 c_complain_t conn_complaint;
115 /* user configuration */
116 udb_query_preparation_area_t **q_prep_areas;
117 udb_query_t **queries;
135 static char *def_queries[] = {
144 static int def_queries_num = STATIC_ARRAY_SIZE (def_queries);
146 static udb_query_t **queries = NULL;
147 static size_t queries_num = 0;
149 static c_psql_database_t *c_psql_database_new (const char *name)
151 c_psql_database_t *db;
153 db = (c_psql_database_t *)malloc (sizeof (*db));
155 log_err ("Out of memory.");
161 C_COMPLAIN_INIT (&db->conn_complaint);
163 db->proto_version = 0;
164 db->server_version = 0;
166 db->max_params_num = 0;
168 db->q_prep_areas = NULL;
174 db->database = sstrdup (name);
182 db->krbsrvname = NULL;
186 } /* c_psql_database_new */
188 static void c_psql_database_delete (void *data)
192 c_psql_database_t *db = data;
197 if (db->q_prep_areas)
198 for (i = 0; i < db->queries_num; ++i)
199 udb_query_delete_preparation_area (db->q_prep_areas[i]);
200 free (db->q_prep_areas);
205 sfree (db->database);
209 sfree (db->password);
213 sfree (db->krbsrvname);
217 } /* c_psql_database_delete */
219 static int c_psql_connect (c_psql_database_t *db)
222 char *buf = conninfo;
223 int buf_len = sizeof (conninfo);
229 status = ssnprintf (buf, buf_len, "dbname = '%s'", db->database);
235 C_PSQL_PAR_APPEND (buf, buf_len, "host", db->host);
236 C_PSQL_PAR_APPEND (buf, buf_len, "port", db->port);
237 C_PSQL_PAR_APPEND (buf, buf_len, "user", db->user);
238 C_PSQL_PAR_APPEND (buf, buf_len, "password", db->password);
239 C_PSQL_PAR_APPEND (buf, buf_len, "sslmode", db->sslmode);
240 C_PSQL_PAR_APPEND (buf, buf_len, "krbsrvname", db->krbsrvname);
241 C_PSQL_PAR_APPEND (buf, buf_len, "service", db->service);
243 db->conn = PQconnectdb (conninfo);
244 db->proto_version = PQprotocolVersion (db->conn);
246 } /* c_psql_connect */
248 static int c_psql_check_connection (c_psql_database_t *db)
255 /* trigger c_release() */
256 if (0 == db->conn_complaint.interval)
257 db->conn_complaint.interval = 1;
263 PQclear (PQexec (db->conn, "SELECT 42;"));
265 if (CONNECTION_OK != PQstatus (db->conn)) {
268 /* trigger c_release() */
269 if (0 == db->conn_complaint.interval)
270 db->conn_complaint.interval = 1;
272 if (CONNECTION_OK != PQstatus (db->conn)) {
273 c_complain (LOG_ERR, &db->conn_complaint,
274 "Failed to connect to database %s: %s",
275 db->database, PQerrorMessage (db->conn));
279 db->proto_version = PQprotocolVersion (db->conn);
282 db->server_version = PQserverVersion (db->conn);
284 if (c_would_release (&db->conn_complaint)) {
288 server_host = PQhost (db->conn);
289 server_version = PQserverVersion (db->conn);
291 c_do_release (LOG_INFO, &db->conn_complaint,
292 "Successfully %sconnected to database %s (user %s) "
293 "at server %s%s%s (server version: %d.%d.%d, "
294 "protocol version: %d, pid: %d)", init ? "" : "re",
295 PQdb (db->conn), PQuser (db->conn),
296 C_PSQL_SOCKET3 (server_host, PQport (db->conn)),
297 C_PSQL_SERVER_VERSION3 (server_version),
298 db->proto_version, PQbackendPID (db->conn));
300 if (3 > db->proto_version)
301 log_warn ("Protocol version %d does not support parameters.",
305 } /* c_psql_check_connection */
307 static PGresult *c_psql_exec_query_noparams (c_psql_database_t *db,
310 return PQexec (db->conn, udb_query_get_statement (q));
311 } /* c_psql_exec_query_noparams */
313 static PGresult *c_psql_exec_query_params (c_psql_database_t *db,
314 udb_query_t *q, c_psql_user_data_t *data)
316 char *params[db->max_params_num];
320 if ((data == NULL) || (data->params_num == 0))
321 return (c_psql_exec_query_noparams (db, q));
323 assert (db->max_params_num >= data->params_num);
325 for (i = 0; i < data->params_num; ++i) {
326 switch (data->params[i]) {
327 case C_PSQL_PARAM_HOST:
328 params[i] = C_PSQL_IS_UNIX_DOMAIN_SOCKET (db->host)
329 ? "localhost" : db->host;
331 case C_PSQL_PARAM_DB:
332 params[i] = db->database;
334 case C_PSQL_PARAM_USER:
335 params[i] = db->user;
337 case C_PSQL_PARAM_INTERVAL:
338 ssnprintf (interval, sizeof (interval), "%.3f",
340 ? CDTIME_T_TO_DOUBLE (db->interval) : interval_g);
341 params[i] = interval;
348 return PQexecParams (db->conn, udb_query_get_statement (q),
349 data->params_num, NULL,
350 (const char *const *) params,
351 NULL, NULL, /* return text data */ 0);
352 } /* c_psql_exec_query_params */
354 static int c_psql_exec_query (c_psql_database_t *db, udb_query_t *q,
355 udb_query_preparation_area_t *prep_area)
359 c_psql_user_data_t *data;
364 char **column_values;
371 /* The user data may hold parameter information, but may be NULL. */
372 data = udb_query_get_user_data (q);
374 /* Versions up to `3' don't know how to handle parameters. */
375 if (3 <= db->proto_version)
376 res = c_psql_exec_query_params (db, q, data);
377 else if ((NULL == data) || (0 == data->params_num))
378 res = c_psql_exec_query_noparams (db, q);
380 log_err ("Connection to database \"%s\" does not support parameters "
381 "(protocol version %d) - cannot execute query \"%s\".",
382 db->database, db->proto_version,
383 udb_query_get_name (q));
388 column_values = NULL;
390 #define BAIL_OUT(status) \
391 sfree (column_names); \
392 sfree (column_values); \
396 if (PGRES_TUPLES_OK != PQresultStatus (res)) {
397 log_err ("Failed to execute SQL query: %s",
398 PQerrorMessage (db->conn));
399 log_info ("SQL query was: %s",
400 udb_query_get_statement (q));
404 rows_num = PQntuples (res);
409 column_num = PQnfields (res);
410 column_names = (char **) calloc (column_num, sizeof (char *));
411 if (NULL == column_names) {
412 log_err ("calloc failed.");
416 column_values = (char **) calloc (column_num, sizeof (char *));
417 if (NULL == column_values) {
418 log_err ("calloc failed.");
422 for (col = 0; col < column_num; ++col) {
423 /* Pointers returned by `PQfname' are freed by `PQclear' via
425 column_names[col] = PQfname (res, col);
426 if (NULL == column_names[col]) {
427 log_err ("Failed to resolve name of column %i.", col);
432 if (C_PSQL_IS_UNIX_DOMAIN_SOCKET (db->host)
433 || (0 == strcmp (db->host, "localhost")))
438 status = udb_query_prepare_result (q, prep_area, host, "postgresql",
439 db->database, column_names, (size_t) column_num, db->interval);
441 log_err ("udb_query_prepare_result failed with status %i.",
446 for (row = 0; row < rows_num; ++row) {
447 for (col = 0; col < column_num; ++col) {
448 /* Pointers returned by `PQgetvalue' are freed by `PQclear' via
450 column_values[col] = PQgetvalue (res, row, col);
451 if (NULL == column_values[col]) {
452 log_err ("Failed to get value at (row = %i, col = %i).",
458 /* check for an error */
459 if (col < column_num)
462 status = udb_query_handle_result (q, prep_area, column_values);
464 log_err ("udb_query_handle_result failed with status %i.",
467 } /* for (row = 0; row < rows_num; ++row) */
469 udb_query_finish_result (q, prep_area);
473 } /* c_psql_exec_query */
475 static int c_psql_read (user_data_t *ud)
477 c_psql_database_t *db;
482 if ((ud == NULL) || (ud->data == NULL)) {
483 log_err ("c_psql_read: Invalid user data.");
489 assert (NULL != db->database);
491 if (0 != c_psql_check_connection (db))
494 for (i = 0; i < db->queries_num; ++i)
496 udb_query_preparation_area_t *prep_area;
499 prep_area = db->q_prep_areas[i];
502 if ((0 != db->server_version)
503 && (udb_query_check_version (q, db->server_version) <= 0))
506 if (0 == c_psql_exec_query (db, q, prep_area))
515 static int c_psql_shutdown (void)
517 plugin_unregister_read_group ("postgresql");
519 udb_query_free (queries, queries_num);
524 } /* c_psql_shutdown */
526 static int config_query_param_add (udb_query_t *q, oconfig_item_t *ci)
528 c_psql_user_data_t *data;
529 const char *param_str;
533 data = udb_query_get_user_data (q);
535 data = (c_psql_user_data_t *) smalloc (sizeof (*data));
537 log_err ("Out of memory.");
540 memset (data, 0, sizeof (*data));
544 tmp = (c_psql_param_t *) realloc (data->params,
545 (data->params_num + 1) * sizeof (c_psql_param_t));
547 log_err ("Out of memory.");
552 param_str = ci->values[0].value.string;
553 if (0 == strcasecmp (param_str, "hostname"))
554 data->params[data->params_num] = C_PSQL_PARAM_HOST;
555 else if (0 == strcasecmp (param_str, "database"))
556 data->params[data->params_num] = C_PSQL_PARAM_DB;
557 else if (0 == strcasecmp (param_str, "username"))
558 data->params[data->params_num] = C_PSQL_PARAM_USER;
559 else if (0 == strcasecmp (param_str, "interval"))
560 data->params[data->params_num] = C_PSQL_PARAM_INTERVAL;
562 log_err ("Invalid parameter \"%s\".", param_str);
567 udb_query_set_user_data (q, data);
570 } /* config_query_param_add */
572 static int config_query_callback (udb_query_t *q, oconfig_item_t *ci)
574 if (0 == strcasecmp ("Param", ci->key))
575 return config_query_param_add (q, ci);
577 log_err ("Option not allowed within a Query block: `%s'", ci->key);
580 } /* config_query_callback */
582 static int c_psql_config_database (oconfig_item_t *ci)
584 c_psql_database_t *db;
586 char cb_name[DATA_MAX_NAME_LEN];
587 struct timespec cb_interval = { 0, 0 };
592 if ((1 != ci->values_num)
593 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
594 log_err ("<Database> expects a single string argument.");
598 memset (&ud, 0, sizeof (ud));
600 db = c_psql_database_new (ci->values[0].value.string);
604 for (i = 0; i < ci->children_num; ++i) {
605 oconfig_item_t *c = ci->children + i;
607 if (0 == strcasecmp (c->key, "Host"))
608 cf_util_get_string (c, &db->host);
609 else if (0 == strcasecmp (c->key, "Port"))
610 cf_util_get_service (c, &db->port);
611 else if (0 == strcasecmp (c->key, "User"))
612 cf_util_get_string (c, &db->user);
613 else if (0 == strcasecmp (c->key, "Password"))
614 cf_util_get_string (c, &db->password);
615 else if (0 == strcasecmp (c->key, "SSLMode"))
616 cf_util_get_string (c, &db->sslmode);
617 else if (0 == strcasecmp (c->key, "KRBSrvName"))
618 cf_util_get_string (c, &db->krbsrvname);
619 else if (0 == strcasecmp (c->key, "Service"))
620 cf_util_get_string (c, &db->service);
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 cf_util_get_cdtime (c, &db->interval);
627 log_warn ("Ignoring unknown config key \"%s\".", c->key);
630 /* If no `Query' options were given, add the default queries.. */
631 if (db->queries_num == 0) {
632 for (i = 0; i < def_queries_num; i++)
633 udb_query_pick_from_list_by_name (def_queries[i],
634 queries, queries_num,
635 &db->queries, &db->queries_num);
638 if (db->queries_num > 0) {
639 db->q_prep_areas = (udb_query_preparation_area_t **) calloc (
640 db->queries_num, sizeof (*db->q_prep_areas));
642 if (db->q_prep_areas == NULL) {
643 log_err ("Out of memory.");
644 c_psql_database_delete (db);
649 for (i = 0; (size_t)i < db->queries_num; ++i) {
650 c_psql_user_data_t *data;
651 data = udb_query_get_user_data (db->queries[i]);
652 if ((data != NULL) && (data->params_num > db->max_params_num))
653 db->max_params_num = data->params_num;
656 = udb_query_allocate_preparation_area (db->queries[i]);
658 if (db->q_prep_areas[i] == NULL) {
659 log_err ("Out of memory.");
660 c_psql_database_delete (db);
666 ud.free_func = c_psql_database_delete;
668 ssnprintf (cb_name, sizeof (cb_name), "postgresql-%s", db->database);
670 CDTIME_T_TO_TIMESPEC (db->interval, &cb_interval);
672 plugin_register_complex_read ("postgresql", cb_name, c_psql_read,
673 /* interval = */ (db->interval > 0) ? &cb_interval : NULL,
676 } /* c_psql_config_database */
678 static int c_psql_config (oconfig_item_t *ci)
680 static int have_def_config = 0;
684 if (0 == have_def_config) {
689 c = oconfig_parse_file (C_PSQL_DEFAULT_CONF);
691 log_err ("Failed to read default config ("C_PSQL_DEFAULT_CONF").");
696 log_err ("Default config ("C_PSQL_DEFAULT_CONF") did not define "
697 "any queries - please check your installation.");
700 for (i = 0; i < ci->children_num; ++i) {
701 oconfig_item_t *c = ci->children + i;
703 if (0 == strcasecmp (c->key, "Query"))
704 udb_query_create (&queries, &queries_num, c,
705 /* callback = */ config_query_callback);
706 else if (0 == strcasecmp (c->key, "Database"))
707 c_psql_config_database (c);
709 log_warn ("Ignoring unknown config key \"%s\".", c->key);
712 } /* c_psql_config */
714 void module_register (void)
716 plugin_register_complex_config ("postgresql", c_psql_config);
717 plugin_register_shutdown ("postgresql", c_psql_shutdown);
718 } /* module_register */
720 /* vim: set sw=4 ts=4 tw=78 noexpandtab : */