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 **tmp;
224 c_psql_database_t *db;
226 db = (c_psql_database_t *)malloc (sizeof(*db));
227 if (NULL == db) {
228 log_err ("Out of memory.");
229 return NULL;
230 }
232 tmp = (c_psql_database_t **)realloc (databases,
233 (databases_num + 1) * sizeof (*databases));
234 if (NULL == tmp) {
235 log_err ("Out of memory.");
236 sfree (db);
237 return NULL;
238 }
240 databases = tmp;
241 databases[databases_num] = db;
242 ++databases_num;
244 db->conn = NULL;
246 C_COMPLAIN_INIT (&db->conn_complaint);
248 db->proto_version = 0;
249 db->server_version = 0;
251 db->max_params_num = 0;
253 db->q_prep_areas = NULL;
254 db->queries = NULL;
255 db->queries_num = 0;
257 db->writers = NULL;
258 db->writers_num = 0;
260 pthread_mutex_init (&db->db_lock, /* attrs = */ NULL);
262 db->interval = 0;
264 db->commit_interval = 0;
265 db->next_commit = 0;
267 db->database = sstrdup (name);
268 db->host = NULL;
269 db->port = NULL;
270 db->user = NULL;
271 db->password = NULL;
273 db->instance = sstrdup (name);
275 db->sslmode = NULL;
277 db->krbsrvname = NULL;
279 db->service = NULL;
281 db->ref_cnt = 0;
282 return db;
283 } /* c_psql_database_new */
285 static void c_psql_database_delete (void *data)
286 {
287 size_t i;
289 c_psql_database_t *db = data;
291 --db->ref_cnt;
292 /* readers and writers may access this database */
293 if (db->ref_cnt > 0)
294 return;
296 /* wait for the lock to be released by the last writer */
297 pthread_mutex_lock (&db->db_lock);
299 if (db->next_commit > 0)
300 c_psql_commit (db);
302 PQfinish (db->conn);
303 db->conn = NULL;
305 if (db->q_prep_areas)
306 for (i = 0; i < db->queries_num; ++i)
307 udb_query_delete_preparation_area (db->q_prep_areas[i]);
308 free (db->q_prep_areas);
310 sfree (db->queries);
311 db->queries_num = 0;
313 sfree (db->writers);
314 db->writers_num = 0;
316 pthread_mutex_unlock (&db->db_lock);
318 pthread_mutex_destroy (&db->db_lock);
320 sfree (db->database);
321 sfree (db->host);
322 sfree (db->port);
323 sfree (db->user);
324 sfree (db->password);
326 sfree (db->instance);
328 sfree (db->sslmode);
330 sfree (db->krbsrvname);
332 sfree (db->service);
334 /* don't care about freeing or reordering the 'databases' array
335 * this is done in 'shutdown'; also, don't free the database instance
336 * object just to make sure that in case anybody accesses it before
337 * shutdown won't segfault */
338 return;
339 } /* c_psql_database_delete */
341 static int c_psql_connect (c_psql_database_t *db)
342 {
343 char conninfo[4096];
344 char *buf = conninfo;
345 int buf_len = sizeof (conninfo);
346 int status;
348 if ((! db) || (! db->database))
349 return -1;
351 status = ssnprintf (buf, buf_len, "dbname = '%s'", db->database);
352 if (0 < status) {
353 buf += status;
354 buf_len -= status;
355 }
357 C_PSQL_PAR_APPEND (buf, buf_len, "host", db->host);
358 C_PSQL_PAR_APPEND (buf, buf_len, "port", db->port);
359 C_PSQL_PAR_APPEND (buf, buf_len, "user", db->user);
360 C_PSQL_PAR_APPEND (buf, buf_len, "password", db->password);
361 C_PSQL_PAR_APPEND (buf, buf_len, "sslmode", db->sslmode);
362 C_PSQL_PAR_APPEND (buf, buf_len, "krbsrvname", db->krbsrvname);
363 C_PSQL_PAR_APPEND (buf, buf_len, "service", db->service);
365 db->conn = PQconnectdb (conninfo);
366 db->proto_version = PQprotocolVersion (db->conn);
367 return 0;
368 } /* c_psql_connect */
370 static int c_psql_check_connection (c_psql_database_t *db)
371 {
372 _Bool init = 0;
374 if (! db->conn) {
375 init = 1;
377 /* trigger c_release() */
378 if (0 == db->conn_complaint.interval)
379 db->conn_complaint.interval = 1;
381 c_psql_connect (db);
382 }
384 if (CONNECTION_OK != PQstatus (db->conn)) {
385 PQreset (db->conn);
387 /* trigger c_release() */
388 if (0 == db->conn_complaint.interval)
389 db->conn_complaint.interval = 1;
391 if (CONNECTION_OK != PQstatus (db->conn)) {
392 c_complain (LOG_ERR, &db->conn_complaint,
393 "Failed to connect to database %s (%s): %s",
394 db->database, db->instance,
395 PQerrorMessage (db->conn));
396 return -1;
397 }
399 db->proto_version = PQprotocolVersion (db->conn);
400 }
402 db->server_version = PQserverVersion (db->conn);
404 if (c_would_release (&db->conn_complaint)) {
405 char *server_host;
406 int server_version;
408 server_host = PQhost (db->conn);
409 server_version = PQserverVersion (db->conn);
411 c_do_release (LOG_INFO, &db->conn_complaint,
412 "Successfully %sconnected to database %s (user %s) "
413 "at server %s%s%s (server version: %d.%d.%d, "
414 "protocol version: %d, pid: %d)", init ? "" : "re",
415 PQdb (db->conn), PQuser (db->conn),
416 C_PSQL_SOCKET3 (server_host, PQport (db->conn)),
417 C_PSQL_SERVER_VERSION3 (server_version),
418 db->proto_version, PQbackendPID (db->conn));
420 if (3 > db->proto_version)
421 log_warn ("Protocol version %d does not support parameters.",
422 db->proto_version);
423 }
424 return 0;
425 } /* c_psql_check_connection */
427 static PGresult *c_psql_exec_query_noparams (c_psql_database_t *db,
428 udb_query_t *q)
429 {
430 return PQexec (db->conn, udb_query_get_statement (q));
431 } /* c_psql_exec_query_noparams */
433 static PGresult *c_psql_exec_query_params (c_psql_database_t *db,
434 udb_query_t *q, c_psql_user_data_t *data)
435 {
436 char *params[db->max_params_num];
437 char interval[64];
438 int i;
440 if ((data == NULL) || (data->params_num == 0))
441 return (c_psql_exec_query_noparams (db, q));
443 assert (db->max_params_num >= data->params_num);
445 for (i = 0; i < data->params_num; ++i) {
446 switch (data->params[i]) {
447 case C_PSQL_PARAM_HOST:
448 params[i] = C_PSQL_IS_UNIX_DOMAIN_SOCKET (db->host)
449 ? "localhost" : db->host;
450 break;
451 case C_PSQL_PARAM_DB:
452 params[i] = db->database;
453 break;
454 case C_PSQL_PARAM_USER:
455 params[i] = db->user;
456 break;
457 case C_PSQL_PARAM_INTERVAL:
458 ssnprintf (interval, sizeof (interval), "%.3f",
459 (db->interval > 0)
460 ? CDTIME_T_TO_DOUBLE (db->interval)
461 : plugin_get_interval ());
462 params[i] = interval;
463 break;
464 case C_PSQL_PARAM_INSTANCE:
465 params[i] = db->instance;
466 break;
467 default:
468 assert (0);
469 }
470 }
472 return PQexecParams (db->conn, udb_query_get_statement (q),
473 data->params_num, NULL,
474 (const char *const *) params,
475 NULL, NULL, /* return text data */ 0);
476 } /* c_psql_exec_query_params */
478 /* db->db_lock must be locked when calling this function */
479 static int c_psql_exec_query (c_psql_database_t *db, udb_query_t *q,
480 udb_query_preparation_area_t *prep_area)
481 {
482 PGresult *res;
484 c_psql_user_data_t *data;
486 const char *host;
488 char **column_names;
489 char **column_values;
490 int column_num;
492 int rows_num;
493 int status;
494 int row, col;
496 /* The user data may hold parameter information, but may be NULL. */
497 data = udb_query_get_user_data (q);
499 /* Versions up to `3' don't know how to handle parameters. */
500 if (3 <= db->proto_version)
501 res = c_psql_exec_query_params (db, q, data);
502 else if ((NULL == data) || (0 == data->params_num))
503 res = c_psql_exec_query_noparams (db, q);
504 else {
505 log_err ("Connection to database \"%s\" (%s) does not support "
506 "parameters (protocol version %d) - "
507 "cannot execute query \"%s\".",
508 db->database, db->instance, db->proto_version,
509 udb_query_get_name (q));
510 return -1;
511 }
513 /* give c_psql_write() a chance to acquire the lock if called recursively
514 * through dispatch_values(); this will happen if, both, queries and
515 * writers are configured for a single connection */
516 pthread_mutex_unlock (&db->db_lock);
518 column_names = NULL;
519 column_values = NULL;
521 if (PGRES_TUPLES_OK != PQresultStatus (res)) {
522 pthread_mutex_lock (&db->db_lock);
524 if ((CONNECTION_OK != PQstatus (db->conn))
525 && (0 == c_psql_check_connection (db))) {
526 PQclear (res);
527 return c_psql_exec_query (db, q, prep_area);
528 }
530 log_err ("Failed to execute SQL query: %s",
531 PQerrorMessage (db->conn));
532 log_info ("SQL query was: %s",
533 udb_query_get_statement (q));
534 PQclear (res);
535 return -1;
536 }
538 #define BAIL_OUT(status) \
539 sfree (column_names); \
540 sfree (column_values); \
541 PQclear (res); \
542 pthread_mutex_lock (&db->db_lock); \
543 return status
545 rows_num = PQntuples (res);
546 if (1 > rows_num) {
547 BAIL_OUT (0);
548 }
550 column_num = PQnfields (res);
551 column_names = (char **) calloc (column_num, sizeof (char *));
552 if (NULL == column_names) {
553 log_err ("calloc failed.");
554 BAIL_OUT (-1);
555 }
557 column_values = (char **) calloc (column_num, sizeof (char *));
558 if (NULL == column_values) {
559 log_err ("calloc failed.");
560 BAIL_OUT (-1);
561 }
563 for (col = 0; col < column_num; ++col) {
564 /* Pointers returned by `PQfname' are freed by `PQclear' via
565 * `BAIL_OUT'. */
566 column_names[col] = PQfname (res, col);
567 if (NULL == column_names[col]) {
568 log_err ("Failed to resolve name of column %i.", col);
569 BAIL_OUT (-1);
570 }
571 }
573 if (C_PSQL_IS_UNIX_DOMAIN_SOCKET (db->host)
574 || (0 == strcmp (db->host, "127.0.0.1"))
575 || (0 == strcmp (db->host, "localhost")))
576 host = hostname_g;
577 else
578 host = db->host;
580 status = udb_query_prepare_result (q, prep_area, host, "postgresql",
581 db->instance, column_names, (size_t) column_num, db->interval);
582 if (0 != status) {
583 log_err ("udb_query_prepare_result failed with status %i.",
584 status);
585 BAIL_OUT (-1);
586 }
588 for (row = 0; row < rows_num; ++row) {
589 for (col = 0; col < column_num; ++col) {
590 /* Pointers returned by `PQgetvalue' are freed by `PQclear' via
591 * `BAIL_OUT'. */
592 column_values[col] = PQgetvalue (res, row, col);
593 if (NULL == column_values[col]) {
594 log_err ("Failed to get value at (row = %i, col = %i).",
595 row, col);
596 break;
597 }
598 }
600 /* check for an error */
601 if (col < column_num)
602 continue;
604 status = udb_query_handle_result (q, prep_area, column_values);
605 if (status != 0) {
606 log_err ("udb_query_handle_result failed with status %i.",
607 status);
608 }
609 } /* for (row = 0; row < rows_num; ++row) */
611 udb_query_finish_result (q, prep_area);
613 BAIL_OUT (0);
614 #undef BAIL_OUT
615 } /* c_psql_exec_query */
617 static int c_psql_read (user_data_t *ud)
618 {
619 c_psql_database_t *db;
621 int success = 0;
622 int i;
624 if ((ud == NULL) || (ud->data == NULL)) {
625 log_err ("c_psql_read: Invalid user data.");
626 return -1;
627 }
629 db = ud->data;
631 assert (NULL != db->database);
632 assert (NULL != db->instance);
633 assert (NULL != db->queries);
635 pthread_mutex_lock (&db->db_lock);
637 if (0 != c_psql_check_connection (db)) {
638 pthread_mutex_unlock (&db->db_lock);
639 return -1;
640 }
642 for (i = 0; i < db->queries_num; ++i)
643 {
644 udb_query_preparation_area_t *prep_area;
645 udb_query_t *q;
647 prep_area = db->q_prep_areas[i];
648 q = db->queries[i];
650 if ((0 != db->server_version)
651 && (udb_query_check_version (q, db->server_version) <= 0))
652 continue;
654 if (0 == c_psql_exec_query (db, q, prep_area))
655 success = 1;
656 }
658 pthread_mutex_unlock (&db->db_lock);
660 if (! success)
661 return -1;
662 return 0;
663 } /* c_psql_read */
665 static char *values_name_to_sqlarray (const data_set_t *ds,
666 char *string, size_t string_len)
667 {
668 char *str_ptr;
669 size_t str_len;
671 int i;
673 str_ptr = string;
674 str_len = string_len;
676 for (i = 0; i < ds->ds_num; ++i) {
677 int status = ssnprintf (str_ptr, str_len, ",'%s'", ds->ds[i].name);
679 if (status < 1)
680 return NULL;
681 else if ((size_t)status >= str_len) {
682 str_len = 0;
683 break;
684 }
685 else {
686 str_ptr += status;
687 str_len -= (size_t)status;
688 }
689 }
691 if (str_len <= 2) {
692 log_err ("c_psql_write: Failed to stringify value names");
693 return NULL;
694 }
696 /* overwrite the first comma */
697 string[0] = '{';
698 str_ptr[0] = '}';
699 str_ptr[1] = '\0';
701 return string;
702 } /* values_name_to_sqlarray */
704 static char *values_type_to_sqlarray (const data_set_t *ds,
705 char *string, size_t string_len, _Bool store_rates)
706 {
707 char *str_ptr;
708 size_t str_len;
710 int i;
712 str_ptr = string;
713 str_len = string_len;
715 for (i = 0; i < ds->ds_num; ++i) {
716 int status;
718 if (store_rates)
719 status = ssnprintf(str_ptr, str_len, ",'gauge'");
720 else
721 status = ssnprintf(str_ptr, str_len, ",'%s'",
722 DS_TYPE_TO_STRING (ds->ds[i].type));
724 if (status < 1) {
725 str_len = 0;
726 break;
727 }
728 else if ((size_t)status >= str_len) {
729 str_len = 0;
730 break;
731 }
732 else {
733 str_ptr += status;
734 str_len -= (size_t)status;
735 }
736 }
738 if (str_len <= 2) {
739 log_err ("c_psql_write: Failed to stringify value types");
740 return NULL;
741 }
743 /* overwrite the first comma */
744 string[0] = '{';
745 str_ptr[0] = '}';
746 str_ptr[1] = '\0';
748 return string;
749 } /* values_type_to_sqlarray */
751 static char *values_to_sqlarray (const data_set_t *ds, const value_list_t *vl,
752 char *string, size_t string_len, _Bool store_rates)
753 {
754 char *str_ptr;
755 size_t str_len;
757 gauge_t *rates = NULL;
759 int i;
761 str_ptr = string;
762 str_len = string_len;
764 for (i = 0; i < vl->values_len; ++i) {
765 int status = 0;
767 if ((ds->ds[i].type != DS_TYPE_GAUGE)
768 && (ds->ds[i].type != DS_TYPE_COUNTER)
769 && (ds->ds[i].type != DS_TYPE_DERIVE)
770 && (ds->ds[i].type != DS_TYPE_ABSOLUTE)) {
771 log_err ("c_psql_write: Unknown data source type: %i",
772 ds->ds[i].type);
773 sfree (rates);
774 return NULL;
775 }
777 if (ds->ds[i].type == DS_TYPE_GAUGE)
778 status = ssnprintf (str_ptr, str_len,
779 ",%f", vl->values[i].gauge);
780 else if (store_rates) {
781 if (rates == NULL)
782 rates = uc_get_rate (ds, vl);
784 if (rates == NULL) {
785 log_err ("c_psql_write: Failed to determine rate");
786 return NULL;
787 }
789 status = ssnprintf (str_ptr, str_len,
790 ",%lf", rates[i]);
791 }
792 else if (ds->ds[i].type == DS_TYPE_COUNTER)
793 status = ssnprintf (str_ptr, str_len,
794 ",%llu", vl->values[i].counter);
795 else if (ds->ds[i].type == DS_TYPE_DERIVE)
796 status = ssnprintf (str_ptr, str_len,
797 ",%"PRIi64, vl->values[i].derive);
798 else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
799 status = ssnprintf (str_ptr, str_len,
800 ",%"PRIu64, vl->values[i].absolute);
802 if (status < 1) {
803 str_len = 0;
804 break;
805 }
806 else if ((size_t)status >= str_len) {
807 str_len = 0;
808 break;
809 }
810 else {
811 str_ptr += status;
812 str_len -= (size_t)status;
813 }
814 }
816 sfree (rates);
818 if (str_len <= 2) {
819 log_err ("c_psql_write: Failed to stringify value list");
820 return NULL;
821 }
823 /* overwrite the first comma */
824 string[0] = '{';
825 str_ptr[0] = '}';
826 str_ptr[1] = '\0';
828 return string;
829 } /* values_to_sqlarray */
831 static int c_psql_write (const data_set_t *ds, const value_list_t *vl,
832 user_data_t *ud)
833 {
834 c_psql_database_t *db;
836 char time_str[32];
837 char values_name_str[1024];
838 char values_type_str[1024];
839 char values_str[1024];
841 const char *params[9];
843 int success = 0;
844 int i;
846 if ((ud == NULL) || (ud->data == NULL)) {
847 log_err ("c_psql_write: Invalid user data.");
848 return -1;
849 }
851 db = ud->data;
852 assert (db->database != NULL);
853 assert (db->writers != NULL);
855 if (cdtime_to_iso8601 (time_str, sizeof (time_str), vl->time) == 0) {
856 log_err ("c_psql_write: Failed to convert time to ISO 8601 format");
857 return -1;
858 }
860 if (values_name_to_sqlarray (ds,
861 values_name_str, sizeof (values_name_str)) == NULL)
862 return -1;
864 #define VALUE_OR_NULL(v) ((((v) == NULL) || (*(v) == '\0')) ? NULL : (v))
866 params[0] = time_str;
867 params[1] = vl->host;
868 params[2] = vl->plugin;
869 params[3] = VALUE_OR_NULL(vl->plugin_instance);
870 params[4] = vl->type;
871 params[5] = VALUE_OR_NULL(vl->type_instance);
872 params[6] = values_name_str;
874 #undef VALUE_OR_NULL
876 pthread_mutex_lock (&db->db_lock);
878 if (0 != c_psql_check_connection (db)) {
879 pthread_mutex_unlock (&db->db_lock);
880 return -1;
881 }
883 if ((db->commit_interval > 0)
884 && (db->next_commit == 0))
885 c_psql_begin (db);
887 for (i = 0; i < db->writers_num; ++i) {
888 c_psql_writer_t *writer;
889 PGresult *res;
891 writer = db->writers[i];
893 if (values_type_to_sqlarray (ds,
894 values_type_str, sizeof (values_type_str),
895 writer->store_rates) == NULL) {
896 pthread_mutex_unlock (&db->db_lock);
897 return -1;
898 }
900 if (values_to_sqlarray (ds, vl,
901 values_str, sizeof (values_str),
902 writer->store_rates) == NULL) {
903 pthread_mutex_unlock (&db->db_lock);
904 return -1;
905 }
907 params[7] = values_type_str;
908 params[8] = values_str;
910 res = PQexecParams (db->conn, writer->statement,
911 STATIC_ARRAY_SIZE (params), NULL,
912 (const char *const *)params,
913 NULL, NULL, /* return text data */ 0);
915 if ((PGRES_COMMAND_OK != PQresultStatus (res))
916 && (PGRES_TUPLES_OK != PQresultStatus (res))) {
917 PQclear (res);
919 if ((CONNECTION_OK != PQstatus (db->conn))
920 && (0 == c_psql_check_connection (db))) {
921 /* try again */
922 res = PQexecParams (db->conn, writer->statement,
923 STATIC_ARRAY_SIZE (params), NULL,
924 (const char *const *)params,
925 NULL, NULL, /* return text data */ 0);
927 if ((PGRES_COMMAND_OK == PQresultStatus (res))
928 || (PGRES_TUPLES_OK == PQresultStatus (res))) {
929 PQclear (res);
930 success = 1;
931 continue;
932 }
933 }
935 log_err ("Failed to execute SQL query: %s",
936 PQerrorMessage (db->conn));
937 log_info ("SQL query was: '%s', "
938 "params: %s, %s, %s, %s, %s, %s, %s, %s",
939 writer->statement,
940 params[0], params[1], params[2], params[3],
941 params[4], params[5], params[6], params[7]);
943 /* this will abort any current transaction -> restart */
944 if (db->next_commit > 0)
945 c_psql_commit (db);
947 pthread_mutex_unlock (&db->db_lock);
948 return -1;
949 }
951 PQclear (res);
952 success = 1;
953 }
955 if ((db->next_commit > 0)
956 && (cdtime () > db->next_commit))
957 c_psql_commit (db);
959 pthread_mutex_unlock (&db->db_lock);
961 if (! success)
962 return -1;
963 return 0;
964 } /* c_psql_write */
966 /* We cannot flush single identifiers as all we do is to commit the currently
967 * running transaction, thus making sure that all written data is actually
968 * visible to everybody. */
969 static int c_psql_flush (cdtime_t timeout,
970 __attribute__((unused)) const char *ident,
971 user_data_t *ud)
972 {
973 c_psql_database_t **dbs = databases;
974 size_t dbs_num = databases_num;
975 size_t i;
977 if ((ud != NULL) && (ud->data != NULL)) {
978 dbs = (void *)&ud->data;
979 dbs_num = 1;
980 }
982 for (i = 0; i < dbs_num; ++i) {
983 c_psql_database_t *db = dbs[i];
985 /* don't commit if the timeout is larger than the regular commit
986 * interval as in that case all requested data has already been
987 * committed */
988 if ((db->next_commit > 0) && (db->commit_interval > timeout))
989 c_psql_commit (db);
990 }
991 return 0;
992 } /* c_psql_flush */
994 static int c_psql_shutdown (void)
995 {
996 size_t i = 0;
998 _Bool had_flush = 0;
1000 plugin_unregister_read_group ("postgresql");
1002 for (i = 0; i < databases_num; ++i) {
1003 c_psql_database_t *db = databases[i];
1005 if (db->writers_num > 0) {
1006 char cb_name[DATA_MAX_NAME_LEN];
1007 ssnprintf (cb_name, sizeof (cb_name), "postgresql-%s",
1008 db->database);
1010 if (! had_flush) {
1011 plugin_unregister_flush ("postgresql");
1012 had_flush = 1;
1013 }
1015 plugin_unregister_flush (cb_name);
1016 plugin_unregister_write (cb_name);
1017 }
1019 sfree (db);
1020 }
1022 udb_query_free (queries, queries_num);
1023 queries = NULL;
1024 queries_num = 0;
1026 sfree (writers);
1027 writers = NULL;
1028 writers_num = 0;
1030 sfree (databases);
1031 databases = NULL;
1032 databases_num = 0;
1034 return 0;
1035 } /* c_psql_shutdown */
1037 static int config_query_param_add (udb_query_t *q, oconfig_item_t *ci)
1038 {
1039 c_psql_user_data_t *data;
1040 const char *param_str;
1042 c_psql_param_t *tmp;
1044 data = udb_query_get_user_data (q);
1045 if (NULL == data) {
1046 data = (c_psql_user_data_t *) smalloc (sizeof (*data));
1047 if (NULL == data) {
1048 log_err ("Out of memory.");
1049 return -1;
1050 }
1051 memset (data, 0, sizeof (*data));
1052 data->params = NULL;
1053 }
1055 tmp = (c_psql_param_t *) realloc (data->params,
1056 (data->params_num + 1) * sizeof (c_psql_param_t));
1057 if (NULL == tmp) {
1058 log_err ("Out of memory.");
1059 return -1;
1060 }
1061 data->params = tmp;
1063 param_str = ci->values[0].value.string;
1064 if (0 == strcasecmp (param_str, "hostname"))
1065 data->params[data->params_num] = C_PSQL_PARAM_HOST;
1066 else if (0 == strcasecmp (param_str, "database"))
1067 data->params[data->params_num] = C_PSQL_PARAM_DB;
1068 else if (0 == strcasecmp (param_str, "username"))
1069 data->params[data->params_num] = C_PSQL_PARAM_USER;
1070 else if (0 == strcasecmp (param_str, "interval"))
1071 data->params[data->params_num] = C_PSQL_PARAM_INTERVAL;
1072 else if (0 == strcasecmp (param_str, "instance"))
1073 data->params[data->params_num] = C_PSQL_PARAM_INSTANCE;
1074 else {
1075 log_err ("Invalid parameter \"%s\".", param_str);
1076 return 1;
1077 }
1079 data->params_num++;
1080 udb_query_set_user_data (q, data);
1082 return (0);
1083 } /* config_query_param_add */
1085 static int config_query_callback (udb_query_t *q, oconfig_item_t *ci)
1086 {
1087 if (0 == strcasecmp ("Param", ci->key))
1088 return config_query_param_add (q, ci);
1090 log_err ("Option not allowed within a Query block: `%s'", ci->key);
1092 return (-1);
1093 } /* config_query_callback */
1095 static int config_add_writer (oconfig_item_t *ci,
1096 c_psql_writer_t *src_writers, size_t src_writers_num,
1097 c_psql_writer_t ***dst_writers, size_t *dst_writers_num)
1098 {
1099 char *name;
1101 size_t i;
1103 if ((ci == NULL) || (dst_writers == NULL) || (dst_writers_num == NULL))
1104 return -1;
1106 if ((ci->values_num != 1)
1107 || (ci->values[0].type != OCONFIG_TYPE_STRING)) {
1108 log_err ("`Writer' expects a single string argument.");
1109 return 1;
1110 }
1112 name = ci->values[0].value.string;
1114 for (i = 0; i < src_writers_num; ++i) {
1115 c_psql_writer_t **tmp;
1117 if (strcasecmp (name, src_writers[i].name) != 0)
1118 continue;
1120 tmp = (c_psql_writer_t **)realloc (*dst_writers,
1121 sizeof (**dst_writers) * (*dst_writers_num + 1));
1122 if (tmp == NULL) {
1123 log_err ("Out of memory.");
1124 return -1;
1125 }
1127 tmp[*dst_writers_num] = src_writers + i;
1129 *dst_writers = tmp;
1130 ++(*dst_writers_num);
1131 break;
1132 }
1134 if (i >= src_writers_num) {
1135 log_err ("No such writer: `%s'", name);
1136 return -1;
1137 }
1139 return 0;
1140 } /* config_add_writer */
1142 static int c_psql_config_writer (oconfig_item_t *ci)
1143 {
1144 c_psql_writer_t *writer;
1145 c_psql_writer_t *tmp;
1147 int status = 0;
1148 int i;
1150 if ((ci->values_num != 1)
1151 || (ci->values[0].type != OCONFIG_TYPE_STRING)) {
1152 log_err ("<Writer> expects a single string argument.");
1153 return 1;
1154 }
1156 tmp = (c_psql_writer_t *)realloc (writers,
1157 sizeof (*writers) * (writers_num + 1));
1158 if (tmp == NULL) {
1159 log_err ("Out of memory.");
1160 return -1;
1161 }
1163 writers = tmp;
1164 writer = writers + writers_num;
1165 ++writers_num;
1167 writer->name = sstrdup (ci->values[0].value.string);
1168 writer->statement = NULL;
1169 writer->store_rates = 1;
1171 for (i = 0; i < ci->children_num; ++i) {
1172 oconfig_item_t *c = ci->children + i;
1174 if (strcasecmp ("Statement", c->key) == 0)
1175 status = cf_util_get_string (c, &writer->statement);
1176 else if (strcasecmp ("StoreRates", c->key) == 0)
1177 status = cf_util_get_boolean (c, &writer->store_rates);
1178 else
1179 log_warn ("Ignoring unknown config key \"%s\".", c->key);
1180 }
1182 if (status != 0) {
1183 sfree (writer->statement);
1184 sfree (writer->name);
1185 sfree (writer);
1186 return status;
1187 }
1189 return 0;
1190 } /* c_psql_config_writer */
1192 static int c_psql_config_database (oconfig_item_t *ci)
1193 {
1194 c_psql_database_t *db;
1196 char cb_name[DATA_MAX_NAME_LEN];
1197 struct timespec cb_interval = { 0, 0 };
1198 user_data_t ud;
1200 static _Bool have_flush = 0;
1202 int i;
1204 if ((1 != ci->values_num)
1205 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1206 log_err ("<Database> expects a single string argument.");
1207 return 1;
1208 }
1210 memset (&ud, 0, sizeof (ud));
1212 db = c_psql_database_new (ci->values[0].value.string);
1213 if (db == NULL)
1214 return -1;
1216 for (i = 0; i < ci->children_num; ++i) {
1217 oconfig_item_t *c = ci->children + i;
1219 if (0 == strcasecmp (c->key, "Host"))
1220 cf_util_get_string (c, &db->host);
1221 else if (0 == strcasecmp (c->key, "Port"))
1222 cf_util_get_service (c, &db->port);
1223 else if (0 == strcasecmp (c->key, "User"))
1224 cf_util_get_string (c, &db->user);
1225 else if (0 == strcasecmp (c->key, "Password"))
1226 cf_util_get_string (c, &db->password);
1227 else if (0 == strcasecmp (c->key, "Instance"))
1228 cf_util_get_string (c, &db->instance);
1229 else if (0 == strcasecmp (c->key, "SSLMode"))
1230 cf_util_get_string (c, &db->sslmode);
1231 else if (0 == strcasecmp (c->key, "KRBSrvName"))
1232 cf_util_get_string (c, &db->krbsrvname);
1233 else if (0 == strcasecmp (c->key, "Service"))
1234 cf_util_get_string (c, &db->service);
1235 else if (0 == strcasecmp (c->key, "Query"))
1236 udb_query_pick_from_list (c, queries, queries_num,
1237 &db->queries, &db->queries_num);
1238 else if (0 == strcasecmp (c->key, "Writer"))
1239 config_add_writer (c, writers, writers_num,
1240 &db->writers, &db->writers_num);
1241 else if (0 == strcasecmp (c->key, "Interval"))
1242 cf_util_get_cdtime (c, &db->interval);
1243 else if (strcasecmp ("CommitInterval", c->key) == 0)
1244 cf_util_get_cdtime (c, &db->commit_interval);
1245 else
1246 log_warn ("Ignoring unknown config key \"%s\".", c->key);
1247 }
1249 /* If no `Query' options were given, add the default queries.. */
1250 if ((db->queries_num == 0) && (db->writers_num == 0)){
1251 for (i = 0; i < def_queries_num; i++)
1252 udb_query_pick_from_list_by_name (def_queries[i],
1253 queries, queries_num,
1254 &db->queries, &db->queries_num);
1255 }
1257 if (db->queries_num > 0) {
1258 db->q_prep_areas = (udb_query_preparation_area_t **) calloc (
1259 db->queries_num, sizeof (*db->q_prep_areas));
1261 if (db->q_prep_areas == NULL) {
1262 log_err ("Out of memory.");
1263 c_psql_database_delete (db);
1264 return -1;
1265 }
1266 }
1268 for (i = 0; (size_t)i < db->queries_num; ++i) {
1269 c_psql_user_data_t *data;
1270 data = udb_query_get_user_data (db->queries[i]);
1271 if ((data != NULL) && (data->params_num > db->max_params_num))
1272 db->max_params_num = data->params_num;
1274 db->q_prep_areas[i]
1275 = udb_query_allocate_preparation_area (db->queries[i]);
1277 if (db->q_prep_areas[i] == NULL) {
1278 log_err ("Out of memory.");
1279 c_psql_database_delete (db);
1280 return -1;
1281 }
1282 }
1284 ud.data = db;
1285 ud.free_func = c_psql_database_delete;
1287 ssnprintf (cb_name, sizeof (cb_name), "postgresql-%s", db->instance);
1289 if (db->queries_num > 0) {
1290 CDTIME_T_TO_TIMESPEC (db->interval, &cb_interval);
1292 ++db->ref_cnt;
1293 plugin_register_complex_read ("postgresql", cb_name, c_psql_read,
1294 /* interval = */ (db->interval > 0) ? &cb_interval : NULL,
1295 &ud);
1296 }
1297 if (db->writers_num > 0) {
1298 ++db->ref_cnt;
1299 plugin_register_write (cb_name, c_psql_write, &ud);
1301 if (! have_flush) {
1302 /* flush all */
1303 plugin_register_flush ("postgresql",
1304 c_psql_flush, /* user data = */ NULL);
1305 have_flush = 1;
1306 }
1308 /* flush this connection only */
1309 ++db->ref_cnt;
1310 plugin_register_flush (cb_name, c_psql_flush, &ud);
1311 }
1312 else if (db->commit_interval > 0) {
1313 log_warn ("Database '%s': You do not have any writers assigned to "
1314 "this database connection. Setting 'CommitInterval' does "
1315 "not have any effect.", db->database);
1316 }
1317 return 0;
1318 } /* c_psql_config_database */
1320 static int c_psql_config (oconfig_item_t *ci)
1321 {
1322 static int have_def_config = 0;
1324 int i;
1326 if (0 == have_def_config) {
1327 oconfig_item_t *c;
1329 have_def_config = 1;
1331 c = oconfig_parse_file (C_PSQL_DEFAULT_CONF);
1332 if (NULL == c)
1333 log_err ("Failed to read default config ("C_PSQL_DEFAULT_CONF").");
1334 else
1335 c_psql_config (c);
1337 if (NULL == queries)
1338 log_err ("Default config ("C_PSQL_DEFAULT_CONF") did not define "
1339 "any queries - please check your installation.");
1340 }
1342 for (i = 0; i < ci->children_num; ++i) {
1343 oconfig_item_t *c = ci->children + i;
1345 if (0 == strcasecmp (c->key, "Query"))
1346 udb_query_create (&queries, &queries_num, c,
1347 /* callback = */ config_query_callback);
1348 else if (0 == strcasecmp (c->key, "Writer"))
1349 c_psql_config_writer (c);
1350 else if (0 == strcasecmp (c->key, "Database"))
1351 c_psql_config_database (c);
1352 else
1353 log_warn ("Ignoring unknown config key \"%s\".", c->key);
1354 }
1355 return 0;
1356 } /* c_psql_config */
1358 void module_register (void)
1359 {
1360 plugin_register_complex_config ("postgresql", c_psql_config);
1361 plugin_register_shutdown ("postgresql", c_psql_shutdown);
1362 } /* module_register */
1364 /* vim: set sw=4 ts=4 tw=78 noexpandtab : */