1 /**
2 * collectd - src/postgresql.c
3 * Copyright (C) 2008-2012 Sebastian Harl
4 * Copyright (C) 2009 Florian Forster
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
23 *
24 * Authors:
25 * Sebastian Harl <sh at tokkee.org>
26 * Florian Forster <octo at collectd.org>
27 **/
29 /*
30 * This module collects PostgreSQL database statistics.
31 */
33 #include "collectd.h"
34 #include "common.h"
36 #include "configfile.h"
37 #include "plugin.h"
39 #include "utils_cache.h"
40 #include "utils_db_query.h"
41 #include "utils_complain.h"
43 #include <pg_config_manual.h>
44 #include <libpq-fe.h>
46 #define log_err(...) ERROR ("postgresql: " __VA_ARGS__)
47 #define log_warn(...) WARNING ("postgresql: " __VA_ARGS__)
48 #define log_info(...) INFO ("postgresql: " __VA_ARGS__)
49 #define log_debug(...) DEBUG ("postgresql: " __VA_ARGS__)
51 #ifndef C_PSQL_DEFAULT_CONF
52 # define C_PSQL_DEFAULT_CONF PKGDATADIR "/postgresql_default.conf"
53 #endif
55 /* Appends the (parameter, value) pair to the string
56 * pointed to by 'buf' suitable to be used as argument
57 * for PQconnectdb(). If value equals NULL, the pair
58 * is ignored. */
59 #define C_PSQL_PAR_APPEND(buf, buf_len, parameter, value) \
60 if ((0 < (buf_len)) && (NULL != (value)) && ('\0' != *(value))) { \
61 int s = ssnprintf (buf, buf_len, " %s = '%s'", parameter, value); \
62 if (0 < s) { \
63 buf += s; \
64 buf_len -= s; \
65 } \
66 }
68 /* Returns the tuple (major, minor, patchlevel)
69 * for the given version number. */
70 #define C_PSQL_SERVER_VERSION3(server_version) \
71 (server_version) / 10000, \
72 (server_version) / 100 - (int)((server_version) / 10000) * 100, \
73 (server_version) - (int)((server_version) / 100) * 100
75 /* Returns true if the given host specifies a
76 * UNIX domain socket. */
77 #define C_PSQL_IS_UNIX_DOMAIN_SOCKET(host) \
78 ((NULL == (host)) || ('\0' == *(host)) || ('/' == *(host)))
80 /* Returns the tuple (host, delimiter, port) for a
81 * given (host, port) pair. Depending on the value of
82 * 'host' a UNIX domain socket or a TCP socket is
83 * assumed. */
84 #define C_PSQL_SOCKET3(host, port) \
85 ((NULL == (host)) || ('\0' == *(host))) ? DEFAULT_PGSOCKET_DIR : host, \
86 C_PSQL_IS_UNIX_DOMAIN_SOCKET (host) ? "/.s.PGSQL." : ":", \
87 port
89 typedef enum {
90 C_PSQL_PARAM_HOST = 1,
91 C_PSQL_PARAM_DB,
92 C_PSQL_PARAM_USER,
93 C_PSQL_PARAM_INTERVAL,
94 C_PSQL_PARAM_INSTANCE,
95 } c_psql_param_t;
97 /* Parameter configuration. Stored as `user data' in the query objects. */
98 typedef struct {
99 c_psql_param_t *params;
100 int params_num;
101 } c_psql_user_data_t;
103 typedef struct {
104 char *name;
105 char *statement;
106 _Bool store_rates;
107 } c_psql_writer_t;
109 typedef struct {
110 PGconn *conn;
111 c_complain_t conn_complaint;
113 int proto_version;
114 int server_version;
116 int max_params_num;
118 /* user configuration */
119 udb_query_preparation_area_t **q_prep_areas;
120 udb_query_t **queries;
121 size_t queries_num;
123 c_psql_writer_t **writers;
124 size_t writers_num;
126 /* make sure we don't access the database object in parallel */
127 pthread_mutex_t db_lock;
129 cdtime_t interval;
131 /* writer "caching" settings */
132 cdtime_t commit_interval;
133 cdtime_t next_commit;
134 cdtime_t expire_delay;
136 char *host;
137 char *port;
138 char *database;
139 char *user;
140 char *password;
142 char *instance;
144 char *sslmode;
146 char *krbsrvname;
148 char *service;
150 int ref_cnt;
151 } c_psql_database_t;
153 static const char *const def_queries[] = {
154 "backends",
155 "transactions",
156 "queries",
157 "query_plans",
158 "table_states",
159 "disk_io",
160 "disk_usage"
161 };
162 static int def_queries_num = STATIC_ARRAY_SIZE (def_queries);
164 static c_psql_database_t **databases = NULL;
165 static size_t databases_num = 0;
167 static udb_query_t **queries = NULL;
168 static size_t queries_num = 0;
170 static c_psql_writer_t *writers = NULL;
171 static size_t writers_num = 0;
173 static int c_psql_begin (c_psql_database_t *db)
174 {
175 PGresult *r = PQexec (db->conn, "BEGIN");
177 int status = 1;
179 if (r != NULL) {
180 if (PGRES_COMMAND_OK == PQresultStatus (r)) {
181 db->next_commit = cdtime() + db->commit_interval;
182 status = 0;
183 }
184 else
185 log_warn ("Failed to initiate ('BEGIN') transaction: %s",
186 PQerrorMessage (db->conn));
187 PQclear (r);
188 }
189 return status;
190 } /* c_psql_begin */
192 static int c_psql_commit (c_psql_database_t *db)
193 {
194 PGresult *r = PQexec (db->conn, "COMMIT");
196 int status = 1;
198 if (r != NULL) {
199 if (PGRES_COMMAND_OK == PQresultStatus (r)) {
200 db->next_commit = 0;
201 log_debug ("Successfully committed transaction.");
202 status = 0;
203 }
204 else
205 log_warn ("Failed to commit transaction: %s",
206 PQerrorMessage (db->conn));
207 PQclear (r);
208 }
209 return status;
210 } /* c_psql_commit */
212 static c_psql_database_t *c_psql_database_new (const char *name)
213 {
214 c_psql_database_t **tmp;
215 c_psql_database_t *db;
217 db = malloc (sizeof(*db));
218 if (NULL == db) {
219 log_err ("Out of memory.");
220 return NULL;
221 }
223 tmp = realloc (databases,
224 (databases_num + 1) * sizeof (*databases));
225 if (NULL == tmp) {
226 log_err ("Out of memory.");
227 sfree (db);
228 return NULL;
229 }
231 databases = tmp;
232 databases[databases_num] = db;
233 ++databases_num;
235 db->conn = NULL;
237 C_COMPLAIN_INIT (&db->conn_complaint);
239 db->proto_version = 0;
240 db->server_version = 0;
242 db->max_params_num = 0;
244 db->q_prep_areas = NULL;
245 db->queries = NULL;
246 db->queries_num = 0;
248 db->writers = NULL;
249 db->writers_num = 0;
251 pthread_mutex_init (&db->db_lock, /* attrs = */ NULL);
253 db->interval = 0;
255 db->commit_interval = 0;
256 db->next_commit = 0;
257 db->expire_delay = 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'; also, don't free the database instance
328 * object just to make sure that in case anybody accesses it before
329 * shutdown won't segfault */
330 return;
331 } /* c_psql_database_delete */
333 static int c_psql_connect (c_psql_database_t *db)
334 {
335 char conninfo[4096];
336 char *buf = conninfo;
337 int buf_len = sizeof (conninfo);
338 int status;
340 if ((! db) || (! db->database))
341 return -1;
343 status = ssnprintf (buf, buf_len, "dbname = '%s'", db->database);
344 if (0 < status) {
345 buf += status;
346 buf_len -= status;
347 }
349 C_PSQL_PAR_APPEND (buf, buf_len, "host", db->host);
350 C_PSQL_PAR_APPEND (buf, buf_len, "port", db->port);
351 C_PSQL_PAR_APPEND (buf, buf_len, "user", db->user);
352 C_PSQL_PAR_APPEND (buf, buf_len, "password", db->password);
353 C_PSQL_PAR_APPEND (buf, buf_len, "sslmode", db->sslmode);
354 C_PSQL_PAR_APPEND (buf, buf_len, "krbsrvname", db->krbsrvname);
355 C_PSQL_PAR_APPEND (buf, buf_len, "service", db->service);
357 db->conn = PQconnectdb (conninfo);
358 db->proto_version = PQprotocolVersion (db->conn);
359 return 0;
360 } /* c_psql_connect */
362 static int c_psql_check_connection (c_psql_database_t *db)
363 {
364 _Bool init = 0;
366 if (! db->conn) {
367 init = 1;
369 /* trigger c_release() */
370 if (0 == db->conn_complaint.interval)
371 db->conn_complaint.interval = 1;
373 c_psql_connect (db);
374 }
376 if (CONNECTION_OK != PQstatus (db->conn)) {
377 PQreset (db->conn);
379 /* trigger c_release() */
380 if (0 == db->conn_complaint.interval)
381 db->conn_complaint.interval = 1;
383 if (CONNECTION_OK != PQstatus (db->conn)) {
384 c_complain (LOG_ERR, &db->conn_complaint,
385 "Failed to connect to database %s (%s): %s",
386 db->database, db->instance,
387 PQerrorMessage (db->conn));
388 return -1;
389 }
391 db->proto_version = PQprotocolVersion (db->conn);
392 }
394 db->server_version = PQserverVersion (db->conn);
396 if (c_would_release (&db->conn_complaint)) {
397 char *server_host;
398 int server_version;
400 server_host = PQhost (db->conn);
401 server_version = PQserverVersion (db->conn);
403 c_do_release (LOG_INFO, &db->conn_complaint,
404 "Successfully %sconnected to database %s (user %s) "
405 "at server %s%s%s (server version: %d.%d.%d, "
406 "protocol version: %d, pid: %d)", init ? "" : "re",
407 PQdb (db->conn), PQuser (db->conn),
408 C_PSQL_SOCKET3 (server_host, PQport (db->conn)),
409 C_PSQL_SERVER_VERSION3 (server_version),
410 db->proto_version, PQbackendPID (db->conn));
412 if (3 > db->proto_version)
413 log_warn ("Protocol version %d does not support parameters.",
414 db->proto_version);
415 }
416 return 0;
417 } /* c_psql_check_connection */
419 static PGresult *c_psql_exec_query_noparams (c_psql_database_t *db,
420 udb_query_t *q)
421 {
422 return PQexec (db->conn, udb_query_get_statement (q));
423 } /* c_psql_exec_query_noparams */
425 static PGresult *c_psql_exec_query_params (c_psql_database_t *db,
426 udb_query_t *q, c_psql_user_data_t *data)
427 {
428 const char *params[db->max_params_num];
429 char interval[64];
430 int i;
432 if ((data == NULL) || (data->params_num == 0))
433 return (c_psql_exec_query_noparams (db, q));
435 assert (db->max_params_num >= data->params_num);
437 for (i = 0; i < data->params_num; ++i) {
438 switch (data->params[i]) {
439 case C_PSQL_PARAM_HOST:
440 params[i] = C_PSQL_IS_UNIX_DOMAIN_SOCKET (db->host)
441 ? "localhost" : db->host;
442 break;
443 case C_PSQL_PARAM_DB:
444 params[i] = db->database;
445 break;
446 case C_PSQL_PARAM_USER:
447 params[i] = db->user;
448 break;
449 case C_PSQL_PARAM_INTERVAL:
450 ssnprintf (interval, sizeof (interval), "%.3f",
451 (db->interval > 0)
452 ? CDTIME_T_TO_DOUBLE (db->interval)
453 : plugin_get_interval ());
454 params[i] = interval;
455 break;
456 case C_PSQL_PARAM_INSTANCE:
457 params[i] = db->instance;
458 break;
459 default:
460 assert (0);
461 }
462 }
464 return PQexecParams (db->conn, udb_query_get_statement (q),
465 data->params_num, NULL,
466 (const char *const *) params,
467 NULL, NULL, /* return text data */ 0);
468 } /* c_psql_exec_query_params */
470 /* db->db_lock must be locked when calling this function */
471 static int c_psql_exec_query (c_psql_database_t *db, udb_query_t *q,
472 udb_query_preparation_area_t *prep_area)
473 {
474 PGresult *res;
476 c_psql_user_data_t *data;
478 const char *host;
480 char **column_names;
481 char **column_values;
482 int column_num;
484 int rows_num;
485 int status;
486 int row, col;
488 /* The user data may hold parameter information, but may be NULL. */
489 data = udb_query_get_user_data (q);
491 /* Versions up to `3' don't know how to handle parameters. */
492 if (3 <= db->proto_version)
493 res = c_psql_exec_query_params (db, q, data);
494 else if ((NULL == data) || (0 == data->params_num))
495 res = c_psql_exec_query_noparams (db, q);
496 else {
497 log_err ("Connection to database \"%s\" (%s) does not support "
498 "parameters (protocol version %d) - "
499 "cannot execute query \"%s\".",
500 db->database, db->instance, db->proto_version,
501 udb_query_get_name (q));
502 return -1;
503 }
505 /* give c_psql_write() a chance to acquire the lock if called recursively
506 * through dispatch_values(); this will happen if, both, queries and
507 * writers are configured for a single connection */
508 pthread_mutex_unlock (&db->db_lock);
510 column_names = NULL;
511 column_values = NULL;
513 if (PGRES_TUPLES_OK != PQresultStatus (res)) {
514 pthread_mutex_lock (&db->db_lock);
516 if ((CONNECTION_OK != PQstatus (db->conn))
517 && (0 == c_psql_check_connection (db))) {
518 PQclear (res);
519 return c_psql_exec_query (db, q, prep_area);
520 }
522 log_err ("Failed to execute SQL query: %s",
523 PQerrorMessage (db->conn));
524 log_info ("SQL query was: %s",
525 udb_query_get_statement (q));
526 PQclear (res);
527 return -1;
528 }
530 #define BAIL_OUT(status) \
531 sfree (column_names); \
532 sfree (column_values); \
533 PQclear (res); \
534 pthread_mutex_lock (&db->db_lock); \
535 return status
537 rows_num = PQntuples (res);
538 if (1 > rows_num) {
539 BAIL_OUT (0);
540 }
542 column_num = PQnfields (res);
543 column_names = (char **) calloc (column_num, sizeof (char *));
544 if (NULL == column_names) {
545 log_err ("calloc failed.");
546 BAIL_OUT (-1);
547 }
549 column_values = (char **) calloc (column_num, sizeof (char *));
550 if (NULL == column_values) {
551 log_err ("calloc failed.");
552 BAIL_OUT (-1);
553 }
555 for (col = 0; col < column_num; ++col) {
556 /* Pointers returned by `PQfname' are freed by `PQclear' via
557 * `BAIL_OUT'. */
558 column_names[col] = PQfname (res, col);
559 if (NULL == column_names[col]) {
560 log_err ("Failed to resolve name of column %i.", col);
561 BAIL_OUT (-1);
562 }
563 }
565 if (C_PSQL_IS_UNIX_DOMAIN_SOCKET (db->host)
566 || (0 == strcmp (db->host, "127.0.0.1"))
567 || (0 == strcmp (db->host, "localhost")))
568 host = hostname_g;
569 else
570 host = db->host;
572 status = udb_query_prepare_result (q, prep_area, host, "postgresql",
573 db->instance, column_names, (size_t) column_num, db->interval);
574 if (0 != status) {
575 log_err ("udb_query_prepare_result failed with status %i.",
576 status);
577 BAIL_OUT (-1);
578 }
580 for (row = 0; row < rows_num; ++row) {
581 for (col = 0; col < column_num; ++col) {
582 /* Pointers returned by `PQgetvalue' are freed by `PQclear' via
583 * `BAIL_OUT'. */
584 column_values[col] = PQgetvalue (res, row, col);
585 if (NULL == column_values[col]) {
586 log_err ("Failed to get value at (row = %i, col = %i).",
587 row, col);
588 break;
589 }
590 }
592 /* check for an error */
593 if (col < column_num)
594 continue;
596 status = udb_query_handle_result (q, prep_area, column_values);
597 if (status != 0) {
598 log_err ("udb_query_handle_result failed with status %i.",
599 status);
600 }
601 } /* for (row = 0; row < rows_num; ++row) */
603 udb_query_finish_result (q, prep_area);
605 BAIL_OUT (0);
606 #undef BAIL_OUT
607 } /* c_psql_exec_query */
609 static int c_psql_read (user_data_t *ud)
610 {
611 c_psql_database_t *db;
613 int success = 0;
614 size_t i;
616 if ((ud == NULL) || (ud->data == NULL)) {
617 log_err ("c_psql_read: Invalid user data.");
618 return -1;
619 }
621 db = ud->data;
623 assert (NULL != db->database);
624 assert (NULL != db->instance);
625 assert (NULL != db->queries);
627 pthread_mutex_lock (&db->db_lock);
629 if (0 != c_psql_check_connection (db)) {
630 pthread_mutex_unlock (&db->db_lock);
631 return -1;
632 }
634 for (i = 0; i < db->queries_num; ++i)
635 {
636 udb_query_preparation_area_t *prep_area;
637 udb_query_t *q;
639 prep_area = db->q_prep_areas[i];
640 q = db->queries[i];
642 if ((0 != db->server_version)
643 && (udb_query_check_version (q, db->server_version) <= 0))
644 continue;
646 if (0 == c_psql_exec_query (db, q, prep_area))
647 success = 1;
648 }
650 pthread_mutex_unlock (&db->db_lock);
652 if (! success)
653 return -1;
654 return 0;
655 } /* c_psql_read */
657 static char *values_name_to_sqlarray (const data_set_t *ds,
658 char *string, size_t string_len)
659 {
660 char *str_ptr;
661 size_t str_len;
662 size_t i;
664 str_ptr = string;
665 str_len = string_len;
667 for (i = 0; i < ds->ds_num; ++i) {
668 int status = ssnprintf (str_ptr, str_len, ",'%s'", ds->ds[i].name);
670 if (status < 1)
671 return NULL;
672 else if ((size_t)status >= str_len) {
673 str_len = 0;
674 break;
675 }
676 else {
677 str_ptr += status;
678 str_len -= (size_t)status;
679 }
680 }
682 if (str_len <= 2) {
683 log_err ("c_psql_write: Failed to stringify value names");
684 return NULL;
685 }
687 /* overwrite the first comma */
688 string[0] = '{';
689 str_ptr[0] = '}';
690 str_ptr[1] = '\0';
692 return string;
693 } /* values_name_to_sqlarray */
695 static char *values_type_to_sqlarray (const data_set_t *ds,
696 char *string, size_t string_len, _Bool store_rates)
697 {
698 char *str_ptr;
699 size_t str_len;
700 size_t i;
702 str_ptr = string;
703 str_len = string_len;
705 for (i = 0; i < ds->ds_num; ++i) {
706 int status;
708 if (store_rates)
709 status = ssnprintf(str_ptr, str_len, ",'gauge'");
710 else
711 status = ssnprintf(str_ptr, str_len, ",'%s'",
712 DS_TYPE_TO_STRING (ds->ds[i].type));
714 if (status < 1) {
715 str_len = 0;
716 break;
717 }
718 else if ((size_t)status >= str_len) {
719 str_len = 0;
720 break;
721 }
722 else {
723 str_ptr += status;
724 str_len -= (size_t)status;
725 }
726 }
728 if (str_len <= 2) {
729 log_err ("c_psql_write: Failed to stringify value types");
730 return NULL;
731 }
733 /* overwrite the first comma */
734 string[0] = '{';
735 str_ptr[0] = '}';
736 str_ptr[1] = '\0';
738 return string;
739 } /* values_type_to_sqlarray */
741 static char *values_to_sqlarray (const data_set_t *ds, const value_list_t *vl,
742 char *string, size_t string_len, _Bool store_rates)
743 {
744 char *str_ptr;
745 size_t str_len;
747 gauge_t *rates = NULL;
748 size_t 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 ","GAUGE_FORMAT, 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[RFC3339NANO_SIZE];
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 size_t 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 (rfc3339nano (time_str, sizeof (time_str), vl->time) != 0) {
845 log_err ("c_psql_write: Failed to convert time to RFC 3339 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 if( db->expire_delay > 0 && vl->time < (cdtime() - vl->interval - db->expire_delay) ) {
866 log_info ("c_psql_write: Skipped expired value @ %s - %s/%s-%s/%s-%s/%s",
867 params[0], params[1], params[2], params[3], params[4], params[5], params[6] );
868 return 0;
869 }
871 pthread_mutex_lock (&db->db_lock);
873 if (0 != c_psql_check_connection (db)) {
874 pthread_mutex_unlock (&db->db_lock);
875 return -1;
876 }
878 if ((db->commit_interval > 0)
879 && (db->next_commit == 0))
880 c_psql_begin (db);
882 for (i = 0; i < db->writers_num; ++i) {
883 c_psql_writer_t *writer;
884 PGresult *res;
886 writer = db->writers[i];
888 if (values_type_to_sqlarray (ds,
889 values_type_str, sizeof (values_type_str),
890 writer->store_rates) == NULL) {
891 pthread_mutex_unlock (&db->db_lock);
892 return -1;
893 }
895 if (values_to_sqlarray (ds, vl,
896 values_str, sizeof (values_str),
897 writer->store_rates) == NULL) {
898 pthread_mutex_unlock (&db->db_lock);
899 return -1;
900 }
902 params[7] = values_type_str;
903 params[8] = values_str;
905 res = PQexecParams (db->conn, writer->statement,
906 STATIC_ARRAY_SIZE (params), NULL,
907 (const char *const *)params,
908 NULL, NULL, /* return text data */ 0);
910 if ((PGRES_COMMAND_OK != PQresultStatus (res))
911 && (PGRES_TUPLES_OK != PQresultStatus (res))) {
912 PQclear (res);
914 if ((CONNECTION_OK != PQstatus (db->conn))
915 && (0 == c_psql_check_connection (db))) {
916 /* try again */
917 res = PQexecParams (db->conn, writer->statement,
918 STATIC_ARRAY_SIZE (params), NULL,
919 (const char *const *)params,
920 NULL, NULL, /* return text data */ 0);
922 if ((PGRES_COMMAND_OK == PQresultStatus (res))
923 || (PGRES_TUPLES_OK == PQresultStatus (res))) {
924 PQclear (res);
925 success = 1;
926 continue;
927 }
928 }
930 log_err ("Failed to execute SQL query: %s",
931 PQerrorMessage (db->conn));
932 log_info ("SQL query was: '%s', "
933 "params: %s, %s, %s, %s, %s, %s, %s, %s",
934 writer->statement,
935 params[0], params[1], params[2], params[3],
936 params[4], params[5], params[6], params[7]);
938 /* this will abort any current transaction -> restart */
939 if (db->next_commit > 0)
940 c_psql_commit (db);
942 pthread_mutex_unlock (&db->db_lock);
943 return -1;
944 }
946 PQclear (res);
947 success = 1;
948 }
950 if ((db->next_commit > 0)
951 && (cdtime () > db->next_commit))
952 c_psql_commit (db);
954 pthread_mutex_unlock (&db->db_lock);
956 if (! success)
957 return -1;
958 return 0;
959 } /* c_psql_write */
961 /* We cannot flush single identifiers as all we do is to commit the currently
962 * running transaction, thus making sure that all written data is actually
963 * visible to everybody. */
964 static int c_psql_flush (cdtime_t timeout,
965 __attribute__((unused)) const char *ident,
966 user_data_t *ud)
967 {
968 c_psql_database_t **dbs = databases;
969 size_t dbs_num = databases_num;
970 size_t i;
972 if ((ud != NULL) && (ud->data != NULL)) {
973 dbs = (void *)&ud->data;
974 dbs_num = 1;
975 }
977 for (i = 0; i < dbs_num; ++i) {
978 c_psql_database_t *db = dbs[i];
980 /* don't commit if the timeout is larger than the regular commit
981 * interval as in that case all requested data has already been
982 * committed */
983 if ((db->next_commit > 0) && (db->commit_interval > timeout))
984 c_psql_commit (db);
985 }
986 return 0;
987 } /* c_psql_flush */
989 static int c_psql_shutdown (void)
990 {
991 size_t i = 0;
993 _Bool had_flush = 0;
995 plugin_unregister_read_group ("postgresql");
997 for (i = 0; i < databases_num; ++i) {
998 c_psql_database_t *db = databases[i];
1000 if (db->writers_num > 0) {
1001 char cb_name[DATA_MAX_NAME_LEN];
1002 ssnprintf (cb_name, sizeof (cb_name), "postgresql-%s",
1003 db->database);
1005 if (! had_flush) {
1006 plugin_unregister_flush ("postgresql");
1007 had_flush = 1;
1008 }
1010 plugin_unregister_flush (cb_name);
1011 plugin_unregister_write (cb_name);
1012 }
1014 sfree (db);
1015 }
1017 udb_query_free (queries, queries_num);
1018 queries = NULL;
1019 queries_num = 0;
1021 sfree (writers);
1022 writers = NULL;
1023 writers_num = 0;
1025 sfree (databases);
1026 databases = NULL;
1027 databases_num = 0;
1029 return 0;
1030 } /* c_psql_shutdown */
1032 static int config_query_param_add (udb_query_t *q, oconfig_item_t *ci)
1033 {
1034 c_psql_user_data_t *data;
1035 const char *param_str;
1037 c_psql_param_t *tmp;
1039 data = udb_query_get_user_data (q);
1040 if (NULL == data) {
1041 data = calloc (1, sizeof (*data));
1042 if (NULL == data) {
1043 log_err ("Out of memory.");
1044 return -1;
1045 }
1046 data->params = NULL;
1047 data->params_num = 0;
1049 udb_query_set_user_data (q, data);
1050 }
1052 tmp = realloc (data->params, (data->params_num + 1) * sizeof (*data->params));
1053 if (NULL == tmp) {
1054 log_err ("Out of memory.");
1055 return -1;
1056 }
1057 data->params = tmp;
1059 param_str = ci->values[0].value.string;
1060 if (0 == strcasecmp (param_str, "hostname"))
1061 data->params[data->params_num] = C_PSQL_PARAM_HOST;
1062 else if (0 == strcasecmp (param_str, "database"))
1063 data->params[data->params_num] = C_PSQL_PARAM_DB;
1064 else if (0 == strcasecmp (param_str, "username"))
1065 data->params[data->params_num] = C_PSQL_PARAM_USER;
1066 else if (0 == strcasecmp (param_str, "interval"))
1067 data->params[data->params_num] = C_PSQL_PARAM_INTERVAL;
1068 else if (0 == strcasecmp (param_str, "instance"))
1069 data->params[data->params_num] = C_PSQL_PARAM_INSTANCE;
1070 else {
1071 log_err ("Invalid parameter \"%s\".", param_str);
1072 return 1;
1073 }
1075 data->params_num++;
1076 return (0);
1077 } /* config_query_param_add */
1079 static int config_query_callback (udb_query_t *q, oconfig_item_t *ci)
1080 {
1081 if (0 == strcasecmp ("Param", ci->key))
1082 return config_query_param_add (q, ci);
1084 log_err ("Option not allowed within a Query block: `%s'", ci->key);
1086 return (-1);
1087 } /* config_query_callback */
1089 static int config_add_writer (oconfig_item_t *ci,
1090 c_psql_writer_t *src_writers, size_t src_writers_num,
1091 c_psql_writer_t ***dst_writers, size_t *dst_writers_num)
1092 {
1093 char *name;
1095 size_t i;
1097 if ((ci == NULL) || (dst_writers == NULL) || (dst_writers_num == NULL))
1098 return -1;
1100 if ((ci->values_num != 1)
1101 || (ci->values[0].type != OCONFIG_TYPE_STRING)) {
1102 log_err ("`Writer' expects a single string argument.");
1103 return 1;
1104 }
1106 name = ci->values[0].value.string;
1108 for (i = 0; i < src_writers_num; ++i) {
1109 c_psql_writer_t **tmp;
1111 if (strcasecmp (name, src_writers[i].name) != 0)
1112 continue;
1114 tmp = realloc (*dst_writers,
1115 sizeof (**dst_writers) * (*dst_writers_num + 1));
1116 if (tmp == NULL) {
1117 log_err ("Out of memory.");
1118 return -1;
1119 }
1121 tmp[*dst_writers_num] = src_writers + i;
1123 *dst_writers = tmp;
1124 ++(*dst_writers_num);
1125 break;
1126 }
1128 if (i >= src_writers_num) {
1129 log_err ("No such writer: `%s'", name);
1130 return -1;
1131 }
1133 return 0;
1134 } /* config_add_writer */
1136 static int c_psql_config_writer (oconfig_item_t *ci)
1137 {
1138 c_psql_writer_t *writer;
1139 c_psql_writer_t *tmp;
1141 int status = 0;
1142 int i;
1144 if ((ci->values_num != 1)
1145 || (ci->values[0].type != OCONFIG_TYPE_STRING)) {
1146 log_err ("<Writer> expects a single string argument.");
1147 return 1;
1148 }
1150 tmp = realloc (writers,
1151 sizeof (*writers) * (writers_num + 1));
1152 if (tmp == NULL) {
1153 log_err ("Out of memory.");
1154 return -1;
1155 }
1157 writers = tmp;
1158 writer = writers + writers_num;
1159 memset (writer, 0, sizeof (*writer));
1161 writer->name = sstrdup (ci->values[0].value.string);
1162 writer->statement = NULL;
1163 writer->store_rates = 1;
1165 for (i = 0; i < ci->children_num; ++i) {
1166 oconfig_item_t *c = ci->children + i;
1168 if (strcasecmp ("Statement", c->key) == 0)
1169 status = cf_util_get_string (c, &writer->statement);
1170 else if (strcasecmp ("StoreRates", c->key) == 0)
1171 status = cf_util_get_boolean (c, &writer->store_rates);
1172 else
1173 log_warn ("Ignoring unknown config key \"%s\".", c->key);
1174 }
1176 if (status != 0) {
1177 sfree (writer->statement);
1178 sfree (writer->name);
1179 return status;
1180 }
1182 ++writers_num;
1183 return 0;
1184 } /* c_psql_config_writer */
1186 static int c_psql_config_database (oconfig_item_t *ci)
1187 {
1188 c_psql_database_t *db;
1190 char cb_name[DATA_MAX_NAME_LEN];
1191 user_data_t ud;
1193 static _Bool have_flush = 0;
1195 int i;
1197 if ((1 != ci->values_num)
1198 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1199 log_err ("<Database> expects a single string argument.");
1200 return 1;
1201 }
1203 memset (&ud, 0, sizeof (ud));
1205 db = c_psql_database_new (ci->values[0].value.string);
1206 if (db == NULL)
1207 return -1;
1209 for (i = 0; i < ci->children_num; ++i) {
1210 oconfig_item_t *c = ci->children + i;
1212 if (0 == strcasecmp (c->key, "Host"))
1213 cf_util_get_string (c, &db->host);
1214 else if (0 == strcasecmp (c->key, "Port"))
1215 cf_util_get_service (c, &db->port);
1216 else if (0 == strcasecmp (c->key, "User"))
1217 cf_util_get_string (c, &db->user);
1218 else if (0 == strcasecmp (c->key, "Password"))
1219 cf_util_get_string (c, &db->password);
1220 else if (0 == strcasecmp (c->key, "Instance"))
1221 cf_util_get_string (c, &db->instance);
1222 else if (0 == strcasecmp (c->key, "SSLMode"))
1223 cf_util_get_string (c, &db->sslmode);
1224 else if (0 == strcasecmp (c->key, "KRBSrvName"))
1225 cf_util_get_string (c, &db->krbsrvname);
1226 else if (0 == strcasecmp (c->key, "Service"))
1227 cf_util_get_string (c, &db->service);
1228 else if (0 == strcasecmp (c->key, "Query"))
1229 udb_query_pick_from_list (c, queries, queries_num,
1230 &db->queries, &db->queries_num);
1231 else if (0 == strcasecmp (c->key, "Writer"))
1232 config_add_writer (c, writers, writers_num,
1233 &db->writers, &db->writers_num);
1234 else if (0 == strcasecmp (c->key, "Interval"))
1235 cf_util_get_cdtime (c, &db->interval);
1236 else if (strcasecmp ("CommitInterval", c->key) == 0)
1237 cf_util_get_cdtime (c, &db->commit_interval);
1238 else if (strcasecmp ("ExpireDelay", c->key) == 0)
1239 cf_util_get_cdtime (c, &db->expire_delay);
1240 else
1241 log_warn ("Ignoring unknown config key \"%s\".", c->key);
1242 }
1244 /* If no `Query' options were given, add the default queries.. */
1245 if ((db->queries_num == 0) && (db->writers_num == 0)){
1246 for (i = 0; i < def_queries_num; i++)
1247 udb_query_pick_from_list_by_name (def_queries[i],
1248 queries, queries_num,
1249 &db->queries, &db->queries_num);
1250 }
1252 if (db->queries_num > 0) {
1253 db->q_prep_areas = (udb_query_preparation_area_t **) calloc (
1254 db->queries_num, sizeof (*db->q_prep_areas));
1256 if (db->q_prep_areas == NULL) {
1257 log_err ("Out of memory.");
1258 c_psql_database_delete (db);
1259 return -1;
1260 }
1261 }
1263 for (i = 0; (size_t)i < db->queries_num; ++i) {
1264 c_psql_user_data_t *data;
1265 data = udb_query_get_user_data (db->queries[i]);
1266 if ((data != NULL) && (data->params_num > db->max_params_num))
1267 db->max_params_num = data->params_num;
1269 db->q_prep_areas[i]
1270 = udb_query_allocate_preparation_area (db->queries[i]);
1272 if (db->q_prep_areas[i] == NULL) {
1273 log_err ("Out of memory.");
1274 c_psql_database_delete (db);
1275 return -1;
1276 }
1277 }
1279 ud.data = db;
1280 ud.free_func = c_psql_database_delete;
1282 ssnprintf (cb_name, sizeof (cb_name), "postgresql-%s", db->instance);
1284 if (db->queries_num > 0) {
1285 ++db->ref_cnt;
1286 plugin_register_complex_read ("postgresql", cb_name, c_psql_read,
1287 /* interval = */ db->interval, &ud);
1288 }
1289 if (db->writers_num > 0) {
1290 ++db->ref_cnt;
1291 plugin_register_write (cb_name, c_psql_write, &ud);
1293 if (! have_flush) {
1294 /* flush all */
1295 plugin_register_flush ("postgresql",
1296 c_psql_flush, /* user data = */ NULL);
1297 have_flush = 1;
1298 }
1300 /* flush this connection only */
1301 ++db->ref_cnt;
1302 plugin_register_flush (cb_name, c_psql_flush, &ud);
1303 }
1304 else if (db->commit_interval > 0) {
1305 log_warn ("Database '%s': You do not have any writers assigned to "
1306 "this database connection. Setting 'CommitInterval' does "
1307 "not have any effect.", db->database);
1308 }
1309 return 0;
1310 } /* c_psql_config_database */
1312 static int c_psql_config (oconfig_item_t *ci)
1313 {
1314 static int have_def_config = 0;
1316 int i;
1318 if (0 == have_def_config) {
1319 oconfig_item_t *c;
1321 have_def_config = 1;
1323 c = oconfig_parse_file (C_PSQL_DEFAULT_CONF);
1324 if (NULL == c)
1325 log_err ("Failed to read default config ("C_PSQL_DEFAULT_CONF").");
1326 else
1327 c_psql_config (c);
1329 if (NULL == queries)
1330 log_err ("Default config ("C_PSQL_DEFAULT_CONF") did not define "
1331 "any queries - please check your installation.");
1332 }
1334 for (i = 0; i < ci->children_num; ++i) {
1335 oconfig_item_t *c = ci->children + i;
1337 if (0 == strcasecmp (c->key, "Query"))
1338 udb_query_create (&queries, &queries_num, c,
1339 /* callback = */ config_query_callback);
1340 else if (0 == strcasecmp (c->key, "Writer"))
1341 c_psql_config_writer (c);
1342 else if (0 == strcasecmp (c->key, "Database"))
1343 c_psql_config_database (c);
1344 else
1345 log_warn ("Ignoring unknown config key \"%s\".", c->key);
1346 }
1347 return 0;
1348 } /* c_psql_config */
1350 void module_register (void)
1351 {
1352 plugin_register_complex_config ("postgresql", c_psql_config);
1353 plugin_register_shutdown ("postgresql", c_psql_shutdown);
1354 } /* module_register */
1356 /* vim: set sw=4 ts=4 tw=78 noexpandtab : */