1 /**
2 * collectd - src/postgresql.c
3 * Copyright (C) 2008-2012 Sebastian Harl
4 * Copyright (C) 2009 Florian Forster
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * - Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 *
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.
17 *
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.
29 *
30 * Authors:
31 * Sebastian Harl <sh at tokkee.org>
32 * Florian Forster <octo at verplant.org>
33 **/
35 /*
36 * This module collects PostgreSQL database statistics.
37 */
39 #include "collectd.h"
40 #include "common.h"
42 #include "configfile.h"
43 #include "plugin.h"
45 #include "utils_cache.h"
46 #include "utils_db_query.h"
47 #include "utils_complain.h"
49 #if HAVE_PTHREAD_H
50 # include <pthread.h>
51 #endif
53 #include <pg_config_manual.h>
54 #include <libpq-fe.h>
56 #define log_err(...) ERROR ("postgresql: " __VA_ARGS__)
57 #define log_warn(...) WARNING ("postgresql: " __VA_ARGS__)
58 #define log_info(...) INFO ("postgresql: " __VA_ARGS__)
59 #define log_debug(...) DEBUG ("postgresql: " __VA_ARGS__)
61 #ifndef C_PSQL_DEFAULT_CONF
62 # define C_PSQL_DEFAULT_CONF PKGDATADIR "/postgresql_default.conf"
63 #endif
65 /* Appends the (parameter, value) pair to the string
66 * pointed to by 'buf' suitable to be used as argument
67 * for PQconnectdb(). If value equals NULL, the pair
68 * is ignored. */
69 #define C_PSQL_PAR_APPEND(buf, buf_len, parameter, value) \
70 if ((0 < (buf_len)) && (NULL != (value)) && ('\0' != *(value))) { \
71 int s = ssnprintf (buf, buf_len, " %s = '%s'", parameter, value); \
72 if (0 < s) { \
73 buf += s; \
74 buf_len -= s; \
75 } \
76 }
78 /* Returns the tuple (major, minor, patchlevel)
79 * for the given version number. */
80 #define C_PSQL_SERVER_VERSION3(server_version) \
81 (server_version) / 10000, \
82 (server_version) / 100 - (int)((server_version) / 10000) * 100, \
83 (server_version) - (int)((server_version) / 100) * 100
85 /* Returns true if the given host specifies a
86 * UNIX domain socket. */
87 #define C_PSQL_IS_UNIX_DOMAIN_SOCKET(host) \
88 ((NULL == (host)) || ('\0' == *(host)) || ('/' == *(host)))
90 /* Returns the tuple (host, delimiter, port) for a
91 * given (host, port) pair. Depending on the value of
92 * 'host' a UNIX domain socket or a TCP socket is
93 * assumed. */
94 #define C_PSQL_SOCKET3(host, port) \
95 ((NULL == (host)) || ('\0' == *(host))) ? DEFAULT_PGSOCKET_DIR : host, \
96 C_PSQL_IS_UNIX_DOMAIN_SOCKET (host) ? "/.s.PGSQL." : ":", \
97 port
99 typedef enum {
100 C_PSQL_PARAM_HOST = 1,
101 C_PSQL_PARAM_DB,
102 C_PSQL_PARAM_USER,
103 C_PSQL_PARAM_INTERVAL,
104 C_PSQL_PARAM_INSTANCE,
105 } c_psql_param_t;
107 /* Parameter configuration. Stored as `user data' in the query objects. */
108 typedef struct {
109 c_psql_param_t *params;
110 int params_num;
111 } c_psql_user_data_t;
113 typedef struct {
114 char *name;
115 char *statement;
116 _Bool store_rates;
117 } c_psql_writer_t;
119 typedef struct {
120 PGconn *conn;
121 c_complain_t conn_complaint;
123 int proto_version;
124 int server_version;
126 int max_params_num;
128 /* user configuration */
129 udb_query_preparation_area_t **q_prep_areas;
130 udb_query_t **queries;
131 size_t queries_num;
133 c_psql_writer_t **writers;
134 size_t writers_num;
136 /* make sure we don't access the database object in parallel */
137 pthread_mutex_t db_lock;
139 cdtime_t interval;
141 /* writer "caching" settings */
142 cdtime_t commit_interval;
143 cdtime_t next_commit;
145 char *host;
146 char *port;
147 char *database;
148 char *user;
149 char *password;
151 char *instance;
153 char *sslmode;
155 char *krbsrvname;
157 char *service;
159 int ref_cnt;
160 } c_psql_database_t;
162 static char *def_queries[] = {
163 "backends",
164 "transactions",
165 "queries",
166 "query_plans",
167 "table_states",
168 "disk_io",
169 "disk_usage"
170 };
171 static int def_queries_num = STATIC_ARRAY_SIZE (def_queries);
173 static c_psql_database_t *databases = NULL;
174 static size_t databases_num = 0;
176 static udb_query_t **queries = NULL;
177 static size_t queries_num = 0;
179 static c_psql_writer_t *writers = NULL;
180 static size_t writers_num = 0;
182 static int c_psql_begin (c_psql_database_t *db)
183 {
184 PGresult *r = PQexec (db->conn, "BEGIN");
186 int status = 1;
188 if (r != NULL) {
189 if (PGRES_COMMAND_OK == PQresultStatus (r)) {
190 db->next_commit = cdtime() + db->commit_interval;
191 status = 0;
192 }
193 else
194 log_warn ("Failed to initiate ('BEGIN') transaction: %s",
195 PQerrorMessage (db->conn));
196 PQclear (r);
197 }
198 return status;
199 } /* c_psql_begin */
201 static int c_psql_commit (c_psql_database_t *db)
202 {
203 PGresult *r = PQexec (db->conn, "COMMIT");
205 int status = 1;
207 if (r != NULL) {
208 if (PGRES_COMMAND_OK == PQresultStatus (r)) {
209 db->next_commit = 0;
210 log_debug ("Successfully committed transaction.");
211 status = 0;
212 }
213 else
214 log_warn ("Failed to commit transaction: %s",
215 PQerrorMessage (db->conn));
216 PQclear (r);
217 }
218 return status;
219 } /* c_psql_commit */
221 static c_psql_database_t *c_psql_database_new (const char *name)
222 {
223 c_psql_database_t *db;
225 db = (c_psql_database_t *)realloc (databases,
226 (databases_num + 1) * sizeof (*db));
227 if (NULL == db) {
228 log_err ("Out of memory.");
229 return NULL;
230 }
232 databases = db;
233 db = databases + databases_num;
234 ++databases_num;
236 db->conn = NULL;
238 C_COMPLAIN_INIT (&db->conn_complaint);
240 db->proto_version = 0;
241 db->server_version = 0;
243 db->max_params_num = 0;
245 db->q_prep_areas = NULL;
246 db->queries = NULL;
247 db->queries_num = 0;
249 db->writers = NULL;
250 db->writers_num = 0;
252 pthread_mutex_init (&db->db_lock, /* attrs = */ NULL);
254 db->interval = 0;
256 db->commit_interval = 0;
257 db->next_commit = 0;
259 db->database = sstrdup (name);
260 db->host = NULL;
261 db->port = NULL;
262 db->user = NULL;
263 db->password = NULL;
265 db->instance = sstrdup (name);
267 db->sslmode = NULL;
269 db->krbsrvname = NULL;
271 db->service = NULL;
273 db->ref_cnt = 0;
274 return db;
275 } /* c_psql_database_new */
277 static void c_psql_database_delete (void *data)
278 {
279 size_t i;
281 c_psql_database_t *db = data;
283 --db->ref_cnt;
284 /* readers and writers may access this database */
285 if (db->ref_cnt > 0)
286 return;
288 /* wait for the lock to be released by the last writer */
289 pthread_mutex_lock (&db->db_lock);
291 if (db->next_commit > 0)
292 c_psql_commit (db);
294 PQfinish (db->conn);
295 db->conn = NULL;
297 if (db->q_prep_areas)
298 for (i = 0; i < db->queries_num; ++i)
299 udb_query_delete_preparation_area (db->q_prep_areas[i]);
300 free (db->q_prep_areas);
302 sfree (db->queries);
303 db->queries_num = 0;
305 sfree (db->writers);
306 db->writers_num = 0;
308 pthread_mutex_unlock (&db->db_lock);
310 pthread_mutex_destroy (&db->db_lock);
312 sfree (db->database);
313 sfree (db->host);
314 sfree (db->port);
315 sfree (db->user);
316 sfree (db->password);
318 sfree (db->instance);
320 sfree (db->sslmode);
322 sfree (db->krbsrvname);
324 sfree (db->service);
326 /* don't care about freeing or reordering the 'databases' array
327 * this is done in 'shutdown' */
328 return;
329 } /* c_psql_database_delete */
331 static int c_psql_connect (c_psql_database_t *db)
332 {
333 char conninfo[4096];
334 char *buf = conninfo;
335 int buf_len = sizeof (conninfo);
336 int status;
338 if ((! db) || (! db->database))
339 return -1;
341 status = ssnprintf (buf, buf_len, "dbname = '%s'", db->database);
342 if (0 < status) {
343 buf += status;
344 buf_len -= status;
345 }
347 C_PSQL_PAR_APPEND (buf, buf_len, "host", db->host);
348 C_PSQL_PAR_APPEND (buf, buf_len, "port", db->port);
349 C_PSQL_PAR_APPEND (buf, buf_len, "user", db->user);
350 C_PSQL_PAR_APPEND (buf, buf_len, "password", db->password);
351 C_PSQL_PAR_APPEND (buf, buf_len, "sslmode", db->sslmode);
352 C_PSQL_PAR_APPEND (buf, buf_len, "krbsrvname", db->krbsrvname);
353 C_PSQL_PAR_APPEND (buf, buf_len, "service", db->service);
355 db->conn = PQconnectdb (conninfo);
356 db->proto_version = PQprotocolVersion (db->conn);
357 return 0;
358 } /* c_psql_connect */
360 static int c_psql_check_connection (c_psql_database_t *db)
361 {
362 _Bool init = 0;
364 if (! db->conn) {
365 init = 1;
367 /* trigger c_release() */
368 if (0 == db->conn_complaint.interval)
369 db->conn_complaint.interval = 1;
371 c_psql_connect (db);
372 }
374 if (CONNECTION_OK != PQstatus (db->conn)) {
375 PQreset (db->conn);
377 /* trigger c_release() */
378 if (0 == db->conn_complaint.interval)
379 db->conn_complaint.interval = 1;
381 if (CONNECTION_OK != PQstatus (db->conn)) {
382 c_complain (LOG_ERR, &db->conn_complaint,
383 "Failed to connect to database %s (%s): %s",
384 db->database, db->instance,
385 PQerrorMessage (db->conn));
386 return -1;
387 }
389 db->proto_version = PQprotocolVersion (db->conn);
390 }
392 db->server_version = PQserverVersion (db->conn);
394 if (c_would_release (&db->conn_complaint)) {
395 char *server_host;
396 int server_version;
398 server_host = PQhost (db->conn);
399 server_version = PQserverVersion (db->conn);
401 c_do_release (LOG_INFO, &db->conn_complaint,
402 "Successfully %sconnected to database %s (user %s) "
403 "at server %s%s%s (server version: %d.%d.%d, "
404 "protocol version: %d, pid: %d)", init ? "" : "re",
405 PQdb (db->conn), PQuser (db->conn),
406 C_PSQL_SOCKET3 (server_host, PQport (db->conn)),
407 C_PSQL_SERVER_VERSION3 (server_version),
408 db->proto_version, PQbackendPID (db->conn));
410 if (3 > db->proto_version)
411 log_warn ("Protocol version %d does not support parameters.",
412 db->proto_version);
413 }
414 return 0;
415 } /* c_psql_check_connection */
417 static PGresult *c_psql_exec_query_noparams (c_psql_database_t *db,
418 udb_query_t *q)
419 {
420 return PQexec (db->conn, udb_query_get_statement (q));
421 } /* c_psql_exec_query_noparams */
423 static PGresult *c_psql_exec_query_params (c_psql_database_t *db,
424 udb_query_t *q, c_psql_user_data_t *data)
425 {
426 char *params[db->max_params_num];
427 char interval[64];
428 int i;
430 if ((data == NULL) || (data->params_num == 0))
431 return (c_psql_exec_query_noparams (db, q));
433 assert (db->max_params_num >= data->params_num);
435 for (i = 0; i < data->params_num; ++i) {
436 switch (data->params[i]) {
437 case C_PSQL_PARAM_HOST:
438 params[i] = C_PSQL_IS_UNIX_DOMAIN_SOCKET (db->host)
439 ? "localhost" : db->host;
440 break;
441 case C_PSQL_PARAM_DB:
442 params[i] = db->database;
443 break;
444 case C_PSQL_PARAM_USER:
445 params[i] = db->user;
446 break;
447 case C_PSQL_PARAM_INTERVAL:
448 ssnprintf (interval, sizeof (interval), "%.3f",
449 (db->interval > 0)
450 ? CDTIME_T_TO_DOUBLE (db->interval)
451 : plugin_get_interval ());
452 params[i] = interval;
453 break;
454 case C_PSQL_PARAM_INSTANCE:
455 params[i] = db->instance;
456 break;
457 default:
458 assert (0);
459 }
460 }
462 return PQexecParams (db->conn, udb_query_get_statement (q),
463 data->params_num, NULL,
464 (const char *const *) params,
465 NULL, NULL, /* return text data */ 0);
466 } /* c_psql_exec_query_params */
468 /* db->db_lock must be locked when calling this function */
469 static int c_psql_exec_query (c_psql_database_t *db, udb_query_t *q,
470 udb_query_preparation_area_t *prep_area)
471 {
472 PGresult *res;
474 c_psql_user_data_t *data;
476 const char *host;
478 char **column_names;
479 char **column_values;
480 int column_num;
482 int rows_num;
483 int status;
484 int row, col;
486 /* The user data may hold parameter information, but may be NULL. */
487 data = udb_query_get_user_data (q);
489 /* Versions up to `3' don't know how to handle parameters. */
490 if (3 <= db->proto_version)
491 res = c_psql_exec_query_params (db, q, data);
492 else if ((NULL == data) || (0 == data->params_num))
493 res = c_psql_exec_query_noparams (db, q);
494 else {
495 log_err ("Connection to database \"%s\" (%s) does not support "
496 "parameters (protocol version %d) - "
497 "cannot execute query \"%s\".",
498 db->database, db->instance, db->proto_version,
499 udb_query_get_name (q));
500 return -1;
501 }
503 /* give c_psql_write() a chance to acquire the lock if called recursively
504 * through dispatch_values(); this will happen if, both, queries and
505 * writers are configured for a single connection */
506 pthread_mutex_unlock (&db->db_lock);
508 column_names = NULL;
509 column_values = NULL;
511 if (PGRES_TUPLES_OK != PQresultStatus (res)) {
512 pthread_mutex_lock (&db->db_lock);
514 if ((CONNECTION_OK != PQstatus (db->conn))
515 && (0 == c_psql_check_connection (db))) {
516 PQclear (res);
517 return c_psql_exec_query (db, q, prep_area);
518 }
520 log_err ("Failed to execute SQL query: %s",
521 PQerrorMessage (db->conn));
522 log_info ("SQL query was: %s",
523 udb_query_get_statement (q));
524 PQclear (res);
525 return -1;
526 }
528 #define BAIL_OUT(status) \
529 sfree (column_names); \
530 sfree (column_values); \
531 PQclear (res); \
532 pthread_mutex_lock (&db->db_lock); \
533 return status
535 rows_num = PQntuples (res);
536 if (1 > rows_num) {
537 BAIL_OUT (0);
538 }
540 column_num = PQnfields (res);
541 column_names = (char **) calloc (column_num, sizeof (char *));
542 if (NULL == column_names) {
543 log_err ("calloc failed.");
544 BAIL_OUT (-1);
545 }
547 column_values = (char **) calloc (column_num, sizeof (char *));
548 if (NULL == column_values) {
549 log_err ("calloc failed.");
550 BAIL_OUT (-1);
551 }
553 for (col = 0; col < column_num; ++col) {
554 /* Pointers returned by `PQfname' are freed by `PQclear' via
555 * `BAIL_OUT'. */
556 column_names[col] = PQfname (res, col);
557 if (NULL == column_names[col]) {
558 log_err ("Failed to resolve name of column %i.", col);
559 BAIL_OUT (-1);
560 }
561 }
563 if (C_PSQL_IS_UNIX_DOMAIN_SOCKET (db->host)
564 || (0 == strcmp (db->host, "localhost")))
565 host = hostname_g;
566 else
567 host = db->host;
569 status = udb_query_prepare_result (q, prep_area, host, "postgresql",
570 db->instance, column_names, (size_t) column_num, db->interval);
571 if (0 != status) {
572 log_err ("udb_query_prepare_result failed with status %i.",
573 status);
574 BAIL_OUT (-1);
575 }
577 for (row = 0; row < rows_num; ++row) {
578 for (col = 0; col < column_num; ++col) {
579 /* Pointers returned by `PQgetvalue' are freed by `PQclear' via
580 * `BAIL_OUT'. */
581 column_values[col] = PQgetvalue (res, row, col);
582 if (NULL == column_values[col]) {
583 log_err ("Failed to get value at (row = %i, col = %i).",
584 row, col);
585 break;
586 }
587 }
589 /* check for an error */
590 if (col < column_num)
591 continue;
593 status = udb_query_handle_result (q, prep_area, column_values);
594 if (status != 0) {
595 log_err ("udb_query_handle_result failed with status %i.",
596 status);
597 }
598 } /* for (row = 0; row < rows_num; ++row) */
600 udb_query_finish_result (q, prep_area);
602 BAIL_OUT (0);
603 #undef BAIL_OUT
604 } /* c_psql_exec_query */
606 static int c_psql_read (user_data_t *ud)
607 {
608 c_psql_database_t *db;
610 int success = 0;
611 int i;
613 if ((ud == NULL) || (ud->data == NULL)) {
614 log_err ("c_psql_read: Invalid user data.");
615 return -1;
616 }
618 db = ud->data;
620 assert (NULL != db->database);
621 assert (NULL != db->instance);
622 assert (NULL != db->queries);
624 pthread_mutex_lock (&db->db_lock);
626 if (0 != c_psql_check_connection (db)) {
627 pthread_mutex_unlock (&db->db_lock);
628 return -1;
629 }
631 for (i = 0; i < db->queries_num; ++i)
632 {
633 udb_query_preparation_area_t *prep_area;
634 udb_query_t *q;
636 prep_area = db->q_prep_areas[i];
637 q = db->queries[i];
639 if ((0 != db->server_version)
640 && (udb_query_check_version (q, db->server_version) <= 0))
641 continue;
643 if (0 == c_psql_exec_query (db, q, prep_area))
644 success = 1;
645 }
647 pthread_mutex_unlock (&db->db_lock);
649 if (! success)
650 return -1;
651 return 0;
652 } /* c_psql_read */
654 static char *values_name_to_sqlarray (const data_set_t *ds,
655 char *string, size_t string_len)
656 {
657 char *str_ptr;
658 size_t str_len;
660 int i;
662 str_ptr = string;
663 str_len = string_len;
665 for (i = 0; i < ds->ds_num; ++i) {
666 int status = ssnprintf (str_ptr, str_len, ",'%s'", ds->ds[i].name);
668 if (status < 1)
669 return NULL;
670 else if ((size_t)status >= str_len) {
671 str_len = 0;
672 break;
673 }
674 else {
675 str_ptr += status;
676 str_len -= (size_t)status;
677 }
678 }
680 if (str_len <= 2) {
681 log_err ("c_psql_write: Failed to stringify value names");
682 return NULL;
683 }
685 /* overwrite the first comma */
686 string[0] = '{';
687 str_ptr[0] = '}';
688 str_ptr[1] = '\0';
690 return string;
691 } /* values_name_to_sqlarray */
693 static char *values_type_to_sqlarray (const data_set_t *ds,
694 char *string, size_t string_len, _Bool store_rates)
695 {
696 char *str_ptr;
697 size_t str_len;
699 int i;
701 str_ptr = string;
702 str_len = string_len;
704 for (i = 0; i < ds->ds_num; ++i) {
705 int status;
707 if (store_rates)
708 status = ssnprintf(str_ptr, str_len, ",'gauge'");
709 else
710 status = ssnprintf(str_ptr, str_len, ",'%s'",
711 DS_TYPE_TO_STRING (ds->ds[i].type));
713 if (status < 1) {
714 str_len = 0;
715 break;
716 }
717 else if ((size_t)status >= str_len) {
718 str_len = 0;
719 break;
720 }
721 else {
722 str_ptr += status;
723 str_len -= (size_t)status;
724 }
725 }
727 if (str_len <= 2) {
728 log_err ("c_psql_write: Failed to stringify value types");
729 return NULL;
730 }
732 /* overwrite the first comma */
733 string[0] = '{';
734 str_ptr[0] = '}';
735 str_ptr[1] = '\0';
737 return string;
738 } /* values_type_to_sqlarray */
740 static char *values_to_sqlarray (const data_set_t *ds, const value_list_t *vl,
741 char *string, size_t string_len, _Bool store_rates)
742 {
743 char *str_ptr;
744 size_t str_len;
746 gauge_t *rates = NULL;
748 int i;
750 str_ptr = string;
751 str_len = string_len;
753 for (i = 0; i < vl->values_len; ++i) {
754 int status = 0;
756 if ((ds->ds[i].type != DS_TYPE_GAUGE)
757 && (ds->ds[i].type != DS_TYPE_COUNTER)
758 && (ds->ds[i].type != DS_TYPE_DERIVE)
759 && (ds->ds[i].type != DS_TYPE_ABSOLUTE)) {
760 log_err ("c_psql_write: Unknown data source type: %i",
761 ds->ds[i].type);
762 sfree (rates);
763 return NULL;
764 }
766 if (ds->ds[i].type == DS_TYPE_GAUGE)
767 status = ssnprintf (str_ptr, str_len,
768 ",%f", vl->values[i].gauge);
769 else if (store_rates) {
770 if (rates == NULL)
771 rates = uc_get_rate (ds, vl);
773 if (rates == NULL) {
774 log_err ("c_psql_write: Failed to determine rate");
775 return NULL;
776 }
778 status = ssnprintf (str_ptr, str_len,
779 ",%lf", rates[i]);
780 }
781 else if (ds->ds[i].type == DS_TYPE_COUNTER)
782 status = ssnprintf (str_ptr, str_len,
783 ",%llu", vl->values[i].counter);
784 else if (ds->ds[i].type == DS_TYPE_DERIVE)
785 status = ssnprintf (str_ptr, str_len,
786 ",%"PRIi64, vl->values[i].derive);
787 else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
788 status = ssnprintf (str_ptr, str_len,
789 ",%"PRIu64, vl->values[i].absolute);
791 if (status < 1) {
792 str_len = 0;
793 break;
794 }
795 else if ((size_t)status >= str_len) {
796 str_len = 0;
797 break;
798 }
799 else {
800 str_ptr += status;
801 str_len -= (size_t)status;
802 }
803 }
805 sfree (rates);
807 if (str_len <= 2) {
808 log_err ("c_psql_write: Failed to stringify value list");
809 return NULL;
810 }
812 /* overwrite the first comma */
813 string[0] = '{';
814 str_ptr[0] = '}';
815 str_ptr[1] = '\0';
817 return string;
818 } /* values_to_sqlarray */
820 static int c_psql_write (const data_set_t *ds, const value_list_t *vl,
821 user_data_t *ud)
822 {
823 c_psql_database_t *db;
825 char time_str[32];
826 char values_name_str[1024];
827 char values_type_str[1024];
828 char values_str[1024];
830 const char *params[9];
832 int success = 0;
833 int i;
835 if ((ud == NULL) || (ud->data == NULL)) {
836 log_err ("c_psql_write: Invalid user data.");
837 return -1;
838 }
840 db = ud->data;
841 assert (db->database != NULL);
842 assert (db->writers != NULL);
844 if (cdtime_to_iso8601 (time_str, sizeof (time_str), vl->time) == 0) {
845 log_err ("c_psql_write: Failed to convert time to ISO 8601 format");
846 return -1;
847 }
849 if (values_name_to_sqlarray (ds,
850 values_name_str, sizeof (values_name_str)) == NULL)
851 return -1;
853 #define VALUE_OR_NULL(v) ((((v) == NULL) || (*(v) == '\0')) ? NULL : (v))
855 params[0] = time_str;
856 params[1] = vl->host;
857 params[2] = vl->plugin;
858 params[3] = VALUE_OR_NULL(vl->plugin_instance);
859 params[4] = vl->type;
860 params[5] = VALUE_OR_NULL(vl->type_instance);
861 params[6] = values_name_str;
863 #undef VALUE_OR_NULL
865 pthread_mutex_lock (&db->db_lock);
867 if (0 != c_psql_check_connection (db)) {
868 pthread_mutex_unlock (&db->db_lock);
869 return -1;
870 }
872 if ((db->commit_interval > 0)
873 && (db->next_commit == 0))
874 c_psql_begin (db);
876 for (i = 0; i < db->writers_num; ++i) {
877 c_psql_writer_t *writer;
878 PGresult *res;
880 writer = db->writers[i];
882 if (values_type_to_sqlarray (ds,
883 values_type_str, sizeof (values_type_str),
884 writer->store_rates) == NULL) {
885 pthread_mutex_unlock (&db->db_lock);
886 return -1;
887 }
889 if (values_to_sqlarray (ds, vl,
890 values_str, sizeof (values_str),
891 writer->store_rates) == NULL) {
892 pthread_mutex_unlock (&db->db_lock);
893 return -1;
894 }
896 params[7] = values_type_str;
897 params[8] = values_str;
899 res = PQexecParams (db->conn, writer->statement,
900 STATIC_ARRAY_SIZE (params), NULL,
901 (const char *const *)params,
902 NULL, NULL, /* return text data */ 0);
904 if ((PGRES_COMMAND_OK != PQresultStatus (res))
905 && (PGRES_TUPLES_OK != PQresultStatus (res))) {
906 PQclear (res);
908 if ((CONNECTION_OK != PQstatus (db->conn))
909 && (0 == c_psql_check_connection (db))) {
910 /* try again */
911 res = PQexecParams (db->conn, writer->statement,
912 STATIC_ARRAY_SIZE (params), NULL,
913 (const char *const *)params,
914 NULL, NULL, /* return text data */ 0);
916 if ((PGRES_COMMAND_OK == PQresultStatus (res))
917 || (PGRES_TUPLES_OK == PQresultStatus (res))) {
918 PQclear (res);
919 success = 1;
920 continue;
921 }
922 }
924 log_err ("Failed to execute SQL query: %s",
925 PQerrorMessage (db->conn));
926 log_info ("SQL query was: '%s', "
927 "params: %s, %s, %s, %s, %s, %s, %s, %s",
928 writer->statement,
929 params[0], params[1], params[2], params[3],
930 params[4], params[5], params[6], params[7]);
932 /* this will abort any current transaction -> restart */
933 if (db->next_commit > 0)
934 c_psql_commit (db);
936 pthread_mutex_unlock (&db->db_lock);
937 return -1;
938 }
940 PQclear (res);
941 success = 1;
942 }
944 if ((db->next_commit > 0)
945 && (cdtime () > db->next_commit))
946 c_psql_commit (db);
948 pthread_mutex_unlock (&db->db_lock);
950 if (! success)
951 return -1;
952 return 0;
953 } /* c_psql_write */
955 /* We cannot flush single identifiers as all we do is to commit the currently
956 * running transaction, thus making sure that all written data is actually
957 * visible to everybody. */
958 static int c_psql_flush (cdtime_t timeout,
959 __attribute__((unused)) const char *ident,
960 user_data_t *ud)
961 {
962 c_psql_database_t *dbs = databases;
963 size_t dbs_num = databases_num;
964 size_t i;
966 if ((ud != NULL) && (ud->data != NULL)) {
967 dbs = ud->data;
968 dbs_num = 1;
969 }
971 for (i = 0; i < dbs_num; ++i) {
972 c_psql_database_t *db = dbs + i;
974 /* don't commit if the timeout is larger than the regular commit
975 * interval as in that case all requested data has already been
976 * committed */
977 if ((db->next_commit > 0) && (db->commit_interval > timeout))
978 c_psql_commit (db);
979 }
980 return 0;
981 } /* c_psql_flush */
983 static int c_psql_shutdown (void)
984 {
985 size_t i = 0;
987 _Bool had_flush = 0;
989 plugin_unregister_read_group ("postgresql");
991 for (i = 0; i < databases_num; ++i) {
992 c_psql_database_t *db = databases + i;
994 if (db->writers_num > 0) {
995 char cb_name[DATA_MAX_NAME_LEN];
996 ssnprintf (cb_name, sizeof (cb_name), "postgresql-%s",
997 db->database);
999 if (! had_flush) {
1000 plugin_unregister_flush ("postgresql");
1001 had_flush = 1;
1002 }
1004 plugin_unregister_flush (cb_name);
1005 plugin_unregister_write (cb_name);
1006 }
1007 }
1009 udb_query_free (queries, queries_num);
1010 queries = NULL;
1011 queries_num = 0;
1013 sfree (writers);
1014 writers = NULL;
1015 writers_num = 0;
1017 sfree (databases);
1018 databases = NULL;
1019 databases_num = 0;
1021 return 0;
1022 } /* c_psql_shutdown */
1024 static int config_query_param_add (udb_query_t *q, oconfig_item_t *ci)
1025 {
1026 c_psql_user_data_t *data;
1027 const char *param_str;
1029 c_psql_param_t *tmp;
1031 data = udb_query_get_user_data (q);
1032 if (NULL == data) {
1033 data = (c_psql_user_data_t *) smalloc (sizeof (*data));
1034 if (NULL == data) {
1035 log_err ("Out of memory.");
1036 return -1;
1037 }
1038 memset (data, 0, sizeof (*data));
1039 data->params = NULL;
1040 }
1042 tmp = (c_psql_param_t *) realloc (data->params,
1043 (data->params_num + 1) * sizeof (c_psql_param_t));
1044 if (NULL == tmp) {
1045 log_err ("Out of memory.");
1046 return -1;
1047 }
1048 data->params = tmp;
1050 param_str = ci->values[0].value.string;
1051 if (0 == strcasecmp (param_str, "hostname"))
1052 data->params[data->params_num] = C_PSQL_PARAM_HOST;
1053 else if (0 == strcasecmp (param_str, "database"))
1054 data->params[data->params_num] = C_PSQL_PARAM_DB;
1055 else if (0 == strcasecmp (param_str, "username"))
1056 data->params[data->params_num] = C_PSQL_PARAM_USER;
1057 else if (0 == strcasecmp (param_str, "interval"))
1058 data->params[data->params_num] = C_PSQL_PARAM_INTERVAL;
1059 else if (0 == strcasecmp (param_str, "instance"))
1060 data->params[data->params_num] = C_PSQL_PARAM_INSTANCE;
1061 else {
1062 log_err ("Invalid parameter \"%s\".", param_str);
1063 return 1;
1064 }
1066 data->params_num++;
1067 udb_query_set_user_data (q, data);
1069 return (0);
1070 } /* config_query_param_add */
1072 static int config_query_callback (udb_query_t *q, oconfig_item_t *ci)
1073 {
1074 if (0 == strcasecmp ("Param", ci->key))
1075 return config_query_param_add (q, ci);
1077 log_err ("Option not allowed within a Query block: `%s'", ci->key);
1079 return (-1);
1080 } /* config_query_callback */
1082 static int config_add_writer (oconfig_item_t *ci,
1083 c_psql_writer_t *src_writers, size_t src_writers_num,
1084 c_psql_writer_t ***dst_writers, size_t *dst_writers_num)
1085 {
1086 char *name;
1088 size_t i;
1090 if ((ci == NULL) || (dst_writers == NULL) || (dst_writers_num == NULL))
1091 return -1;
1093 if ((ci->values_num != 1)
1094 || (ci->values[0].type != OCONFIG_TYPE_STRING)) {
1095 log_err ("`Writer' expects a single string argument.");
1096 return 1;
1097 }
1099 name = ci->values[0].value.string;
1101 for (i = 0; i < src_writers_num; ++i) {
1102 c_psql_writer_t **tmp;
1104 if (strcasecmp (name, src_writers[i].name) != 0)
1105 continue;
1107 tmp = (c_psql_writer_t **)realloc (*dst_writers,
1108 sizeof (**dst_writers) * (*dst_writers_num + 1));
1109 if (tmp == NULL) {
1110 log_err ("Out of memory.");
1111 return -1;
1112 }
1114 tmp[*dst_writers_num] = src_writers + i;
1116 *dst_writers = tmp;
1117 ++(*dst_writers_num);
1118 break;
1119 }
1121 if (i >= src_writers_num) {
1122 log_err ("No such writer: `%s'", name);
1123 return -1;
1124 }
1126 return 0;
1127 } /* config_add_writer */
1129 static int c_psql_config_writer (oconfig_item_t *ci)
1130 {
1131 c_psql_writer_t *writer;
1132 c_psql_writer_t *tmp;
1134 int status = 0;
1135 int i;
1137 if ((ci->values_num != 1)
1138 || (ci->values[0].type != OCONFIG_TYPE_STRING)) {
1139 log_err ("<Writer> expects a single string argument.");
1140 return 1;
1141 }
1143 tmp = (c_psql_writer_t *)realloc (writers,
1144 sizeof (*writers) * (writers_num + 1));
1145 if (tmp == NULL) {
1146 log_err ("Out of memory.");
1147 return -1;
1148 }
1150 writers = tmp;
1151 writer = writers + writers_num;
1152 ++writers_num;
1154 writer->name = sstrdup (ci->values[0].value.string);
1155 writer->statement = NULL;
1156 writer->store_rates = 1;
1158 for (i = 0; i < ci->children_num; ++i) {
1159 oconfig_item_t *c = ci->children + i;
1161 if (strcasecmp ("Statement", c->key) == 0)
1162 status = cf_util_get_string (c, &writer->statement);
1163 else if (strcasecmp ("StoreRates", c->key) == 0)
1164 status = cf_util_get_boolean (c, &writer->store_rates);
1165 else
1166 log_warn ("Ignoring unknown config key \"%s\".", c->key);
1167 }
1169 if (status != 0) {
1170 sfree (writer->statement);
1171 sfree (writer->name);
1172 sfree (writer);
1173 return status;
1174 }
1176 return 0;
1177 } /* c_psql_config_writer */
1179 static int c_psql_config_database (oconfig_item_t *ci)
1180 {
1181 c_psql_database_t *db;
1183 char cb_name[DATA_MAX_NAME_LEN];
1184 struct timespec cb_interval = { 0, 0 };
1185 user_data_t ud;
1187 static _Bool have_flush = 0;
1189 int i;
1191 if ((1 != ci->values_num)
1192 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1193 log_err ("<Database> expects a single string argument.");
1194 return 1;
1195 }
1197 memset (&ud, 0, sizeof (ud));
1199 db = c_psql_database_new (ci->values[0].value.string);
1200 if (db == NULL)
1201 return -1;
1203 for (i = 0; i < ci->children_num; ++i) {
1204 oconfig_item_t *c = ci->children + i;
1206 if (0 == strcasecmp (c->key, "Host"))
1207 cf_util_get_string (c, &db->host);
1208 else if (0 == strcasecmp (c->key, "Port"))
1209 cf_util_get_service (c, &db->port);
1210 else if (0 == strcasecmp (c->key, "User"))
1211 cf_util_get_string (c, &db->user);
1212 else if (0 == strcasecmp (c->key, "Password"))
1213 cf_util_get_string (c, &db->password);
1214 else if (0 == strcasecmp (c->key, "Instance"))
1215 cf_util_get_string (c, &db->instance);
1216 else if (0 == strcasecmp (c->key, "SSLMode"))
1217 cf_util_get_string (c, &db->sslmode);
1218 else if (0 == strcasecmp (c->key, "KRBSrvName"))
1219 cf_util_get_string (c, &db->krbsrvname);
1220 else if (0 == strcasecmp (c->key, "Service"))
1221 cf_util_get_string (c, &db->service);
1222 else if (0 == strcasecmp (c->key, "Query"))
1223 udb_query_pick_from_list (c, queries, queries_num,
1224 &db->queries, &db->queries_num);
1225 else if (0 == strcasecmp (c->key, "Writer"))
1226 config_add_writer (c, writers, writers_num,
1227 &db->writers, &db->writers_num);
1228 else if (0 == strcasecmp (c->key, "Interval"))
1229 cf_util_get_cdtime (c, &db->interval);
1230 else if (strcasecmp ("CommitInterval", c->key) == 0)
1231 cf_util_get_cdtime (c, &db->commit_interval);
1232 else
1233 log_warn ("Ignoring unknown config key \"%s\".", c->key);
1234 }
1236 /* If no `Query' options were given, add the default queries.. */
1237 if ((db->queries_num == 0) && (db->writers_num == 0)){
1238 for (i = 0; i < def_queries_num; i++)
1239 udb_query_pick_from_list_by_name (def_queries[i],
1240 queries, queries_num,
1241 &db->queries, &db->queries_num);
1242 }
1244 if (db->queries_num > 0) {
1245 db->q_prep_areas = (udb_query_preparation_area_t **) calloc (
1246 db->queries_num, sizeof (*db->q_prep_areas));
1248 if (db->q_prep_areas == NULL) {
1249 log_err ("Out of memory.");
1250 c_psql_database_delete (db);
1251 return -1;
1252 }
1253 }
1255 for (i = 0; (size_t)i < db->queries_num; ++i) {
1256 c_psql_user_data_t *data;
1257 data = udb_query_get_user_data (db->queries[i]);
1258 if ((data != NULL) && (data->params_num > db->max_params_num))
1259 db->max_params_num = data->params_num;
1261 db->q_prep_areas[i]
1262 = udb_query_allocate_preparation_area (db->queries[i]);
1264 if (db->q_prep_areas[i] == NULL) {
1265 log_err ("Out of memory.");
1266 c_psql_database_delete (db);
1267 return -1;
1268 }
1269 }
1271 ud.data = db;
1272 ud.free_func = c_psql_database_delete;
1274 ssnprintf (cb_name, sizeof (cb_name), "postgresql-%s", db->instance);
1276 if (db->queries_num > 0) {
1277 CDTIME_T_TO_TIMESPEC (db->interval, &cb_interval);
1279 ++db->ref_cnt;
1280 plugin_register_complex_read ("postgresql", cb_name, c_psql_read,
1281 /* interval = */ (db->interval > 0) ? &cb_interval : NULL,
1282 &ud);
1283 }
1284 if (db->writers_num > 0) {
1285 ++db->ref_cnt;
1286 plugin_register_write (cb_name, c_psql_write, &ud);
1288 if (! have_flush) {
1289 /* flush all */
1290 plugin_register_flush ("postgresql",
1291 c_psql_flush, /* user data = */ NULL);
1292 have_flush = 1;
1293 }
1295 /* flush this connection only */
1296 ++db->ref_cnt;
1297 plugin_register_flush (cb_name, c_psql_flush, &ud);
1298 }
1299 else if (db->commit_interval > 0) {
1300 log_warn ("Database '%s': You do not have any writers assigned to "
1301 "this database connection. Setting 'CommitInterval' does "
1302 "not have any effect.", db->database);
1303 }
1304 return 0;
1305 } /* c_psql_config_database */
1307 static int c_psql_config (oconfig_item_t *ci)
1308 {
1309 static int have_def_config = 0;
1311 int i;
1313 if (0 == have_def_config) {
1314 oconfig_item_t *c;
1316 have_def_config = 1;
1318 c = oconfig_parse_file (C_PSQL_DEFAULT_CONF);
1319 if (NULL == c)
1320 log_err ("Failed to read default config ("C_PSQL_DEFAULT_CONF").");
1321 else
1322 c_psql_config (c);
1324 if (NULL == queries)
1325 log_err ("Default config ("C_PSQL_DEFAULT_CONF") did not define "
1326 "any queries - please check your installation.");
1327 }
1329 for (i = 0; i < ci->children_num; ++i) {
1330 oconfig_item_t *c = ci->children + i;
1332 if (0 == strcasecmp (c->key, "Query"))
1333 udb_query_create (&queries, &queries_num, c,
1334 /* callback = */ config_query_callback);
1335 else if (0 == strcasecmp (c->key, "Writer"))
1336 c_psql_config_writer (c);
1337 else if (0 == strcasecmp (c->key, "Database"))
1338 c_psql_config_database (c);
1339 else
1340 log_warn ("Ignoring unknown config key \"%s\".", c->key);
1341 }
1342 return 0;
1343 } /* c_psql_config */
1345 void module_register (void)
1346 {
1347 plugin_register_complex_config ("postgresql", c_psql_config);
1348 plugin_register_shutdown ("postgresql", c_psql_shutdown);
1349 } /* module_register */
1351 /* vim: set sw=4 ts=4 tw=78 noexpandtab : */