2 * collectd - src/postgresql.c
3 * Copyright (C) 2008 Sebastian Harl
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; only version 2 of the License is applicable.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 * Sebastian Harl <sh at tokkee.org>
23 * This module collects PostgreSQL database statistics.
29 #include "configfile.h"
32 #include "utils_complain.h"
34 #include <pg_config_manual.h>
37 #define log_err(...) ERROR ("postgresql: " __VA_ARGS__)
38 #define log_warn(...) WARNING ("postgresql: " __VA_ARGS__)
39 #define log_info(...) INFO ("postgresql: " __VA_ARGS__)
41 #ifndef C_PSQL_DEFAULT_CONF
42 # define C_PSQL_DEFAULT_CONF PKGDATADIR "/postgresql_default.conf"
45 /* Appends the (parameter, value) pair to the string
46 * pointed to by 'buf' suitable to be used as argument
47 * for PQconnectdb(). If value equals NULL, the pair
49 #define C_PSQL_PAR_APPEND(buf, buf_len, parameter, value) \
50 if ((0 < (buf_len)) && (NULL != (value)) && ('\0' != *(value))) { \
51 int s = ssnprintf (buf, buf_len, " %s = '%s'", parameter, value); \
58 /* Returns the tuple (major, minor, patchlevel)
59 * for the given version number. */
60 #define C_PSQL_SERVER_VERSION3(server_version) \
61 (server_version) / 10000, \
62 (server_version) / 100 - (int)((server_version) / 10000) * 100, \
63 (server_version) - (int)((server_version) / 100) * 100
65 /* Returns true if the given host specifies a
66 * UNIX domain socket. */
67 #define C_PSQL_IS_UNIX_DOMAIN_SOCKET(host) \
68 ((NULL == (host)) || ('\0' == *(host)) || ('/' == *(host)))
70 /* Returns the tuple (host, delimiter, port) for a
71 * given (host, port) pair. Depending on the value of
72 * 'host' a UNIX domain socket or a TCP socket is
74 #define C_PSQL_SOCKET3(host, port) \
75 ((NULL == (host)) || ('\0' == *(host))) ? DEFAULT_PGSOCKET_DIR : host, \
76 C_PSQL_IS_UNIX_DOMAIN_SOCKET (host) ? "/.s.PGSQL." : ":", \
80 C_PSQL_PARAM_HOST = 1,
95 c_psql_param_t *params;
107 c_complain_t conn_complaint;
113 /* user configuration */
114 c_psql_query_t **queries;
130 static char *def_queries[] = {
139 static int def_queries_num = STATIC_ARRAY_SIZE (def_queries);
141 static c_psql_query_t *queries = NULL;
142 static int queries_num = 0;
144 static c_psql_database_t *databases = NULL;
145 static int databases_num = 0;
147 static c_psql_query_t *c_psql_query_new (const char *name)
149 c_psql_query_t *query;
152 if (NULL == (queries = (c_psql_query_t *)realloc (queries,
153 queries_num * sizeof (*queries)))) {
154 log_err ("Out of memory.");
157 query = queries + queries_num - 1;
159 query->name = sstrdup (name);
162 query->params = NULL;
163 query->params_num = 0;
168 query->min_pg_version = 0;
169 query->max_pg_version = INT_MAX;
171 } /* c_psql_query_new */
173 static void c_psql_query_delete (c_psql_query_t *query)
178 sfree (query->query);
180 sfree (query->params);
181 query->params_num = 0;
183 for (i = 0; i < query->cols_num; ++i) {
184 sfree (query->cols[i].type);
185 sfree (query->cols[i].type_instance);
190 } /* c_psql_query_delete */
192 static c_psql_query_t *c_psql_query_get (const char *name, int server_version)
196 for (i = 0; i < queries_num; ++i)
197 if (0 == strcasecmp (name, queries[i].name)
198 && ((-1 == server_version)
199 || ((queries[i].min_pg_version <= server_version)
200 && (server_version <= queries[i].max_pg_version))))
203 } /* c_psql_query_get */
205 static c_psql_database_t *c_psql_database_new (const char *name)
207 c_psql_database_t *db;
210 if (NULL == (databases = (c_psql_database_t *)realloc (databases,
211 databases_num * sizeof (*databases)))) {
212 log_err ("Out of memory.");
216 db = databases + (databases_num - 1);
220 C_COMPLAIN_INIT (&db->conn_complaint);
222 db->proto_version = 0;
224 db->max_params_num = 0;
229 db->database = sstrdup (name);
237 db->krbsrvname = NULL;
241 } /* c_psql_database_new */
243 static void c_psql_database_delete (c_psql_database_t *db)
251 sfree (db->database);
255 sfree (db->password);
259 sfree (db->krbsrvname);
263 } /* c_psql_database_delete */
265 static void submit (const c_psql_database_t *db,
266 const char *type, const char *type_instance,
267 value_t *values, size_t values_len)
269 value_list_t vl = VALUE_LIST_INIT;
272 vl.values_len = values_len;
273 vl.time = time (NULL);
275 if (C_PSQL_IS_UNIX_DOMAIN_SOCKET (db->host)
276 || (0 == strcmp (db->host, "localhost")))
277 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
279 sstrncpy (vl.host, db->host, sizeof (vl.host));
281 sstrncpy (vl.plugin, "postgresql", sizeof (vl.plugin));
282 sstrncpy (vl.plugin_instance, db->database, sizeof (vl.plugin_instance));
284 sstrncpy (vl.type, type, sizeof (vl.type));
286 if (NULL != type_instance)
287 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
289 plugin_dispatch_values (&vl);
293 static void submit_counter (const c_psql_database_t *db,
294 const char *type, const char *type_instance,
299 if ((NULL == value) || ('\0' == *value))
302 values[0].counter = atoll (value);
303 submit (db, type, type_instance, values, 1);
305 } /* submit_counter */
307 static void submit_gauge (const c_psql_database_t *db,
308 const char *type, const char *type_instance,
313 if ((NULL == value) || ('\0' == *value))
316 values[0].gauge = atof (value);
317 submit (db, type, type_instance, values, 1);
321 static int c_psql_check_connection (c_psql_database_t *db)
324 PQclear (PQexec (db->conn, "SELECT 42;"));
326 if (CONNECTION_OK != PQstatus (db->conn)) {
329 /* trigger c_release() */
330 if (0 == db->conn_complaint.interval)
331 db->conn_complaint.interval = 1;
333 if (CONNECTION_OK != PQstatus (db->conn)) {
334 c_complain (LOG_ERR, &db->conn_complaint,
335 "Failed to connect to database %s: %s",
336 db->database, PQerrorMessage (db->conn));
340 db->proto_version = PQprotocolVersion (db->conn);
341 if (3 > db->proto_version)
342 log_warn ("Protocol version %d does not support parameters.",
346 c_release (LOG_INFO, &db->conn_complaint,
347 "Successfully reconnected to database %s", PQdb (db->conn));
349 } /* c_psql_check_connection */
351 static PGresult *c_psql_exec_query_params (c_psql_database_t *db,
352 c_psql_query_t *query)
354 char *params[db->max_params_num];
357 assert (db->max_params_num >= query->params_num);
359 for (i = 0; i < query->params_num; ++i) {
360 switch (query->params[i]) {
361 case C_PSQL_PARAM_HOST:
362 params[i] = C_PSQL_IS_UNIX_DOMAIN_SOCKET (db->host)
363 ? "localhost" : db->host;
365 case C_PSQL_PARAM_DB:
366 params[i] = db->database;
368 case C_PSQL_PARAM_USER:
369 params[i] = db->user;
376 return PQexecParams (db->conn, query->query, query->params_num, NULL,
377 (const char *const *)((0 == query->params_num) ? NULL : params),
378 NULL, NULL, /* return text data */ 0);
379 } /* c_psql_exec_query_params */
381 static PGresult *c_psql_exec_query_noparams (c_psql_database_t *db,
382 c_psql_query_t *query)
384 return PQexec (db->conn, query->query);
385 } /* c_psql_exec_query_noparams */
387 static int c_psql_exec_query (c_psql_database_t *db, int idx)
389 c_psql_query_t *query;
395 if (idx >= db->queries_num)
398 query = db->queries[idx];
400 if (3 <= db->proto_version)
401 res = c_psql_exec_query_params (db, query);
402 else if (0 == query->params_num)
403 res = c_psql_exec_query_noparams (db, query);
405 log_err ("Connection to database \"%s\" does not support parameters "
406 "(protocol version %d) - cannot execute query \"%s\".",
407 db->database, db->proto_version, query->name);
411 if (PGRES_TUPLES_OK != PQresultStatus (res)) {
412 log_err ("Failed to execute SQL query: %s",
413 PQerrorMessage (db->conn));
414 log_info ("SQL query was: %s", query->query);
419 rows = PQntuples (res);
425 cols = PQnfields (res);
426 if (query->cols_num != cols) {
427 log_err ("SQL query returned wrong number of fields "
428 "(expected: %i, got: %i)", query->cols_num, cols);
429 log_info ("SQL query was: %s", query->query);
434 for (i = 0; i < rows; ++i) {
437 for (j = 0; j < cols; ++j) {
438 c_psql_col_t col = query->cols[j];
440 char *value = PQgetvalue (res, i, j);
442 if (col.ds_type == DS_TYPE_COUNTER)
443 submit_counter (db, col.type, col.type_instance, value);
444 else if (col.ds_type == DS_TYPE_GAUGE)
445 submit_gauge (db, col.type, col.type_instance, value);
450 } /* c_psql_exec_query */
452 static int c_psql_read (void)
457 for (i = 0; i < databases_num; ++i) {
458 c_psql_database_t *db = databases + i;
462 assert (NULL != db->database);
464 if (0 != c_psql_check_connection (db))
467 for (j = 0; j < db->queries_num; ++j)
468 c_psql_exec_query (db, j);
478 static int c_psql_shutdown (void)
482 if ((NULL == databases) || (0 == databases_num))
485 plugin_unregister_read ("postgresql");
486 plugin_unregister_shutdown ("postgresql");
488 for (i = 0; i < databases_num; ++i) {
489 c_psql_database_t *db = databases + i;
490 c_psql_database_delete (db);
496 for (i = 0; i < queries_num; ++i) {
497 c_psql_query_t *query = queries + i;
498 c_psql_query_delete (query);
504 } /* c_psql_shutdown */
506 static int c_psql_init (void)
510 if ((NULL == databases) || (0 == databases_num))
513 for (i = 0; i < queries_num; ++i) {
514 c_psql_query_t *query = queries + i;
517 for (j = 0; j < query->cols_num; ++j) {
518 c_psql_col_t *col = query->cols + j;
519 const data_set_t *ds;
521 ds = plugin_get_ds (col->type);
523 log_err ("Column: Unknown type \"%s\".", col->type);
528 if (1 != ds->ds_num) {
529 log_err ("Column: Invalid type \"%s\" - types defining "
530 "one data source are supported only (got: %i).",
531 col->type, ds->ds_num);
536 col->ds_type = ds->ds[0].type;
540 for (i = 0; i < databases_num; ++i) {
541 c_psql_database_t *db = databases + i;
544 char *buf = conninfo;
545 int buf_len = sizeof (conninfo);
553 /* this will happen during reinitialization */
554 if (NULL != db->conn) {
555 c_psql_check_connection (db);
559 status = ssnprintf (buf, buf_len, "dbname = '%s'", db->database);
565 C_PSQL_PAR_APPEND (buf, buf_len, "host", db->host);
566 C_PSQL_PAR_APPEND (buf, buf_len, "port", db->port);
567 C_PSQL_PAR_APPEND (buf, buf_len, "user", db->user);
568 C_PSQL_PAR_APPEND (buf, buf_len, "password", db->password);
569 C_PSQL_PAR_APPEND (buf, buf_len, "sslmode", db->sslmode);
570 C_PSQL_PAR_APPEND (buf, buf_len, "krbsrvname", db->krbsrvname);
571 C_PSQL_PAR_APPEND (buf, buf_len, "service", db->service);
573 db->conn = PQconnectdb (conninfo);
574 if (0 != c_psql_check_connection (db))
577 db->proto_version = PQprotocolVersion (db->conn);
579 server_host = PQhost (db->conn);
580 server_version = PQserverVersion (db->conn);
581 log_info ("Sucessfully connected to database %s (user %s) "
582 "at server %s%s%s (server version: %d.%d.%d, "
583 "protocol version: %d, pid: %d)",
584 PQdb (db->conn), PQuser (db->conn),
585 C_PSQL_SOCKET3 (server_host, PQport (db->conn)),
586 C_PSQL_SERVER_VERSION3 (server_version),
587 db->proto_version, PQbackendPID (db->conn));
589 if (3 > db->proto_version)
590 log_warn ("Protocol version %d does not support parameters.",
593 /* Now that we know the PostgreSQL server version, we can get the
594 * right version of each query definition. */
595 for (j = 0; j < db->queries_num; ++j) {
598 tmp = c_psql_query_get (db->queries[j]->name, server_version);
600 if (tmp == db->queries[j])
604 log_err ("Query \"%s\" not found for server version %i - "
605 "please check your configuration.",
606 db->queries[j]->name, server_version);
608 if (db->queries_num - j - 1 > 0)
609 memmove (db->queries + j, db->queries + j + 1,
610 (db->queries_num - j - 1) * sizeof (*db->queries));
617 db->queries[j] = tmp;
621 plugin_register_read ("postgresql", c_psql_read);
622 plugin_register_shutdown ("postgresql", c_psql_shutdown);
626 static int config_set_s (char *name, char **var, const oconfig_item_t *ci)
628 if ((0 != ci->children_num) || (1 != ci->values_num)
629 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
630 log_err ("%s expects a single string argument.", name);
635 *var = sstrdup (ci->values[0].value.string);
639 static int config_set_i (char *name, int *var, const oconfig_item_t *ci)
641 if ((0 != ci->children_num) || (1 != ci->values_num)
642 || (OCONFIG_TYPE_NUMBER != ci->values[0].type)) {
643 log_err ("%s expects a single number argument.", name);
647 *var = (int)ci->values[0].value.number;
651 static int config_set_param (c_psql_query_t *query, const oconfig_item_t *ci)
653 c_psql_param_t param;
656 if ((0 != ci->children_num) || (1 != ci->values_num)
657 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
658 log_err ("Param expects a single string argument.");
662 param_str = ci->values[0].value.string;
663 if (0 == strcasecmp (param_str, "hostname"))
664 param = C_PSQL_PARAM_HOST;
665 else if (0 == strcasecmp (param_str, "database"))
666 param = C_PSQL_PARAM_DB;
667 else if (0 == strcasecmp (param_str, "username"))
668 param = C_PSQL_PARAM_USER;
670 log_err ("Invalid parameter \"%s\".", param_str);
675 if (NULL == (query->params = (c_psql_param_t *)realloc (query->params,
676 query->params_num * sizeof (*query->params)))) {
677 log_err ("Out of memory.");
681 query->params[query->params_num - 1] = param;
683 } /* config_set_param */
685 static int config_set_column (c_psql_query_t *query, const oconfig_item_t *ci)
691 if ((0 != ci->children_num)
692 || (1 > ci->values_num) || (2 < ci->values_num)) {
693 log_err ("Column expects either one or two arguments.");
697 for (i = 0; i < ci->values_num; ++i) {
698 if (OCONFIG_TYPE_STRING != ci->values[i].type) {
699 log_err ("Column expects either one or two string arguments.");
705 if (NULL == (query->cols = (c_psql_col_t *)realloc (query->cols,
706 query->cols_num * sizeof (*query->cols)))) {
707 log_err ("Out of memory.");
711 col = query->cols + query->cols_num - 1;
715 col->type = sstrdup (ci->values[0].value.string);
716 col->type_instance = (2 == ci->values_num)
717 ? sstrdup (ci->values[1].value.string) : NULL;
719 } /* config_set_column */
721 static int set_query (c_psql_database_t *db, const char *name)
723 c_psql_query_t *query;
725 query = c_psql_query_get (name, -1);
727 log_err ("Query \"%s\" not found - please check your configuration.",
733 if (NULL == (db->queries = (c_psql_query_t **)realloc (db->queries,
734 db->queries_num * sizeof (*db->queries)))) {
735 log_err ("Out of memory.");
739 if (query->params_num > db->max_params_num)
740 db->max_params_num = query->params_num;
742 db->queries[db->queries_num - 1] = query;
746 static int config_set_query (c_psql_database_t *db, const oconfig_item_t *ci)
748 if ((0 != ci->children_num) || (1 != ci->values_num)
749 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
750 log_err ("Query expects a single string argument.");
753 return set_query (db, ci->values[0].value.string);
754 } /* config_set_query */
756 static int c_psql_config_query (oconfig_item_t *ci)
758 c_psql_query_t *query;
762 if ((1 != ci->values_num)
763 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
764 log_err ("<Query> expects a single string argument.");
768 query = c_psql_query_new (ci->values[0].value.string);
770 for (i = 0; i < ci->children_num; ++i) {
771 oconfig_item_t *c = ci->children + i;
773 if (0 == strcasecmp (c->key, "Query"))
774 config_set_s ("Query", &query->query, c);
775 else if (0 == strcasecmp (c->key, "Param"))
776 config_set_param (query, c);
777 else if (0 == strcasecmp (c->key, "Column"))
778 config_set_column (query, c);
779 else if (0 == strcasecmp (c->key, "MinPGVersion"))
780 config_set_i ("MinPGVersion", &query->min_pg_version, c);
781 else if (0 == strcasecmp (c->key, "MaxPGVersion"))
782 config_set_i ("MaxPGVersion", &query->max_pg_version, c);
784 log_warn ("Ignoring unknown config key \"%s\".", c->key);
787 for (i = 0; i < queries_num - 1; ++i) {
788 c_psql_query_t *q = queries + i;
790 if ((0 == strcasecmp (q->name, query->name))
791 && (q->min_pg_version <= query->max_pg_version)
792 && (query->min_pg_version <= q->max_pg_version)) {
793 log_err ("Ignoring redefinition (with overlapping version ranges) "
794 "of query \"%s\".", query->name);
795 c_psql_query_delete (query);
801 if (query->min_pg_version > query->max_pg_version) {
802 log_err ("Query \"%s\": MinPGVersion > MaxPGVersion.",
804 c_psql_query_delete (query);
809 if (NULL == query->query) {
810 log_err ("Query \"%s\" does not include an SQL query string - "
811 "please check your configuration.", query->name);
812 c_psql_query_delete (query);
817 } /* c_psql_config_query */
819 static int c_psql_config_database (oconfig_item_t *ci)
821 c_psql_database_t *db;
825 if ((1 != ci->values_num)
826 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
827 log_err ("<Database> expects a single string argument.");
831 db = c_psql_database_new (ci->values[0].value.string);
833 for (i = 0; i < ci->children_num; ++i) {
834 oconfig_item_t *c = ci->children + i;
836 if (0 == strcasecmp (c->key, "Host"))
837 config_set_s ("Host", &db->host, c);
838 else if (0 == strcasecmp (c->key, "Port"))
839 config_set_s ("Port", &db->port, c);
840 else if (0 == strcasecmp (c->key, "User"))
841 config_set_s ("User", &db->user, c);
842 else if (0 == strcasecmp (c->key, "Password"))
843 config_set_s ("Password", &db->password, c);
844 else if (0 == strcasecmp (c->key, "SSLMode"))
845 config_set_s ("SSLMode", &db->sslmode, c);
846 else if (0 == strcasecmp (c->key, "KRBSrvName"))
847 config_set_s ("KRBSrvName", &db->krbsrvname, c);
848 else if (0 == strcasecmp (c->key, "Service"))
849 config_set_s ("Service", &db->service, c);
850 else if (0 == strcasecmp (c->key, "Query"))
851 config_set_query (db, c);
853 log_warn ("Ignoring unknown config key \"%s\".", c->key);
856 if (NULL == db->queries) {
857 for (i = 0; i < def_queries_num; ++i)
858 set_query (db, def_queries[i]);
863 static int c_psql_config (oconfig_item_t *ci)
865 static int have_def_config = 0;
869 if (0 == have_def_config) {
874 c = oconfig_parse_file (C_PSQL_DEFAULT_CONF);
876 log_err ("Failed to read default config ("C_PSQL_DEFAULT_CONF").");
881 log_err ("Default config ("C_PSQL_DEFAULT_CONF") did not define "
882 "any queries - please check your installation.");
885 for (i = 0; i < ci->children_num; ++i) {
886 oconfig_item_t *c = ci->children + i;
888 if (0 == strcasecmp (c->key, "Query"))
889 c_psql_config_query (c);
890 else if (0 == strcasecmp (c->key, "Database"))
891 c_psql_config_database (c);
893 log_warn ("Ignoring unknown config key \"%s\".", c->key);
896 } /* c_psql_config */
898 void module_register (void)
900 plugin_register_complex_config ("postgresql", c_psql_config);
901 plugin_register_init ("postgresql", c_psql_init);
902 } /* module_register */
904 /* vim: set sw=4 ts=4 tw=78 noexpandtab : */