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 "configfile.h"
38 #include "plugin.h"
40 #include "utils_cache.h"
41 #include "utils_db_query.h"
42 #include "utils_complain.h"
44 #include <pg_config_manual.h>
45 #include <libpq-fe.h>
47 #define log_err(...) ERROR ("postgresql: " __VA_ARGS__)
48 #define log_warn(...) WARNING ("postgresql: " __VA_ARGS__)
49 #define log_info(...) INFO ("postgresql: " __VA_ARGS__)
50 #define log_debug(...) DEBUG ("postgresql: " __VA_ARGS__)
52 #ifndef C_PSQL_DEFAULT_CONF
53 # define C_PSQL_DEFAULT_CONF PKGDATADIR "/postgresql_default.conf"
54 #endif
56 /* Appends the (parameter, value) pair to the string
57 * pointed to by 'buf' suitable to be used as argument
58 * for PQconnectdb(). If value equals NULL, the pair
59 * is ignored. */
60 #define C_PSQL_PAR_APPEND(buf, buf_len, parameter, value) \
61 if ((0 < (buf_len)) && (NULL != (value)) && ('\0' != *(value))) { \
62 int s = ssnprintf (buf, buf_len, " %s = '%s'", parameter, value); \
63 if (0 < s) { \
64 buf += s; \
65 buf_len -= s; \
66 } \
67 }
69 /* Returns the tuple (major, minor, patchlevel)
70 * for the given version number. */
71 #define C_PSQL_SERVER_VERSION3(server_version) \
72 (server_version) / 10000, \
73 (server_version) / 100 - (int)((server_version) / 10000) * 100, \
74 (server_version) - (int)((server_version) / 100) * 100
76 /* Returns true if the given host specifies a
77 * UNIX domain socket. */
78 #define C_PSQL_IS_UNIX_DOMAIN_SOCKET(host) \
79 ((NULL == (host)) || ('\0' == *(host)) || ('/' == *(host)))
81 /* Returns the tuple (host, delimiter, port) for a
82 * given (host, port) pair. Depending on the value of
83 * 'host' a UNIX domain socket or a TCP socket is
84 * assumed. */
85 #define C_PSQL_SOCKET3(host, port) \
86 ((NULL == (host)) || ('\0' == *(host))) ? DEFAULT_PGSOCKET_DIR : host, \
87 C_PSQL_IS_UNIX_DOMAIN_SOCKET (host) ? "/.s.PGSQL." : ":", \
88 port
90 typedef enum {
91 C_PSQL_PARAM_HOST = 1,
92 C_PSQL_PARAM_DB,
93 C_PSQL_PARAM_USER,
94 C_PSQL_PARAM_INTERVAL,
95 C_PSQL_PARAM_INSTANCE,
96 } c_psql_param_t;
98 /* Parameter configuration. Stored as `user data' in the query objects. */
99 typedef struct {
100 c_psql_param_t *params;
101 int params_num;
102 } c_psql_user_data_t;
104 typedef struct {
105 char *name;
106 char *statement;
107 _Bool store_rates;
108 } c_psql_writer_t;
110 typedef struct {
111 PGconn *conn;
112 c_complain_t conn_complaint;
114 int proto_version;
115 int server_version;
117 int max_params_num;
119 /* user configuration */
120 udb_query_preparation_area_t **q_prep_areas;
121 udb_query_t **queries;
122 size_t queries_num;
124 c_psql_writer_t **writers;
125 size_t writers_num;
127 /* make sure we don't access the database object in parallel */
128 pthread_mutex_t db_lock;
130 cdtime_t interval;
132 /* writer "caching" settings */
133 cdtime_t commit_interval;
134 cdtime_t next_commit;
135 cdtime_t expire_delay;
137 char *host;
138 char *port;
139 char *database;
140 char *user;
141 char *password;
143 char *instance;
145 char *sslmode;
147 char *krbsrvname;
149 char *service;
151 int ref_cnt;
152 } c_psql_database_t;
154 static const char *const def_queries[] = {
155 "backends",
156 "transactions",
157 "queries",
158 "query_plans",
159 "table_states",
160 "disk_io",
161 "disk_usage"
162 };
163 static int def_queries_num = STATIC_ARRAY_SIZE (def_queries);
165 static c_psql_database_t **databases = NULL;
166 static size_t databases_num = 0;
168 static udb_query_t **queries = NULL;
169 static size_t queries_num = 0;
171 static c_psql_writer_t *writers = NULL;
172 static size_t writers_num = 0;
174 static int c_psql_begin (c_psql_database_t *db)
175 {
176 PGresult *r = PQexec (db->conn, "BEGIN");
178 int status = 1;
180 if (r != NULL) {
181 if (PGRES_COMMAND_OK == PQresultStatus (r)) {
182 db->next_commit = cdtime() + db->commit_interval;
183 status = 0;
184 }
185 else
186 log_warn ("Failed to initiate ('BEGIN') transaction: %s",
187 PQerrorMessage (db->conn));
188 PQclear (r);
189 }
190 return status;
191 } /* c_psql_begin */
193 static int c_psql_commit (c_psql_database_t *db)
194 {
195 PGresult *r = PQexec (db->conn, "COMMIT");
197 int status = 1;
199 if (r != NULL) {
200 if (PGRES_COMMAND_OK == PQresultStatus (r)) {
201 db->next_commit = 0;
202 log_debug ("Successfully committed transaction.");
203 status = 0;
204 }
205 else
206 log_warn ("Failed to commit transaction: %s",
207 PQerrorMessage (db->conn));
208 PQclear (r);
209 }
210 return status;
211 } /* c_psql_commit */
213 static c_psql_database_t *c_psql_database_new (const char *name)
214 {
215 c_psql_database_t **tmp;
216 c_psql_database_t *db;
218 db = malloc (sizeof(*db));
219 if (NULL == db) {
220 log_err ("Out of memory.");
221 return NULL;
222 }
224 tmp = realloc (databases,
225 (databases_num + 1) * sizeof (*databases));
226 if (NULL == tmp) {
227 log_err ("Out of memory.");
228 sfree (db);
229 return NULL;
230 }
232 databases = tmp;
233 databases[databases_num] = db;
234 ++databases_num;
236 db->conn = NULL;
238 C_COMPLAIN_INIT (&db->conn_complaint);
240 db->proto_version = 0;
241 db->server_version = 0;
243 db->max_params_num = 0;
245 db->q_prep_areas = NULL;
246 db->queries = NULL;
247 db->queries_num = 0;
249 db->writers = NULL;
250 db->writers_num = 0;
252 pthread_mutex_init (&db->db_lock, /* attrs = */ NULL);
254 db->interval = 0;
256 db->commit_interval = 0;
257 db->next_commit = 0;
258 db->expire_delay = 0;
260 db->database = sstrdup (name);
261 db->host = NULL;
262 db->port = NULL;
263 db->user = NULL;
264 db->password = NULL;
266 db->instance = sstrdup (name);
268 db->sslmode = NULL;
270 db->krbsrvname = NULL;
272 db->service = NULL;
274 db->ref_cnt = 0;
275 return db;
276 } /* c_psql_database_new */
278 static void c_psql_database_delete (void *data)
279 {
280 size_t i;
282 c_psql_database_t *db = data;
284 --db->ref_cnt;
285 /* readers and writers may access this database */
286 if (db->ref_cnt > 0)
287 return;
289 /* wait for the lock to be released by the last writer */
290 pthread_mutex_lock (&db->db_lock);
292 if (db->next_commit > 0)
293 c_psql_commit (db);
295 PQfinish (db->conn);
296 db->conn = NULL;
298 if (db->q_prep_areas)
299 for (i = 0; i < db->queries_num; ++i)
300 udb_query_delete_preparation_area (db->q_prep_areas[i]);
301 free (db->q_prep_areas);
303 sfree (db->queries);
304 db->queries_num = 0;
306 sfree (db->writers);
307 db->writers_num = 0;
309 pthread_mutex_unlock (&db->db_lock);
311 pthread_mutex_destroy (&db->db_lock);
313 sfree (db->database);
314 sfree (db->host);
315 sfree (db->port);
316 sfree (db->user);
317 sfree (db->password);
319 sfree (db->instance);
321 sfree (db->sslmode);
323 sfree (db->krbsrvname);
325 sfree (db->service);
327 /* don't care about freeing or reordering the 'databases' array
328 * this is done in 'shutdown'; also, don't free the database instance
329 * object just to make sure that in case anybody accesses it before
330 * shutdown won't segfault */
331 return;
332 } /* c_psql_database_delete */
334 static int c_psql_connect (c_psql_database_t *db)
335 {
336 char conninfo[4096];
337 char *buf = conninfo;
338 int buf_len = sizeof (conninfo);
339 int status;
341 if ((! db) || (! db->database))
342 return -1;
344 status = ssnprintf (buf, buf_len, "dbname = '%s'", db->database);
345 if (0 < status) {
346 buf += status;
347 buf_len -= status;
348 }
350 C_PSQL_PAR_APPEND (buf, buf_len, "host", db->host);
351 C_PSQL_PAR_APPEND (buf, buf_len, "port", db->port);
352 C_PSQL_PAR_APPEND (buf, buf_len, "user", db->user);
353 C_PSQL_PAR_APPEND (buf, buf_len, "password", db->password);
354 C_PSQL_PAR_APPEND (buf, buf_len, "sslmode", db->sslmode);
355 C_PSQL_PAR_APPEND (buf, buf_len, "krbsrvname", db->krbsrvname);
356 C_PSQL_PAR_APPEND (buf, buf_len, "service", db->service);
358 db->conn = PQconnectdb (conninfo);
359 db->proto_version = PQprotocolVersion (db->conn);
360 return 0;
361 } /* c_psql_connect */
363 static int c_psql_check_connection (c_psql_database_t *db)
364 {
365 _Bool init = 0;
367 if (! db->conn) {
368 init = 1;
370 /* trigger c_release() */
371 if (0 == db->conn_complaint.interval)
372 db->conn_complaint.interval = 1;
374 c_psql_connect (db);
375 }
377 if (CONNECTION_OK != PQstatus (db->conn)) {
378 PQreset (db->conn);
380 /* trigger c_release() */
381 if (0 == db->conn_complaint.interval)
382 db->conn_complaint.interval = 1;
384 if (CONNECTION_OK != PQstatus (db->conn)) {
385 c_complain (LOG_ERR, &db->conn_complaint,
386 "Failed to connect to database %s (%s): %s",
387 db->database, db->instance,
388 PQerrorMessage (db->conn));
389 return -1;
390 }
392 db->proto_version = PQprotocolVersion (db->conn);
393 }
395 db->server_version = PQserverVersion (db->conn);
397 if (c_would_release (&db->conn_complaint)) {
398 char *server_host;
399 int server_version;
401 server_host = PQhost (db->conn);
402 server_version = PQserverVersion (db->conn);
404 c_do_release (LOG_INFO, &db->conn_complaint,
405 "Successfully %sconnected to database %s (user %s) "
406 "at server %s%s%s (server version: %d.%d.%d, "
407 "protocol version: %d, pid: %d)", init ? "" : "re",
408 PQdb (db->conn), PQuser (db->conn),
409 C_PSQL_SOCKET3 (server_host, PQport (db->conn)),
410 C_PSQL_SERVER_VERSION3 (server_version),
411 db->proto_version, PQbackendPID (db->conn));
413 if (3 > db->proto_version)
414 log_warn ("Protocol version %d does not support parameters.",
415 db->proto_version);
416 }
417 return 0;
418 } /* c_psql_check_connection */
420 static PGresult *c_psql_exec_query_noparams (c_psql_database_t *db,
421 udb_query_t *q)
422 {
423 return PQexec (db->conn, udb_query_get_statement (q));
424 } /* c_psql_exec_query_noparams */
426 static PGresult *c_psql_exec_query_params (c_psql_database_t *db,
427 udb_query_t *q, c_psql_user_data_t *data)
428 {
429 const char *params[db->max_params_num];
430 char interval[64];
431 int i;
433 if ((data == NULL) || (data->params_num == 0))
434 return (c_psql_exec_query_noparams (db, q));
436 assert (db->max_params_num >= data->params_num);
438 for (i = 0; i < data->params_num; ++i) {
439 switch (data->params[i]) {
440 case C_PSQL_PARAM_HOST:
441 params[i] = C_PSQL_IS_UNIX_DOMAIN_SOCKET (db->host)
442 ? "localhost" : db->host;
443 break;
444 case C_PSQL_PARAM_DB:
445 params[i] = db->database;
446 break;
447 case C_PSQL_PARAM_USER:
448 params[i] = db->user;
449 break;
450 case C_PSQL_PARAM_INTERVAL:
451 ssnprintf (interval, sizeof (interval), "%.3f",
452 (db->interval > 0)
453 ? CDTIME_T_TO_DOUBLE (db->interval)
454 : plugin_get_interval ());
455 params[i] = interval;
456 break;
457 case C_PSQL_PARAM_INSTANCE:
458 params[i] = db->instance;
459 break;
460 default:
461 assert (0);
462 }
463 }
465 return PQexecParams (db->conn, udb_query_get_statement (q),
466 data->params_num, NULL,
467 (const char *const *) params,
468 NULL, NULL, /* return text data */ 0);
469 } /* c_psql_exec_query_params */
471 /* db->db_lock must be locked when calling this function */
472 static int c_psql_exec_query (c_psql_database_t *db, udb_query_t *q,
473 udb_query_preparation_area_t *prep_area)
474 {
475 PGresult *res;
477 c_psql_user_data_t *data;
479 const char *host;
481 char **column_names;
482 char **column_values;
483 int column_num;
485 int rows_num;
486 int status;
487 int row, col;
489 /* The user data may hold parameter information, but may be NULL. */
490 data = udb_query_get_user_data (q);
492 /* Versions up to `3' don't know how to handle parameters. */
493 if (3 <= db->proto_version)
494 res = c_psql_exec_query_params (db, q, data);
495 else if ((NULL == data) || (0 == data->params_num))
496 res = c_psql_exec_query_noparams (db, q);
497 else {
498 log_err ("Connection to database \"%s\" (%s) does not support "
499 "parameters (protocol version %d) - "
500 "cannot execute query \"%s\".",
501 db->database, db->instance, db->proto_version,
502 udb_query_get_name (q));
503 return -1;
504 }
506 /* give c_psql_write() a chance to acquire the lock if called recursively
507 * through dispatch_values(); this will happen if, both, queries and
508 * writers are configured for a single connection */
509 pthread_mutex_unlock (&db->db_lock);
511 column_names = NULL;
512 column_values = NULL;
514 if (PGRES_TUPLES_OK != PQresultStatus (res)) {
515 pthread_mutex_lock (&db->db_lock);
517 if ((CONNECTION_OK != PQstatus (db->conn))
518 && (0 == c_psql_check_connection (db))) {
519 PQclear (res);
520 return c_psql_exec_query (db, q, prep_area);
521 }
523 log_err ("Failed to execute SQL query: %s",
524 PQerrorMessage (db->conn));
525 log_info ("SQL query was: %s",
526 udb_query_get_statement (q));
527 PQclear (res);
528 return -1;
529 }
531 #define BAIL_OUT(status) \
532 sfree (column_names); \
533 sfree (column_values); \
534 PQclear (res); \
535 pthread_mutex_lock (&db->db_lock); \
536 return status
538 rows_num = PQntuples (res);
539 if (1 > rows_num) {
540 BAIL_OUT (0);
541 }
543 column_num = PQnfields (res);
544 column_names = (char **) calloc (column_num, sizeof (char *));
545 if (NULL == column_names) {
546 log_err ("calloc failed.");
547 BAIL_OUT (-1);
548 }
550 column_values = (char **) calloc (column_num, sizeof (char *));
551 if (NULL == column_values) {
552 log_err ("calloc failed.");
553 BAIL_OUT (-1);
554 }
556 for (col = 0; col < column_num; ++col) {
557 /* Pointers returned by `PQfname' are freed by `PQclear' via
558 * `BAIL_OUT'. */
559 column_names[col] = PQfname (res, col);
560 if (NULL == column_names[col]) {
561 log_err ("Failed to resolve name of column %i.", col);
562 BAIL_OUT (-1);
563 }
564 }
566 if (C_PSQL_IS_UNIX_DOMAIN_SOCKET (db->host)
567 || (0 == strcmp (db->host, "127.0.0.1"))
568 || (0 == strcmp (db->host, "localhost")))
569 host = hostname_g;
570 else
571 host = db->host;
573 status = udb_query_prepare_result (q, prep_area, host, "postgresql",
574 db->instance, column_names, (size_t) column_num, db->interval);
575 if (0 != status) {
576 log_err ("udb_query_prepare_result failed with status %i.",
577 status);
578 BAIL_OUT (-1);
579 }
581 for (row = 0; row < rows_num; ++row) {
582 for (col = 0; col < column_num; ++col) {
583 /* Pointers returned by `PQgetvalue' are freed by `PQclear' via
584 * `BAIL_OUT'. */
585 column_values[col] = PQgetvalue (res, row, col);
586 if (NULL == column_values[col]) {
587 log_err ("Failed to get value at (row = %i, col = %i).",
588 row, col);
589 break;
590 }
591 }
593 /* check for an error */
594 if (col < column_num)
595 continue;
597 status = udb_query_handle_result (q, prep_area, column_values);
598 if (status != 0) {
599 log_err ("udb_query_handle_result failed with status %i.",
600 status);
601 }
602 } /* for (row = 0; row < rows_num; ++row) */
604 udb_query_finish_result (q, prep_area);
606 BAIL_OUT (0);
607 #undef BAIL_OUT
608 } /* c_psql_exec_query */
610 static int c_psql_read (user_data_t *ud)
611 {
612 c_psql_database_t *db;
614 int success = 0;
615 size_t i;
617 if ((ud == NULL) || (ud->data == NULL)) {
618 log_err ("c_psql_read: Invalid user data.");
619 return -1;
620 }
622 db = ud->data;
624 assert (NULL != db->database);
625 assert (NULL != db->instance);
626 assert (NULL != db->queries);
628 pthread_mutex_lock (&db->db_lock);
630 if (0 != c_psql_check_connection (db)) {
631 pthread_mutex_unlock (&db->db_lock);
632 return -1;
633 }
635 for (i = 0; i < db->queries_num; ++i)
636 {
637 udb_query_preparation_area_t *prep_area;
638 udb_query_t *q;
640 prep_area = db->q_prep_areas[i];
641 q = db->queries[i];
643 if ((0 != db->server_version)
644 && (udb_query_check_version (q, db->server_version) <= 0))
645 continue;
647 if (0 == c_psql_exec_query (db, q, prep_area))
648 success = 1;
649 }
651 pthread_mutex_unlock (&db->db_lock);
653 if (! success)
654 return -1;
655 return 0;
656 } /* c_psql_read */
658 static char *values_name_to_sqlarray (const data_set_t *ds,
659 char *string, size_t string_len)
660 {
661 char *str_ptr;
662 size_t str_len;
663 size_t i;
665 str_ptr = string;
666 str_len = string_len;
668 for (i = 0; i < ds->ds_num; ++i) {
669 int status = ssnprintf (str_ptr, str_len, ",'%s'", ds->ds[i].name);
671 if (status < 1)
672 return NULL;
673 else if ((size_t)status >= str_len) {
674 str_len = 0;
675 break;
676 }
677 else {
678 str_ptr += status;
679 str_len -= (size_t)status;
680 }
681 }
683 if (str_len <= 2) {
684 log_err ("c_psql_write: Failed to stringify value names");
685 return NULL;
686 }
688 /* overwrite the first comma */
689 string[0] = '{';
690 str_ptr[0] = '}';
691 str_ptr[1] = '\0';
693 return string;
694 } /* values_name_to_sqlarray */
696 static char *values_type_to_sqlarray (const data_set_t *ds,
697 char *string, size_t string_len, _Bool store_rates)
698 {
699 char *str_ptr;
700 size_t str_len;
701 size_t i;
703 str_ptr = string;
704 str_len = string_len;
706 for (i = 0; i < ds->ds_num; ++i) {
707 int status;
709 if (store_rates)
710 status = ssnprintf(str_ptr, str_len, ",'gauge'");
711 else
712 status = ssnprintf(str_ptr, str_len, ",'%s'",
713 DS_TYPE_TO_STRING (ds->ds[i].type));
715 if (status < 1) {
716 str_len = 0;
717 break;
718 }
719 else if ((size_t)status >= str_len) {
720 str_len = 0;
721 break;
722 }
723 else {
724 str_ptr += status;
725 str_len -= (size_t)status;
726 }
727 }
729 if (str_len <= 2) {
730 log_err ("c_psql_write: Failed to stringify value types");
731 return NULL;
732 }
734 /* overwrite the first comma */
735 string[0] = '{';
736 str_ptr[0] = '}';
737 str_ptr[1] = '\0';
739 return string;
740 } /* values_type_to_sqlarray */
742 static char *values_to_sqlarray (const data_set_t *ds, const value_list_t *vl,
743 char *string, size_t string_len, _Bool store_rates)
744 {
745 char *str_ptr;
746 size_t str_len;
748 gauge_t *rates = NULL;
749 size_t i;
751 str_ptr = string;
752 str_len = string_len;
754 for (i = 0; i < vl->values_len; ++i) {
755 int status = 0;
757 if ((ds->ds[i].type != DS_TYPE_GAUGE)
758 && (ds->ds[i].type != DS_TYPE_COUNTER)
759 && (ds->ds[i].type != DS_TYPE_DERIVE)
760 && (ds->ds[i].type != DS_TYPE_ABSOLUTE)) {
761 log_err ("c_psql_write: Unknown data source type: %i",
762 ds->ds[i].type);
763 sfree (rates);
764 return NULL;
765 }
767 if (ds->ds[i].type == DS_TYPE_GAUGE)
768 status = ssnprintf (str_ptr, str_len,
769 ","GAUGE_FORMAT, vl->values[i].gauge);
770 else if (store_rates) {
771 if (rates == NULL)
772 rates = uc_get_rate (ds, vl);
774 if (rates == NULL) {
775 log_err ("c_psql_write: Failed to determine rate");
776 return NULL;
777 }
779 status = ssnprintf (str_ptr, str_len,
780 ",%lf", rates[i]);
781 }
782 else if (ds->ds[i].type == DS_TYPE_COUNTER)
783 status = ssnprintf (str_ptr, str_len,
784 ",%llu", vl->values[i].counter);
785 else if (ds->ds[i].type == DS_TYPE_DERIVE)
786 status = ssnprintf (str_ptr, str_len,
787 ",%"PRIi64, vl->values[i].derive);
788 else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
789 status = ssnprintf (str_ptr, str_len,
790 ",%"PRIu64, vl->values[i].absolute);
792 if (status < 1) {
793 str_len = 0;
794 break;
795 }
796 else if ((size_t)status >= str_len) {
797 str_len = 0;
798 break;
799 }
800 else {
801 str_ptr += status;
802 str_len -= (size_t)status;
803 }
804 }
806 sfree (rates);
808 if (str_len <= 2) {
809 log_err ("c_psql_write: Failed to stringify value list");
810 return NULL;
811 }
813 /* overwrite the first comma */
814 string[0] = '{';
815 str_ptr[0] = '}';
816 str_ptr[1] = '\0';
818 return string;
819 } /* values_to_sqlarray */
821 static int c_psql_write (const data_set_t *ds, const value_list_t *vl,
822 user_data_t *ud)
823 {
824 c_psql_database_t *db;
826 char time_str[RFC3339NANO_SIZE];
827 char values_name_str[1024];
828 char values_type_str[1024];
829 char values_str[1024];
831 const char *params[9];
833 int success = 0;
834 size_t i;
836 if ((ud == NULL) || (ud->data == NULL)) {
837 log_err ("c_psql_write: Invalid user data.");
838 return -1;
839 }
841 db = ud->data;
842 assert (db->database != NULL);
843 assert (db->writers != NULL);
845 if (rfc3339nano (time_str, sizeof (time_str), vl->time) != 0) {
846 log_err ("c_psql_write: Failed to convert time to RFC 3339 format");
847 return -1;
848 }
850 if (values_name_to_sqlarray (ds,
851 values_name_str, sizeof (values_name_str)) == NULL)
852 return -1;
854 #define VALUE_OR_NULL(v) ((((v) == NULL) || (*(v) == '\0')) ? NULL : (v))
856 params[0] = time_str;
857 params[1] = vl->host;
858 params[2] = vl->plugin;
859 params[3] = VALUE_OR_NULL(vl->plugin_instance);
860 params[4] = vl->type;
861 params[5] = VALUE_OR_NULL(vl->type_instance);
862 params[6] = values_name_str;
864 #undef VALUE_OR_NULL
866 if( db->expire_delay > 0 && vl->time < (cdtime() - vl->interval - db->expire_delay) ) {
867 log_info ("c_psql_write: Skipped expired value @ %s - %s/%s-%s/%s-%s/%s",
868 params[0], params[1], params[2], params[3], params[4], params[5], params[6] );
869 return 0;
870 }
872 pthread_mutex_lock (&db->db_lock);
874 if (0 != c_psql_check_connection (db)) {
875 pthread_mutex_unlock (&db->db_lock);
876 return -1;
877 }
879 if ((db->commit_interval > 0)
880 && (db->next_commit == 0))
881 c_psql_begin (db);
883 for (i = 0; i < db->writers_num; ++i) {
884 c_psql_writer_t *writer;
885 PGresult *res;
887 writer = db->writers[i];
889 if (values_type_to_sqlarray (ds,
890 values_type_str, sizeof (values_type_str),
891 writer->store_rates) == NULL) {
892 pthread_mutex_unlock (&db->db_lock);
893 return -1;
894 }
896 if (values_to_sqlarray (ds, vl,
897 values_str, sizeof (values_str),
898 writer->store_rates) == NULL) {
899 pthread_mutex_unlock (&db->db_lock);
900 return -1;
901 }
903 params[7] = values_type_str;
904 params[8] = values_str;
906 res = PQexecParams (db->conn, writer->statement,
907 STATIC_ARRAY_SIZE (params), NULL,
908 (const char *const *)params,
909 NULL, NULL, /* return text data */ 0);
911 if ((PGRES_COMMAND_OK != PQresultStatus (res))
912 && (PGRES_TUPLES_OK != PQresultStatus (res))) {
913 PQclear (res);
915 if ((CONNECTION_OK != PQstatus (db->conn))
916 && (0 == c_psql_check_connection (db))) {
917 /* try again */
918 res = PQexecParams (db->conn, writer->statement,
919 STATIC_ARRAY_SIZE (params), NULL,
920 (const char *const *)params,
921 NULL, NULL, /* return text data */ 0);
923 if ((PGRES_COMMAND_OK == PQresultStatus (res))
924 || (PGRES_TUPLES_OK == PQresultStatus (res))) {
925 PQclear (res);
926 success = 1;
927 continue;
928 }
929 }
931 log_err ("Failed to execute SQL query: %s",
932 PQerrorMessage (db->conn));
933 log_info ("SQL query was: '%s', "
934 "params: %s, %s, %s, %s, %s, %s, %s, %s",
935 writer->statement,
936 params[0], params[1], params[2], params[3],
937 params[4], params[5], params[6], params[7]);
939 /* this will abort any current transaction -> restart */
940 if (db->next_commit > 0)
941 c_psql_commit (db);
943 pthread_mutex_unlock (&db->db_lock);
944 return -1;
945 }
947 PQclear (res);
948 success = 1;
949 }
951 if ((db->next_commit > 0)
952 && (cdtime () > db->next_commit))
953 c_psql_commit (db);
955 pthread_mutex_unlock (&db->db_lock);
957 if (! success)
958 return -1;
959 return 0;
960 } /* c_psql_write */
962 /* We cannot flush single identifiers as all we do is to commit the currently
963 * running transaction, thus making sure that all written data is actually
964 * visible to everybody. */
965 static int c_psql_flush (cdtime_t timeout,
966 __attribute__((unused)) const char *ident,
967 user_data_t *ud)
968 {
969 c_psql_database_t **dbs = databases;
970 size_t dbs_num = databases_num;
971 size_t i;
973 if ((ud != NULL) && (ud->data != NULL)) {
974 dbs = (void *)&ud->data;
975 dbs_num = 1;
976 }
978 for (i = 0; i < dbs_num; ++i) {
979 c_psql_database_t *db = dbs[i];
981 /* don't commit if the timeout is larger than the regular commit
982 * interval as in that case all requested data has already been
983 * committed */
984 if ((db->next_commit > 0) && (db->commit_interval > timeout))
985 c_psql_commit (db);
986 }
987 return 0;
988 } /* c_psql_flush */
990 static int c_psql_shutdown (void)
991 {
992 size_t i = 0;
994 _Bool had_flush = 0;
996 plugin_unregister_read_group ("postgresql");
998 for (i = 0; i < databases_num; ++i) {
999 c_psql_database_t *db = databases[i];
1001 if (db->writers_num > 0) {
1002 char cb_name[DATA_MAX_NAME_LEN];
1003 ssnprintf (cb_name, sizeof (cb_name), "postgresql-%s",
1004 db->database);
1006 if (! had_flush) {
1007 plugin_unregister_flush ("postgresql");
1008 had_flush = 1;
1009 }
1011 plugin_unregister_flush (cb_name);
1012 plugin_unregister_write (cb_name);
1013 }
1015 sfree (db);
1016 }
1018 udb_query_free (queries, queries_num);
1019 queries = NULL;
1020 queries_num = 0;
1022 sfree (writers);
1023 writers = NULL;
1024 writers_num = 0;
1026 sfree (databases);
1027 databases = NULL;
1028 databases_num = 0;
1030 return 0;
1031 } /* c_psql_shutdown */
1033 static int config_query_param_add (udb_query_t *q, oconfig_item_t *ci)
1034 {
1035 c_psql_user_data_t *data;
1036 const char *param_str;
1038 c_psql_param_t *tmp;
1040 data = udb_query_get_user_data (q);
1041 if (NULL == data) {
1042 data = calloc (1, sizeof (*data));
1043 if (NULL == data) {
1044 log_err ("Out of memory.");
1045 return -1;
1046 }
1047 data->params = NULL;
1048 data->params_num = 0;
1050 udb_query_set_user_data (q, data);
1051 }
1053 tmp = realloc (data->params, (data->params_num + 1) * sizeof (*data->params));
1054 if (NULL == tmp) {
1055 log_err ("Out of memory.");
1056 return -1;
1057 }
1058 data->params = tmp;
1060 param_str = ci->values[0].value.string;
1061 if (0 == strcasecmp (param_str, "hostname"))
1062 data->params[data->params_num] = C_PSQL_PARAM_HOST;
1063 else if (0 == strcasecmp (param_str, "database"))
1064 data->params[data->params_num] = C_PSQL_PARAM_DB;
1065 else if (0 == strcasecmp (param_str, "username"))
1066 data->params[data->params_num] = C_PSQL_PARAM_USER;
1067 else if (0 == strcasecmp (param_str, "interval"))
1068 data->params[data->params_num] = C_PSQL_PARAM_INTERVAL;
1069 else if (0 == strcasecmp (param_str, "instance"))
1070 data->params[data->params_num] = C_PSQL_PARAM_INSTANCE;
1071 else {
1072 log_err ("Invalid parameter \"%s\".", param_str);
1073 return 1;
1074 }
1076 data->params_num++;
1077 return (0);
1078 } /* config_query_param_add */
1080 static int config_query_callback (udb_query_t *q, oconfig_item_t *ci)
1081 {
1082 if (0 == strcasecmp ("Param", ci->key))
1083 return config_query_param_add (q, ci);
1085 log_err ("Option not allowed within a Query block: `%s'", ci->key);
1087 return (-1);
1088 } /* config_query_callback */
1090 static int config_add_writer (oconfig_item_t *ci,
1091 c_psql_writer_t *src_writers, size_t src_writers_num,
1092 c_psql_writer_t ***dst_writers, size_t *dst_writers_num)
1093 {
1094 char *name;
1096 size_t i;
1098 if ((ci == NULL) || (dst_writers == NULL) || (dst_writers_num == NULL))
1099 return -1;
1101 if ((ci->values_num != 1)
1102 || (ci->values[0].type != OCONFIG_TYPE_STRING)) {
1103 log_err ("`Writer' expects a single string argument.");
1104 return 1;
1105 }
1107 name = ci->values[0].value.string;
1109 for (i = 0; i < src_writers_num; ++i) {
1110 c_psql_writer_t **tmp;
1112 if (strcasecmp (name, src_writers[i].name) != 0)
1113 continue;
1115 tmp = realloc (*dst_writers,
1116 sizeof (**dst_writers) * (*dst_writers_num + 1));
1117 if (tmp == NULL) {
1118 log_err ("Out of memory.");
1119 return -1;
1120 }
1122 tmp[*dst_writers_num] = src_writers + i;
1124 *dst_writers = tmp;
1125 ++(*dst_writers_num);
1126 break;
1127 }
1129 if (i >= src_writers_num) {
1130 log_err ("No such writer: `%s'", name);
1131 return -1;
1132 }
1134 return 0;
1135 } /* config_add_writer */
1137 static int c_psql_config_writer (oconfig_item_t *ci)
1138 {
1139 c_psql_writer_t *writer;
1140 c_psql_writer_t *tmp;
1142 int status = 0;
1143 int i;
1145 if ((ci->values_num != 1)
1146 || (ci->values[0].type != OCONFIG_TYPE_STRING)) {
1147 log_err ("<Writer> expects a single string argument.");
1148 return 1;
1149 }
1151 tmp = realloc (writers,
1152 sizeof (*writers) * (writers_num + 1));
1153 if (tmp == NULL) {
1154 log_err ("Out of memory.");
1155 return -1;
1156 }
1158 writers = tmp;
1159 writer = writers + writers_num;
1160 memset (writer, 0, sizeof (*writer));
1162 writer->name = sstrdup (ci->values[0].value.string);
1163 writer->statement = NULL;
1164 writer->store_rates = 1;
1166 for (i = 0; i < ci->children_num; ++i) {
1167 oconfig_item_t *c = ci->children + i;
1169 if (strcasecmp ("Statement", c->key) == 0)
1170 status = cf_util_get_string (c, &writer->statement);
1171 else if (strcasecmp ("StoreRates", c->key) == 0)
1172 status = cf_util_get_boolean (c, &writer->store_rates);
1173 else
1174 log_warn ("Ignoring unknown config key \"%s\".", c->key);
1175 }
1177 if (status != 0) {
1178 sfree (writer->statement);
1179 sfree (writer->name);
1180 return status;
1181 }
1183 ++writers_num;
1184 return 0;
1185 } /* c_psql_config_writer */
1187 static int c_psql_config_database (oconfig_item_t *ci)
1188 {
1189 c_psql_database_t *db;
1191 char cb_name[DATA_MAX_NAME_LEN];
1192 user_data_t ud = { 0 };
1194 static _Bool have_flush = 0;
1196 int i;
1198 if ((1 != ci->values_num)
1199 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1200 log_err ("<Database> expects a single string argument.");
1201 return 1;
1202 }
1204 db = c_psql_database_new (ci->values[0].value.string);
1205 if (db == NULL)
1206 return -1;
1208 for (i = 0; i < ci->children_num; ++i) {
1209 oconfig_item_t *c = ci->children + i;
1211 if (0 == strcasecmp (c->key, "Host"))
1212 cf_util_get_string (c, &db->host);
1213 else if (0 == strcasecmp (c->key, "Port"))
1214 cf_util_get_service (c, &db->port);
1215 else if (0 == strcasecmp (c->key, "User"))
1216 cf_util_get_string (c, &db->user);
1217 else if (0 == strcasecmp (c->key, "Password"))
1218 cf_util_get_string (c, &db->password);
1219 else if (0 == strcasecmp (c->key, "Instance"))
1220 cf_util_get_string (c, &db->instance);
1221 else if (0 == strcasecmp (c->key, "SSLMode"))
1222 cf_util_get_string (c, &db->sslmode);
1223 else if (0 == strcasecmp (c->key, "KRBSrvName"))
1224 cf_util_get_string (c, &db->krbsrvname);
1225 else if (0 == strcasecmp (c->key, "Service"))
1226 cf_util_get_string (c, &db->service);
1227 else if (0 == strcasecmp (c->key, "Query"))
1228 udb_query_pick_from_list (c, queries, queries_num,
1229 &db->queries, &db->queries_num);
1230 else if (0 == strcasecmp (c->key, "Writer"))
1231 config_add_writer (c, writers, writers_num,
1232 &db->writers, &db->writers_num);
1233 else if (0 == strcasecmp (c->key, "Interval"))
1234 cf_util_get_cdtime (c, &db->interval);
1235 else if (strcasecmp ("CommitInterval", c->key) == 0)
1236 cf_util_get_cdtime (c, &db->commit_interval);
1237 else if (strcasecmp ("ExpireDelay", c->key) == 0)
1238 cf_util_get_cdtime (c, &db->expire_delay);
1239 else
1240 log_warn ("Ignoring unknown config key \"%s\".", c->key);
1241 }
1243 /* If no `Query' options were given, add the default queries.. */
1244 if ((db->queries_num == 0) && (db->writers_num == 0)){
1245 for (i = 0; i < def_queries_num; i++)
1246 udb_query_pick_from_list_by_name (def_queries[i],
1247 queries, queries_num,
1248 &db->queries, &db->queries_num);
1249 }
1251 if (db->queries_num > 0) {
1252 db->q_prep_areas = (udb_query_preparation_area_t **) calloc (
1253 db->queries_num, sizeof (*db->q_prep_areas));
1255 if (db->q_prep_areas == NULL) {
1256 log_err ("Out of memory.");
1257 c_psql_database_delete (db);
1258 return -1;
1259 }
1260 }
1262 for (i = 0; (size_t)i < db->queries_num; ++i) {
1263 c_psql_user_data_t *data;
1264 data = udb_query_get_user_data (db->queries[i]);
1265 if ((data != NULL) && (data->params_num > db->max_params_num))
1266 db->max_params_num = data->params_num;
1268 db->q_prep_areas[i]
1269 = udb_query_allocate_preparation_area (db->queries[i]);
1271 if (db->q_prep_areas[i] == NULL) {
1272 log_err ("Out of memory.");
1273 c_psql_database_delete (db);
1274 return -1;
1275 }
1276 }
1278 ud.data = db;
1279 ud.free_func = c_psql_database_delete;
1281 ssnprintf (cb_name, sizeof (cb_name), "postgresql-%s", db->instance);
1283 if (db->queries_num > 0) {
1284 ++db->ref_cnt;
1285 plugin_register_complex_read ("postgresql", cb_name, c_psql_read,
1286 /* interval = */ db->interval, &ud);
1287 }
1288 if (db->writers_num > 0) {
1289 ++db->ref_cnt;
1290 plugin_register_write (cb_name, c_psql_write, &ud);
1292 if (! have_flush) {
1293 /* flush all */
1294 plugin_register_flush ("postgresql",
1295 c_psql_flush, /* user data = */ NULL);
1296 have_flush = 1;
1297 }
1299 /* flush this connection only */
1300 ++db->ref_cnt;
1301 plugin_register_flush (cb_name, c_psql_flush, &ud);
1302 }
1303 else if (db->commit_interval > 0) {
1304 log_warn ("Database '%s': You do not have any writers assigned to "
1305 "this database connection. Setting 'CommitInterval' does "
1306 "not have any effect.", db->database);
1307 }
1308 return 0;
1309 } /* c_psql_config_database */
1311 static int c_psql_config (oconfig_item_t *ci)
1312 {
1313 static int have_def_config = 0;
1315 int i;
1317 if (0 == have_def_config) {
1318 oconfig_item_t *c;
1320 have_def_config = 1;
1322 c = oconfig_parse_file (C_PSQL_DEFAULT_CONF);
1323 if (NULL == c)
1324 log_err ("Failed to read default config ("C_PSQL_DEFAULT_CONF").");
1325 else
1326 c_psql_config (c);
1328 if (NULL == queries)
1329 log_err ("Default config ("C_PSQL_DEFAULT_CONF") did not define "
1330 "any queries - please check your installation.");
1331 }
1333 for (i = 0; i < ci->children_num; ++i) {
1334 oconfig_item_t *c = ci->children + i;
1336 if (0 == strcasecmp (c->key, "Query"))
1337 udb_query_create (&queries, &queries_num, c,
1338 /* callback = */ config_query_callback);
1339 else if (0 == strcasecmp (c->key, "Writer"))
1340 c_psql_config_writer (c);
1341 else if (0 == strcasecmp (c->key, "Database"))
1342 c_psql_config_database (c);
1343 else
1344 log_warn ("Ignoring unknown config key \"%s\".", c->key);
1345 }
1346 return 0;
1347 } /* c_psql_config */
1349 void module_register (void)
1350 {
1351 plugin_register_complex_config ("postgresql", c_psql_config);
1352 plugin_register_shutdown ("postgresql", c_psql_shutdown);
1353 } /* module_register */
1355 /* vim: set sw=4 ts=4 tw=78 noexpandtab : */