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"
35 #include "common.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 c_psql_database_t *db = data;
281 --db->ref_cnt;
282 /* readers and writers may access this database */
283 if (db->ref_cnt > 0)
284 return;
286 /* wait for the lock to be released by the last writer */
287 pthread_mutex_lock (&db->db_lock);
289 if (db->next_commit > 0)
290 c_psql_commit (db);
292 PQfinish (db->conn);
293 db->conn = NULL;
295 if (db->q_prep_areas)
296 for (size_t i = 0; i < db->queries_num; ++i)
297 udb_query_delete_preparation_area (db->q_prep_areas[i]);
298 free (db->q_prep_areas);
300 sfree (db->queries);
301 db->queries_num = 0;
303 sfree (db->writers);
304 db->writers_num = 0;
306 pthread_mutex_unlock (&db->db_lock);
308 pthread_mutex_destroy (&db->db_lock);
310 sfree (db->database);
311 sfree (db->host);
312 sfree (db->port);
313 sfree (db->user);
314 sfree (db->password);
316 sfree (db->instance);
318 sfree (db->sslmode);
320 sfree (db->krbsrvname);
322 sfree (db->service);
324 /* don't care about freeing or reordering the 'databases' array
325 * this is done in 'shutdown'; also, don't free the database instance
326 * object just to make sure that in case anybody accesses it before
327 * shutdown won't segfault */
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 const char *params[db->max_params_num];
427 char interval[64];
429 if ((data == NULL) || (data->params_num == 0))
430 return (c_psql_exec_query_noparams (db, q));
432 assert (db->max_params_num >= data->params_num);
434 for (int i = 0; i < data->params_num; ++i) {
435 switch (data->params[i]) {
436 case C_PSQL_PARAM_HOST:
437 params[i] = C_PSQL_IS_UNIX_DOMAIN_SOCKET (db->host)
438 ? "localhost" : db->host;
439 break;
440 case C_PSQL_PARAM_DB:
441 params[i] = db->database;
442 break;
443 case C_PSQL_PARAM_USER:
444 params[i] = db->user;
445 break;
446 case C_PSQL_PARAM_INTERVAL:
447 ssnprintf (interval, sizeof (interval), "%.3f",
448 (db->interval > 0)
449 ? CDTIME_T_TO_DOUBLE (db->interval)
450 : plugin_get_interval ());
451 params[i] = interval;
452 break;
453 case C_PSQL_PARAM_INSTANCE:
454 params[i] = db->instance;
455 break;
456 default:
457 assert (0);
458 }
459 }
461 return PQexecParams (db->conn, udb_query_get_statement (q),
462 data->params_num, NULL,
463 (const char *const *) params,
464 NULL, NULL, /* return text data */ 0);
465 } /* c_psql_exec_query_params */
467 /* db->db_lock must be locked when calling this function */
468 static int c_psql_exec_query (c_psql_database_t *db, udb_query_t *q,
469 udb_query_preparation_area_t *prep_area)
470 {
471 PGresult *res;
473 c_psql_user_data_t *data;
475 const char *host;
477 char **column_names;
478 char **column_values;
479 int column_num;
481 int rows_num;
482 int status;
484 /* The user data may hold parameter information, but may be NULL. */
485 data = udb_query_get_user_data (q);
487 /* Versions up to `3' don't know how to handle parameters. */
488 if (3 <= db->proto_version)
489 res = c_psql_exec_query_params (db, q, data);
490 else if ((NULL == data) || (0 == data->params_num))
491 res = c_psql_exec_query_noparams (db, q);
492 else {
493 log_err ("Connection to database \"%s\" (%s) does not support "
494 "parameters (protocol version %d) - "
495 "cannot execute query \"%s\".",
496 db->database, db->instance, db->proto_version,
497 udb_query_get_name (q));
498 return -1;
499 }
501 /* give c_psql_write() a chance to acquire the lock if called recursively
502 * through dispatch_values(); this will happen if, both, queries and
503 * writers are configured for a single connection */
504 pthread_mutex_unlock (&db->db_lock);
506 column_names = NULL;
507 column_values = NULL;
509 if (PGRES_TUPLES_OK != PQresultStatus (res)) {
510 pthread_mutex_lock (&db->db_lock);
512 if ((CONNECTION_OK != PQstatus (db->conn))
513 && (0 == c_psql_check_connection (db))) {
514 PQclear (res);
515 return c_psql_exec_query (db, q, prep_area);
516 }
518 log_err ("Failed to execute SQL query: %s",
519 PQerrorMessage (db->conn));
520 log_info ("SQL query was: %s",
521 udb_query_get_statement (q));
522 PQclear (res);
523 return -1;
524 }
526 #define BAIL_OUT(status) \
527 sfree (column_names); \
528 sfree (column_values); \
529 PQclear (res); \
530 pthread_mutex_lock (&db->db_lock); \
531 return status
533 rows_num = PQntuples (res);
534 if (1 > rows_num) {
535 BAIL_OUT (0);
536 }
538 column_num = PQnfields (res);
539 column_names = (char **) calloc (column_num, sizeof (char *));
540 if (NULL == column_names) {
541 log_err ("calloc failed.");
542 BAIL_OUT (-1);
543 }
545 column_values = (char **) calloc (column_num, sizeof (char *));
546 if (NULL == column_values) {
547 log_err ("calloc failed.");
548 BAIL_OUT (-1);
549 }
551 for (int col = 0; col < column_num; ++col) {
552 /* Pointers returned by `PQfname' are freed by `PQclear' via
553 * `BAIL_OUT'. */
554 column_names[col] = PQfname (res, col);
555 if (NULL == column_names[col]) {
556 log_err ("Failed to resolve name of column %i.", col);
557 BAIL_OUT (-1);
558 }
559 }
561 if (C_PSQL_IS_UNIX_DOMAIN_SOCKET (db->host)
562 || (0 == strcmp (db->host, "127.0.0.1"))
563 || (0 == strcmp (db->host, "localhost")))
564 host = hostname_g;
565 else
566 host = db->host;
568 status = udb_query_prepare_result (q, prep_area, host, "postgresql",
569 db->instance, column_names, (size_t) column_num, db->interval);
570 if (0 != status) {
571 log_err ("udb_query_prepare_result failed with status %i.",
572 status);
573 BAIL_OUT (-1);
574 }
576 for (int row = 0; row < rows_num; ++row) {
577 int col;
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;
612 if ((ud == NULL) || (ud->data == NULL)) {
613 log_err ("c_psql_read: Invalid user data.");
614 return -1;
615 }
617 db = ud->data;
619 assert (NULL != db->database);
620 assert (NULL != db->instance);
621 assert (NULL != db->queries);
623 pthread_mutex_lock (&db->db_lock);
625 if (0 != c_psql_check_connection (db)) {
626 pthread_mutex_unlock (&db->db_lock);
627 return -1;
628 }
630 for (size_t i = 0; i < db->queries_num; ++i)
631 {
632 udb_query_preparation_area_t *prep_area;
633 udb_query_t *q;
635 prep_area = db->q_prep_areas[i];
636 q = db->queries[i];
638 if ((0 != db->server_version)
639 && (udb_query_check_version (q, db->server_version) <= 0))
640 continue;
642 if (0 == c_psql_exec_query (db, q, prep_area))
643 success = 1;
644 }
646 pthread_mutex_unlock (&db->db_lock);
648 if (! success)
649 return -1;
650 return 0;
651 } /* c_psql_read */
653 static char *values_name_to_sqlarray (const data_set_t *ds,
654 char *string, size_t string_len)
655 {
656 char *str_ptr;
657 size_t str_len;
659 str_ptr = string;
660 str_len = string_len;
662 for (size_t i = 0; i < ds->ds_num; ++i) {
663 int status = ssnprintf (str_ptr, str_len, ",'%s'", ds->ds[i].name);
665 if (status < 1)
666 return NULL;
667 else if ((size_t)status >= str_len) {
668 str_len = 0;
669 break;
670 }
671 else {
672 str_ptr += status;
673 str_len -= (size_t)status;
674 }
675 }
677 if (str_len <= 2) {
678 log_err ("c_psql_write: Failed to stringify value names");
679 return NULL;
680 }
682 /* overwrite the first comma */
683 string[0] = '{';
684 str_ptr[0] = '}';
685 str_ptr[1] = '\0';
687 return string;
688 } /* values_name_to_sqlarray */
690 static char *values_type_to_sqlarray (const data_set_t *ds,
691 char *string, size_t string_len, _Bool store_rates)
692 {
693 char *str_ptr;
694 size_t str_len;
696 str_ptr = string;
697 str_len = string_len;
699 for (size_t i = 0; i < ds->ds_num; ++i) {
700 int status;
702 if (store_rates)
703 status = ssnprintf(str_ptr, str_len, ",'gauge'");
704 else
705 status = ssnprintf(str_ptr, str_len, ",'%s'",
706 DS_TYPE_TO_STRING (ds->ds[i].type));
708 if (status < 1) {
709 str_len = 0;
710 break;
711 }
712 else if ((size_t)status >= str_len) {
713 str_len = 0;
714 break;
715 }
716 else {
717 str_ptr += status;
718 str_len -= (size_t)status;
719 }
720 }
722 if (str_len <= 2) {
723 log_err ("c_psql_write: Failed to stringify value types");
724 return NULL;
725 }
727 /* overwrite the first comma */
728 string[0] = '{';
729 str_ptr[0] = '}';
730 str_ptr[1] = '\0';
732 return string;
733 } /* values_type_to_sqlarray */
735 static char *values_to_sqlarray (const data_set_t *ds, const value_list_t *vl,
736 char *string, size_t string_len, _Bool store_rates)
737 {
738 char *str_ptr;
739 size_t str_len;
741 gauge_t *rates = NULL;
743 str_ptr = string;
744 str_len = string_len;
746 for (size_t i = 0; i < vl->values_len; ++i) {
747 int status = 0;
749 if ((ds->ds[i].type != DS_TYPE_GAUGE)
750 && (ds->ds[i].type != DS_TYPE_COUNTER)
751 && (ds->ds[i].type != DS_TYPE_DERIVE)
752 && (ds->ds[i].type != DS_TYPE_ABSOLUTE)) {
753 log_err ("c_psql_write: Unknown data source type: %i",
754 ds->ds[i].type);
755 sfree (rates);
756 return NULL;
757 }
759 if (ds->ds[i].type == DS_TYPE_GAUGE)
760 status = ssnprintf (str_ptr, str_len,
761 ","GAUGE_FORMAT, vl->values[i].gauge);
762 else if (store_rates) {
763 if (rates == NULL)
764 rates = uc_get_rate (ds, vl);
766 if (rates == NULL) {
767 log_err ("c_psql_write: Failed to determine rate");
768 return NULL;
769 }
771 status = ssnprintf (str_ptr, str_len,
772 ",%lf", rates[i]);
773 }
774 else if (ds->ds[i].type == DS_TYPE_COUNTER)
775 status = ssnprintf (str_ptr, str_len,
776 ",%llu", vl->values[i].counter);
777 else if (ds->ds[i].type == DS_TYPE_DERIVE)
778 status = ssnprintf (str_ptr, str_len,
779 ",%"PRIi64, vl->values[i].derive);
780 else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
781 status = ssnprintf (str_ptr, str_len,
782 ",%"PRIu64, vl->values[i].absolute);
784 if (status < 1) {
785 str_len = 0;
786 break;
787 }
788 else if ((size_t)status >= str_len) {
789 str_len = 0;
790 break;
791 }
792 else {
793 str_ptr += status;
794 str_len -= (size_t)status;
795 }
796 }
798 sfree (rates);
800 if (str_len <= 2) {
801 log_err ("c_psql_write: Failed to stringify value list");
802 return NULL;
803 }
805 /* overwrite the first comma */
806 string[0] = '{';
807 str_ptr[0] = '}';
808 str_ptr[1] = '\0';
810 return string;
811 } /* values_to_sqlarray */
813 static int c_psql_write (const data_set_t *ds, const value_list_t *vl,
814 user_data_t *ud)
815 {
816 c_psql_database_t *db;
818 char time_str[RFC3339NANO_SIZE];
819 char values_name_str[1024];
820 char values_type_str[1024];
821 char values_str[1024];
823 const char *params[9];
825 int success = 0;
827 if ((ud == NULL) || (ud->data == NULL)) {
828 log_err ("c_psql_write: Invalid user data.");
829 return -1;
830 }
832 db = ud->data;
833 assert (db->database != NULL);
834 assert (db->writers != NULL);
836 /* TODO: Should this be rfc3339nano_local()? */
837 if (rfc3339nano (time_str, sizeof (time_str), vl->time) != 0) {
838 log_err ("c_psql_write: Failed to convert time to RFC 3339 format");
839 return -1;
840 }
842 if (values_name_to_sqlarray (ds,
843 values_name_str, sizeof (values_name_str)) == NULL)
844 return -1;
846 #define VALUE_OR_NULL(v) ((((v) == NULL) || (*(v) == '\0')) ? NULL : (v))
848 params[0] = time_str;
849 params[1] = vl->host;
850 params[2] = vl->plugin;
851 params[3] = VALUE_OR_NULL(vl->plugin_instance);
852 params[4] = vl->type;
853 params[5] = VALUE_OR_NULL(vl->type_instance);
854 params[6] = values_name_str;
856 #undef VALUE_OR_NULL
858 if( db->expire_delay > 0 && vl->time < (cdtime() - vl->interval - db->expire_delay) ) {
859 log_info ("c_psql_write: Skipped expired value @ %s - %s/%s-%s/%s-%s/%s",
860 params[0], params[1], params[2], params[3], params[4], params[5], params[6] );
861 return 0;
862 }
864 pthread_mutex_lock (&db->db_lock);
866 if (0 != c_psql_check_connection (db)) {
867 pthread_mutex_unlock (&db->db_lock);
868 return -1;
869 }
871 if ((db->commit_interval > 0)
872 && (db->next_commit == 0))
873 c_psql_begin (db);
875 for (size_t i = 0; i < db->writers_num; ++i) {
876 c_psql_writer_t *writer;
877 PGresult *res;
879 writer = db->writers[i];
881 if (values_type_to_sqlarray (ds,
882 values_type_str, sizeof (values_type_str),
883 writer->store_rates) == NULL) {
884 pthread_mutex_unlock (&db->db_lock);
885 return -1;
886 }
888 if (values_to_sqlarray (ds, vl,
889 values_str, sizeof (values_str),
890 writer->store_rates) == NULL) {
891 pthread_mutex_unlock (&db->db_lock);
892 return -1;
893 }
895 params[7] = values_type_str;
896 params[8] = values_str;
898 res = PQexecParams (db->conn, writer->statement,
899 STATIC_ARRAY_SIZE (params), NULL,
900 (const char *const *)params,
901 NULL, NULL, /* return text data */ 0);
903 if ((PGRES_COMMAND_OK != PQresultStatus (res))
904 && (PGRES_TUPLES_OK != PQresultStatus (res))) {
905 PQclear (res);
907 if ((CONNECTION_OK != PQstatus (db->conn))
908 && (0 == c_psql_check_connection (db))) {
909 /* try again */
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);
918 success = 1;
919 continue;
920 }
921 }
923 log_err ("Failed to execute SQL query: %s",
924 PQerrorMessage (db->conn));
925 log_info ("SQL query was: '%s', "
926 "params: %s, %s, %s, %s, %s, %s, %s, %s",
927 writer->statement,
928 params[0], params[1], params[2], params[3],
929 params[4], params[5], params[6], params[7]);
931 /* this will abort any current transaction -> restart */
932 if (db->next_commit > 0)
933 c_psql_commit (db);
935 pthread_mutex_unlock (&db->db_lock);
936 return -1;
937 }
939 PQclear (res);
940 success = 1;
941 }
943 if ((db->next_commit > 0)
944 && (cdtime () > db->next_commit))
945 c_psql_commit (db);
947 pthread_mutex_unlock (&db->db_lock);
949 if (! success)
950 return -1;
951 return 0;
952 } /* c_psql_write */
954 /* We cannot flush single identifiers as all we do is to commit the currently
955 * running transaction, thus making sure that all written data is actually
956 * visible to everybody. */
957 static int c_psql_flush (cdtime_t timeout,
958 __attribute__((unused)) const char *ident,
959 user_data_t *ud)
960 {
961 c_psql_database_t **dbs = databases;
962 size_t dbs_num = databases_num;
964 if ((ud != NULL) && (ud->data != NULL)) {
965 dbs = (void *)&ud->data;
966 dbs_num = 1;
967 }
969 for (size_t i = 0; i < dbs_num; ++i) {
970 c_psql_database_t *db = dbs[i];
972 /* don't commit if the timeout is larger than the regular commit
973 * interval as in that case all requested data has already been
974 * committed */
975 if ((db->next_commit > 0) && (db->commit_interval > timeout))
976 c_psql_commit (db);
977 }
978 return 0;
979 } /* c_psql_flush */
981 static int c_psql_shutdown (void)
982 {
983 _Bool had_flush = 0;
985 plugin_unregister_read_group ("postgresql");
987 for (size_t i = 0; i < databases_num; ++i) {
988 c_psql_database_t *db = databases[i];
990 if (db->writers_num > 0) {
991 char cb_name[DATA_MAX_NAME_LEN];
992 ssnprintf (cb_name, sizeof (cb_name), "postgresql-%s",
993 db->database);
995 if (! had_flush) {
996 plugin_unregister_flush ("postgresql");
997 had_flush = 1;
998 }
1000 plugin_unregister_flush (cb_name);
1001 plugin_unregister_write (cb_name);
1002 }
1004 sfree (db);
1005 }
1007 udb_query_free (queries, queries_num);
1008 queries = NULL;
1009 queries_num = 0;
1011 sfree (writers);
1012 writers = NULL;
1013 writers_num = 0;
1015 sfree (databases);
1016 databases = NULL;
1017 databases_num = 0;
1019 return 0;
1020 } /* c_psql_shutdown */
1022 static int config_query_param_add (udb_query_t *q, oconfig_item_t *ci)
1023 {
1024 c_psql_user_data_t *data;
1025 const char *param_str;
1027 c_psql_param_t *tmp;
1029 data = udb_query_get_user_data (q);
1030 if (NULL == data) {
1031 data = calloc (1, sizeof (*data));
1032 if (NULL == data) {
1033 log_err ("Out of memory.");
1034 return -1;
1035 }
1036 data->params = NULL;
1037 data->params_num = 0;
1039 udb_query_set_user_data (q, data);
1040 }
1042 tmp = realloc (data->params, (data->params_num + 1) * sizeof (*data->params));
1043 if (NULL == tmp) {
1044 log_err ("Out of memory.");
1045 return -1;
1046 }
1047 data->params = tmp;
1049 param_str = ci->values[0].value.string;
1050 if (0 == strcasecmp (param_str, "hostname"))
1051 data->params[data->params_num] = C_PSQL_PARAM_HOST;
1052 else if (0 == strcasecmp (param_str, "database"))
1053 data->params[data->params_num] = C_PSQL_PARAM_DB;
1054 else if (0 == strcasecmp (param_str, "username"))
1055 data->params[data->params_num] = C_PSQL_PARAM_USER;
1056 else if (0 == strcasecmp (param_str, "interval"))
1057 data->params[data->params_num] = C_PSQL_PARAM_INTERVAL;
1058 else if (0 == strcasecmp (param_str, "instance"))
1059 data->params[data->params_num] = C_PSQL_PARAM_INSTANCE;
1060 else {
1061 log_err ("Invalid parameter \"%s\".", param_str);
1062 return 1;
1063 }
1065 data->params_num++;
1066 return (0);
1067 } /* config_query_param_add */
1069 static int config_query_callback (udb_query_t *q, oconfig_item_t *ci)
1070 {
1071 if (0 == strcasecmp ("Param", ci->key))
1072 return config_query_param_add (q, ci);
1074 log_err ("Option not allowed within a Query block: `%s'", ci->key);
1076 return (-1);
1077 } /* config_query_callback */
1079 static int config_add_writer (oconfig_item_t *ci,
1080 c_psql_writer_t *src_writers, size_t src_writers_num,
1081 c_psql_writer_t ***dst_writers, size_t *dst_writers_num)
1082 {
1083 char *name;
1085 size_t i;
1087 if ((ci == NULL) || (dst_writers == NULL) || (dst_writers_num == NULL))
1088 return -1;
1090 if ((ci->values_num != 1)
1091 || (ci->values[0].type != OCONFIG_TYPE_STRING)) {
1092 log_err ("`Writer' expects a single string argument.");
1093 return 1;
1094 }
1096 name = ci->values[0].value.string;
1098 for (i = 0; i < src_writers_num; ++i) {
1099 c_psql_writer_t **tmp;
1101 if (strcasecmp (name, src_writers[i].name) != 0)
1102 continue;
1104 tmp = realloc (*dst_writers,
1105 sizeof (**dst_writers) * (*dst_writers_num + 1));
1106 if (tmp == NULL) {
1107 log_err ("Out of memory.");
1108 return -1;
1109 }
1111 tmp[*dst_writers_num] = src_writers + i;
1113 *dst_writers = tmp;
1114 ++(*dst_writers_num);
1115 break;
1116 }
1118 if (i >= src_writers_num) {
1119 log_err ("No such writer: `%s'", name);
1120 return -1;
1121 }
1123 return 0;
1124 } /* config_add_writer */
1126 static int c_psql_config_writer (oconfig_item_t *ci)
1127 {
1128 c_psql_writer_t *writer;
1129 c_psql_writer_t *tmp;
1131 int status = 0;
1133 if ((ci->values_num != 1)
1134 || (ci->values[0].type != OCONFIG_TYPE_STRING)) {
1135 log_err ("<Writer> expects a single string argument.");
1136 return 1;
1137 }
1139 tmp = realloc (writers,
1140 sizeof (*writers) * (writers_num + 1));
1141 if (tmp == NULL) {
1142 log_err ("Out of memory.");
1143 return -1;
1144 }
1146 writers = tmp;
1147 writer = writers + writers_num;
1148 memset (writer, 0, sizeof (*writer));
1150 writer->name = sstrdup (ci->values[0].value.string);
1151 writer->statement = NULL;
1152 writer->store_rates = 1;
1154 for (int i = 0; i < ci->children_num; ++i) {
1155 oconfig_item_t *c = ci->children + i;
1157 if (strcasecmp ("Statement", c->key) == 0)
1158 status = cf_util_get_string (c, &writer->statement);
1159 else if (strcasecmp ("StoreRates", c->key) == 0)
1160 status = cf_util_get_boolean (c, &writer->store_rates);
1161 else
1162 log_warn ("Ignoring unknown config key \"%s\".", c->key);
1163 }
1165 if (status != 0) {
1166 sfree (writer->statement);
1167 sfree (writer->name);
1168 return status;
1169 }
1171 ++writers_num;
1172 return 0;
1173 } /* c_psql_config_writer */
1175 static int c_psql_config_database (oconfig_item_t *ci)
1176 {
1177 c_psql_database_t *db;
1179 char cb_name[DATA_MAX_NAME_LEN];
1180 static _Bool have_flush = 0;
1182 if ((1 != ci->values_num)
1183 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1184 log_err ("<Database> expects a single string argument.");
1185 return 1;
1186 }
1188 db = c_psql_database_new (ci->values[0].value.string);
1189 if (db == NULL)
1190 return -1;
1192 for (int i = 0; i < ci->children_num; ++i) {
1193 oconfig_item_t *c = ci->children + i;
1195 if (0 == strcasecmp (c->key, "Host"))
1196 cf_util_get_string (c, &db->host);
1197 else if (0 == strcasecmp (c->key, "Port"))
1198 cf_util_get_service (c, &db->port);
1199 else if (0 == strcasecmp (c->key, "User"))
1200 cf_util_get_string (c, &db->user);
1201 else if (0 == strcasecmp (c->key, "Password"))
1202 cf_util_get_string (c, &db->password);
1203 else if (0 == strcasecmp (c->key, "Instance"))
1204 cf_util_get_string (c, &db->instance);
1205 else if (0 == strcasecmp (c->key, "SSLMode"))
1206 cf_util_get_string (c, &db->sslmode);
1207 else if (0 == strcasecmp (c->key, "KRBSrvName"))
1208 cf_util_get_string (c, &db->krbsrvname);
1209 else if (0 == strcasecmp (c->key, "Service"))
1210 cf_util_get_string (c, &db->service);
1211 else if (0 == strcasecmp (c->key, "Query"))
1212 udb_query_pick_from_list (c, queries, queries_num,
1213 &db->queries, &db->queries_num);
1214 else if (0 == strcasecmp (c->key, "Writer"))
1215 config_add_writer (c, writers, writers_num,
1216 &db->writers, &db->writers_num);
1217 else if (0 == strcasecmp (c->key, "Interval"))
1218 cf_util_get_cdtime (c, &db->interval);
1219 else if (strcasecmp ("CommitInterval", c->key) == 0)
1220 cf_util_get_cdtime (c, &db->commit_interval);
1221 else if (strcasecmp ("ExpireDelay", c->key) == 0)
1222 cf_util_get_cdtime (c, &db->expire_delay);
1223 else
1224 log_warn ("Ignoring unknown config key \"%s\".", c->key);
1225 }
1227 /* If no `Query' options were given, add the default queries.. */
1228 if ((db->queries_num == 0) && (db->writers_num == 0)){
1229 for (int i = 0; i < def_queries_num; i++)
1230 udb_query_pick_from_list_by_name (def_queries[i],
1231 queries, queries_num,
1232 &db->queries, &db->queries_num);
1233 }
1235 if (db->queries_num > 0) {
1236 db->q_prep_areas = (udb_query_preparation_area_t **) calloc (
1237 db->queries_num, sizeof (*db->q_prep_areas));
1239 if (db->q_prep_areas == NULL) {
1240 log_err ("Out of memory.");
1241 c_psql_database_delete (db);
1242 return -1;
1243 }
1244 }
1246 for (int i = 0; (size_t)i < db->queries_num; ++i) {
1247 c_psql_user_data_t *data;
1248 data = udb_query_get_user_data (db->queries[i]);
1249 if ((data != NULL) && (data->params_num > db->max_params_num))
1250 db->max_params_num = data->params_num;
1252 db->q_prep_areas[i]
1253 = udb_query_allocate_preparation_area (db->queries[i]);
1255 if (db->q_prep_areas[i] == NULL) {
1256 log_err ("Out of memory.");
1257 c_psql_database_delete (db);
1258 return -1;
1259 }
1260 }
1262 ssnprintf (cb_name, sizeof (cb_name), "postgresql-%s", db->instance);
1264 user_data_t ud = {
1265 .data = db,
1266 .free_func = c_psql_database_delete
1267 };
1269 if (db->queries_num > 0) {
1270 ++db->ref_cnt;
1271 plugin_register_complex_read ("postgresql", cb_name, c_psql_read,
1272 /* interval = */ db->interval, &ud);
1273 }
1274 if (db->writers_num > 0) {
1275 ++db->ref_cnt;
1276 plugin_register_write (cb_name, c_psql_write, &ud);
1278 if (! have_flush) {
1279 /* flush all */
1280 plugin_register_flush ("postgresql",
1281 c_psql_flush, /* user data = */ NULL);
1282 have_flush = 1;
1283 }
1285 /* flush this connection only */
1286 ++db->ref_cnt;
1287 plugin_register_flush (cb_name, c_psql_flush, &ud);
1288 }
1289 else if (db->commit_interval > 0) {
1290 log_warn ("Database '%s': You do not have any writers assigned to "
1291 "this database connection. Setting 'CommitInterval' does "
1292 "not have any effect.", db->database);
1293 }
1294 return 0;
1295 } /* c_psql_config_database */
1297 static int c_psql_config (oconfig_item_t *ci)
1298 {
1299 static int have_def_config = 0;
1301 if (0 == have_def_config) {
1302 oconfig_item_t *c;
1304 have_def_config = 1;
1306 c = oconfig_parse_file (C_PSQL_DEFAULT_CONF);
1307 if (NULL == c)
1308 log_err ("Failed to read default config ("C_PSQL_DEFAULT_CONF").");
1309 else
1310 c_psql_config (c);
1312 if (NULL == queries)
1313 log_err ("Default config ("C_PSQL_DEFAULT_CONF") did not define "
1314 "any queries - please check your installation.");
1315 }
1317 for (int i = 0; i < ci->children_num; ++i) {
1318 oconfig_item_t *c = ci->children + i;
1320 if (0 == strcasecmp (c->key, "Query"))
1321 udb_query_create (&queries, &queries_num, c,
1322 /* callback = */ config_query_callback);
1323 else if (0 == strcasecmp (c->key, "Writer"))
1324 c_psql_config_writer (c);
1325 else if (0 == strcasecmp (c->key, "Database"))
1326 c_psql_config_database (c);
1327 else
1328 log_warn ("Ignoring unknown config key \"%s\".", c->key);
1329 }
1330 return 0;
1331 } /* c_psql_config */
1333 void module_register (void)
1334 {
1335 plugin_register_complex_config ("postgresql", c_psql_config);
1336 plugin_register_shutdown ("postgresql", c_psql_shutdown);
1337 } /* module_register */
1339 /* vim: set sw=4 ts=4 tw=78 noexpandtab : */