1 /**
2 * collectd - src/postgresql.c
3 * Copyright (C) 2008-2012 Sebastian Harl
4 * Copyright (C) 2009 Florian Forster
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * - Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 *
14 * - Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGE.
29 *
30 * Authors:
31 * Sebastian Harl <sh at tokkee.org>
32 * Florian Forster <octo at verplant.org>
33 **/
35 /*
36 * This module collects PostgreSQL database statistics.
37 */
39 #include "collectd.h"
40 #include "common.h"
42 #include "configfile.h"
43 #include "plugin.h"
45 #include "utils_cache.h"
46 #include "utils_db_query.h"
47 #include "utils_complain.h"
49 #if HAVE_PTHREAD_H
50 # include <pthread.h>
51 #endif
53 #include <pg_config_manual.h>
54 #include <libpq-fe.h>
56 #define log_err(...) ERROR ("postgresql: " __VA_ARGS__)
57 #define log_warn(...) WARNING ("postgresql: " __VA_ARGS__)
58 #define log_info(...) INFO ("postgresql: " __VA_ARGS__)
59 #define log_debug(...) DEBUG ("postgresql: " __VA_ARGS__)
61 #ifndef C_PSQL_DEFAULT_CONF
62 # define C_PSQL_DEFAULT_CONF PKGDATADIR "/postgresql_default.conf"
63 #endif
65 /* Appends the (parameter, value) pair to the string
66 * pointed to by 'buf' suitable to be used as argument
67 * for PQconnectdb(). If value equals NULL, the pair
68 * is ignored. */
69 #define C_PSQL_PAR_APPEND(buf, buf_len, parameter, value) \
70 if ((0 < (buf_len)) && (NULL != (value)) && ('\0' != *(value))) { \
71 int s = ssnprintf (buf, buf_len, " %s = '%s'", parameter, value); \
72 if (0 < s) { \
73 buf += s; \
74 buf_len -= s; \
75 } \
76 }
78 /* Returns the tuple (major, minor, patchlevel)
79 * for the given version number. */
80 #define C_PSQL_SERVER_VERSION3(server_version) \
81 (server_version) / 10000, \
82 (server_version) / 100 - (int)((server_version) / 10000) * 100, \
83 (server_version) - (int)((server_version) / 100) * 100
85 /* Returns true if the given host specifies a
86 * UNIX domain socket. */
87 #define C_PSQL_IS_UNIX_DOMAIN_SOCKET(host) \
88 ((NULL == (host)) || ('\0' == *(host)) || ('/' == *(host)))
90 /* Returns the tuple (host, delimiter, port) for a
91 * given (host, port) pair. Depending on the value of
92 * 'host' a UNIX domain socket or a TCP socket is
93 * assumed. */
94 #define C_PSQL_SOCKET3(host, port) \
95 ((NULL == (host)) || ('\0' == *(host))) ? DEFAULT_PGSOCKET_DIR : host, \
96 C_PSQL_IS_UNIX_DOMAIN_SOCKET (host) ? "/.s.PGSQL." : ":", \
97 port
99 typedef enum {
100 C_PSQL_PARAM_HOST = 1,
101 C_PSQL_PARAM_DB,
102 C_PSQL_PARAM_USER,
103 C_PSQL_PARAM_INTERVAL,
104 C_PSQL_PARAM_INSTANCE,
105 } c_psql_param_t;
107 /* Parameter configuration. Stored as `user data' in the query objects. */
108 typedef struct {
109 c_psql_param_t *params;
110 int params_num;
111 } c_psql_user_data_t;
113 typedef struct {
114 char *name;
115 char *statement;
116 _Bool store_rates;
117 } c_psql_writer_t;
119 typedef struct {
120 PGconn *conn;
121 c_complain_t conn_complaint;
123 int proto_version;
124 int server_version;
126 int max_params_num;
128 /* user configuration */
129 udb_query_preparation_area_t **q_prep_areas;
130 udb_query_t **queries;
131 size_t queries_num;
133 c_psql_writer_t **writers;
134 size_t writers_num;
136 /* make sure we don't access the database object in parallel */
137 pthread_mutex_t db_lock;
139 cdtime_t interval;
141 /* writer "caching" settings */
142 cdtime_t commit_interval;
143 cdtime_t next_commit;
145 char *host;
146 char *port;
147 char *database;
148 char *user;
149 char *password;
151 char *instance;
153 char *sslmode;
155 char *krbsrvname;
157 char *service;
159 int ref_cnt;
160 } c_psql_database_t;
162 static char *def_queries[] = {
163 "backends",
164 "transactions",
165 "queries",
166 "query_plans",
167 "table_states",
168 "disk_io",
169 "disk_usage"
170 };
171 static int def_queries_num = STATIC_ARRAY_SIZE (def_queries);
173 static c_psql_database_t **databases = NULL;
174 static size_t databases_num = 0;
176 static udb_query_t **queries = NULL;
177 static size_t queries_num = 0;
179 static c_psql_writer_t *writers = NULL;
180 static size_t writers_num = 0;
182 static int c_psql_begin (c_psql_database_t *db)
183 {
184 PGresult *r = PQexec (db->conn, "BEGIN");
186 int status = 1;
188 if (r != NULL) {
189 if (PGRES_COMMAND_OK == PQresultStatus (r)) {
190 db->next_commit = cdtime() + db->commit_interval;
191 status = 0;
192 }
193 else
194 log_warn ("Failed to initiate ('BEGIN') transaction: %s",
195 PQerrorMessage (db->conn));
196 PQclear (r);
197 }
198 return status;
199 } /* c_psql_begin */
201 static int c_psql_commit (c_psql_database_t *db)
202 {
203 PGresult *r = PQexec (db->conn, "COMMIT");
205 int status = 1;
207 if (r != NULL) {
208 if (PGRES_COMMAND_OK == PQresultStatus (r)) {
209 db->next_commit = 0;
210 log_debug ("Successfully committed transaction.");
211 status = 0;
212 }
213 else
214 log_warn ("Failed to commit transaction: %s",
215 PQerrorMessage (db->conn));
216 PQclear (r);
217 }
218 return status;
219 } /* c_psql_commit */
221 static c_psql_database_t *c_psql_database_new (const char *name)
222 {
223 c_psql_database_t **tmp;
224 c_psql_database_t *db;
226 db = (c_psql_database_t *)malloc (sizeof(*db));
227 if (NULL == db) {
228 log_err ("Out of memory.");
229 return NULL;
230 }
232 tmp = (c_psql_database_t **)realloc (databases,
233 (databases_num + 1) * sizeof (*databases));
234 if (NULL == tmp) {
235 log_err ("Out of memory.");
236 sfree (db);
237 return NULL;
238 }
240 databases = tmp;
241 databases[databases_num] = db;
242 ++databases_num;
244 db->conn = NULL;
246 C_COMPLAIN_INIT (&db->conn_complaint);
248 db->proto_version = 0;
249 db->server_version = 0;
251 db->max_params_num = 0;
253 db->q_prep_areas = NULL;
254 db->queries = NULL;
255 db->queries_num = 0;
257 db->writers = NULL;
258 db->writers_num = 0;
260 pthread_mutex_init (&db->db_lock, /* attrs = */ NULL);
262 db->interval = 0;
264 db->commit_interval = 0;
265 db->next_commit = 0;
267 db->database = sstrdup (name);
268 db->host = NULL;
269 db->port = NULL;
270 db->user = NULL;
271 db->password = NULL;
273 db->instance = sstrdup (name);
275 db->sslmode = NULL;
277 db->krbsrvname = NULL;
279 db->service = NULL;
281 db->ref_cnt = 0;
282 return db;
283 } /* c_psql_database_new */
285 static void c_psql_database_delete (void *data)
286 {
287 size_t i;
289 c_psql_database_t *db = data;
291 --db->ref_cnt;
292 /* readers and writers may access this database */
293 if (db->ref_cnt > 0)
294 return;
296 /* wait for the lock to be released by the last writer */
297 pthread_mutex_lock (&db->db_lock);
299 if (db->next_commit > 0)
300 c_psql_commit (db);
302 PQfinish (db->conn);
303 db->conn = NULL;
305 if (db->q_prep_areas)
306 for (i = 0; i < db->queries_num; ++i)
307 udb_query_delete_preparation_area (db->q_prep_areas[i]);
308 free (db->q_prep_areas);
310 sfree (db->queries);
311 db->queries_num = 0;
313 sfree (db->writers);
314 db->writers_num = 0;
316 pthread_mutex_unlock (&db->db_lock);
318 pthread_mutex_destroy (&db->db_lock);
320 sfree (db->database);
321 sfree (db->host);
322 sfree (db->port);
323 sfree (db->user);
324 sfree (db->password);
326 sfree (db->instance);
328 sfree (db->sslmode);
330 sfree (db->krbsrvname);
332 sfree (db->service);
334 /* don't care about freeing or reordering the 'databases' array
335 * this is done in 'shutdown'; also, don't free the database instance
336 * object just to make sure that in case anybody accesses it before
337 * shutdown won't segfault */
338 return;
339 } /* c_psql_database_delete */
341 static int c_psql_connect (c_psql_database_t *db)
342 {
343 char conninfo[4096];
344 char *buf = conninfo;
345 int buf_len = sizeof (conninfo);
346 int status;
348 if ((! db) || (! db->database))
349 return -1;
351 status = ssnprintf (buf, buf_len, "dbname = '%s'", db->database);
352 if (0 < status) {
353 buf += status;
354 buf_len -= status;
355 }
357 C_PSQL_PAR_APPEND (buf, buf_len, "host", db->host);
358 C_PSQL_PAR_APPEND (buf, buf_len, "port", db->port);
359 C_PSQL_PAR_APPEND (buf, buf_len, "user", db->user);
360 C_PSQL_PAR_APPEND (buf, buf_len, "password", db->password);
361 C_PSQL_PAR_APPEND (buf, buf_len, "sslmode", db->sslmode);
362 C_PSQL_PAR_APPEND (buf, buf_len, "krbsrvname", db->krbsrvname);
363 C_PSQL_PAR_APPEND (buf, buf_len, "service", db->service);
365 db->conn = PQconnectdb (conninfo);
366 db->proto_version = PQprotocolVersion (db->conn);
367 return 0;
368 } /* c_psql_connect */
370 static int c_psql_check_connection (c_psql_database_t *db)
371 {
372 _Bool init = 0;
374 if (! db->conn) {
375 init = 1;
377 /* trigger c_release() */
378 if (0 == db->conn_complaint.interval)
379 db->conn_complaint.interval = 1;
381 c_psql_connect (db);
382 }
384 /* "ping" */
385 PQclear (PQexec (db->conn, "SELECT 42;"));
387 if (CONNECTION_OK != PQstatus (db->conn)) {
388 PQreset (db->conn);
390 /* trigger c_release() */
391 if (0 == db->conn_complaint.interval)
392 db->conn_complaint.interval = 1;
394 if (CONNECTION_OK != PQstatus (db->conn)) {
395 c_complain (LOG_ERR, &db->conn_complaint,
396 "Failed to connect to database %s (%s): %s",
397 db->database, db->instance,
398 PQerrorMessage (db->conn));
399 return -1;
400 }
402 db->proto_version = PQprotocolVersion (db->conn);
403 }
405 db->server_version = PQserverVersion (db->conn);
407 if (c_would_release (&db->conn_complaint)) {
408 char *server_host;
409 int server_version;
411 server_host = PQhost (db->conn);
412 server_version = PQserverVersion (db->conn);
414 c_do_release (LOG_INFO, &db->conn_complaint,
415 "Successfully %sconnected to database %s (user %s) "
416 "at server %s%s%s (server version: %d.%d.%d, "
417 "protocol version: %d, pid: %d)", init ? "" : "re",
418 PQdb (db->conn), PQuser (db->conn),
419 C_PSQL_SOCKET3 (server_host, PQport (db->conn)),
420 C_PSQL_SERVER_VERSION3 (server_version),
421 db->proto_version, PQbackendPID (db->conn));
423 if (3 > db->proto_version)
424 log_warn ("Protocol version %d does not support parameters.",
425 db->proto_version);
426 }
427 return 0;
428 } /* c_psql_check_connection */
430 static PGresult *c_psql_exec_query_noparams (c_psql_database_t *db,
431 udb_query_t *q)
432 {
433 return PQexec (db->conn, udb_query_get_statement (q));
434 } /* c_psql_exec_query_noparams */
436 static PGresult *c_psql_exec_query_params (c_psql_database_t *db,
437 udb_query_t *q, c_psql_user_data_t *data)
438 {
439 char *params[db->max_params_num];
440 char interval[64];
441 int i;
443 if ((data == NULL) || (data->params_num == 0))
444 return (c_psql_exec_query_noparams (db, q));
446 assert (db->max_params_num >= data->params_num);
448 for (i = 0; i < data->params_num; ++i) {
449 switch (data->params[i]) {
450 case C_PSQL_PARAM_HOST:
451 params[i] = C_PSQL_IS_UNIX_DOMAIN_SOCKET (db->host)
452 ? "localhost" : db->host;
453 break;
454 case C_PSQL_PARAM_DB:
455 params[i] = db->database;
456 break;
457 case C_PSQL_PARAM_USER:
458 params[i] = db->user;
459 break;
460 case C_PSQL_PARAM_INTERVAL:
461 ssnprintf (interval, sizeof (interval), "%.3f",
462 (db->interval > 0)
463 ? CDTIME_T_TO_DOUBLE (db->interval)
464 : plugin_get_interval ());
465 params[i] = interval;
466 break;
467 case C_PSQL_PARAM_INSTANCE:
468 params[i] = db->instance;
469 break;
470 default:
471 assert (0);
472 }
473 }
475 return PQexecParams (db->conn, udb_query_get_statement (q),
476 data->params_num, NULL,
477 (const char *const *) params,
478 NULL, NULL, /* return text data */ 0);
479 } /* c_psql_exec_query_params */
481 /* db->db_lock must be locked when calling this function */
482 static int c_psql_exec_query (c_psql_database_t *db, udb_query_t *q,
483 udb_query_preparation_area_t *prep_area)
484 {
485 PGresult *res;
487 c_psql_user_data_t *data;
489 const char *host;
491 char **column_names;
492 char **column_values;
493 int column_num;
495 int rows_num;
496 int status;
497 int row, col;
499 /* The user data may hold parameter information, but may be NULL. */
500 data = udb_query_get_user_data (q);
502 /* Versions up to `3' don't know how to handle parameters. */
503 if (3 <= db->proto_version)
504 res = c_psql_exec_query_params (db, q, data);
505 else if ((NULL == data) || (0 == data->params_num))
506 res = c_psql_exec_query_noparams (db, q);
507 else {
508 log_err ("Connection to database \"%s\" (%s) does not support "
509 "parameters (protocol version %d) - "
510 "cannot execute query \"%s\".",
511 db->database, db->instance, db->proto_version,
512 udb_query_get_name (q));
513 return -1;
514 }
516 /* give c_psql_write() a chance to acquire the lock if called recursively
517 * through dispatch_values(); this will happen if, both, queries and
518 * writers are configured for a single connection */
519 pthread_mutex_unlock (&db->db_lock);
521 column_names = NULL;
522 column_values = NULL;
524 if (PGRES_TUPLES_OK != PQresultStatus (res)) {
525 pthread_mutex_lock (&db->db_lock);
527 log_err ("Failed to execute SQL query: %s",
528 PQerrorMessage (db->conn));
529 log_info ("SQL query was: %s",
530 udb_query_get_statement (q));
531 PQclear (res);
532 return -1;
533 }
535 #define BAIL_OUT(status) \
536 sfree (column_names); \
537 sfree (column_values); \
538 PQclear (res); \
539 pthread_mutex_lock (&db->db_lock); \
540 return status
542 rows_num = PQntuples (res);
543 if (1 > rows_num) {
544 BAIL_OUT (0);
545 }
547 column_num = PQnfields (res);
548 column_names = (char **) calloc (column_num, sizeof (char *));
549 if (NULL == column_names) {
550 log_err ("calloc failed.");
551 BAIL_OUT (-1);
552 }
554 column_values = (char **) calloc (column_num, sizeof (char *));
555 if (NULL == column_values) {
556 log_err ("calloc failed.");
557 BAIL_OUT (-1);
558 }
560 for (col = 0; col < column_num; ++col) {
561 /* Pointers returned by `PQfname' are freed by `PQclear' via
562 * `BAIL_OUT'. */
563 column_names[col] = PQfname (res, col);
564 if (NULL == column_names[col]) {
565 log_err ("Failed to resolve name of column %i.", col);
566 BAIL_OUT (-1);
567 }
568 }
570 if (C_PSQL_IS_UNIX_DOMAIN_SOCKET (db->host)
571 || (0 == strcmp (db->host, "localhost")))
572 host = hostname_g;
573 else
574 host = db->host;
576 status = udb_query_prepare_result (q, prep_area, host, "postgresql",
577 db->instance, column_names, (size_t) column_num, db->interval);
578 if (0 != status) {
579 log_err ("udb_query_prepare_result failed with status %i.",
580 status);
581 BAIL_OUT (-1);
582 }
584 for (row = 0; row < rows_num; ++row) {
585 for (col = 0; col < column_num; ++col) {
586 /* Pointers returned by `PQgetvalue' are freed by `PQclear' via
587 * `BAIL_OUT'. */
588 column_values[col] = PQgetvalue (res, row, col);
589 if (NULL == column_values[col]) {
590 log_err ("Failed to get value at (row = %i, col = %i).",
591 row, col);
592 break;
593 }
594 }
596 /* check for an error */
597 if (col < column_num)
598 continue;
600 status = udb_query_handle_result (q, prep_area, column_values);
601 if (status != 0) {
602 log_err ("udb_query_handle_result failed with status %i.",
603 status);
604 }
605 } /* for (row = 0; row < rows_num; ++row) */
607 udb_query_finish_result (q, prep_area);
609 BAIL_OUT (0);
610 #undef BAIL_OUT
611 } /* c_psql_exec_query */
613 static int c_psql_read (user_data_t *ud)
614 {
615 c_psql_database_t *db;
617 int success = 0;
618 int i;
620 if ((ud == NULL) || (ud->data == NULL)) {
621 log_err ("c_psql_read: Invalid user data.");
622 return -1;
623 }
625 db = ud->data;
627 assert (NULL != db->database);
628 assert (NULL != db->instance);
629 assert (NULL != db->queries);
631 pthread_mutex_lock (&db->db_lock);
633 if (0 != c_psql_check_connection (db)) {
634 pthread_mutex_unlock (&db->db_lock);
635 return -1;
636 }
638 for (i = 0; i < db->queries_num; ++i)
639 {
640 udb_query_preparation_area_t *prep_area;
641 udb_query_t *q;
643 prep_area = db->q_prep_areas[i];
644 q = db->queries[i];
646 if ((0 != db->server_version)
647 && (udb_query_check_version (q, db->server_version) <= 0))
648 continue;
650 if (0 == c_psql_exec_query (db, q, prep_area))
651 success = 1;
652 }
654 pthread_mutex_unlock (&db->db_lock);
656 if (! success)
657 return -1;
658 return 0;
659 } /* c_psql_read */
661 static char *values_name_to_sqlarray (const data_set_t *ds,
662 char *string, size_t string_len)
663 {
664 char *str_ptr;
665 size_t str_len;
667 int i;
669 str_ptr = string;
670 str_len = string_len;
672 for (i = 0; i < ds->ds_num; ++i) {
673 int status = ssnprintf (str_ptr, str_len, ",'%s'", ds->ds[i].name);
675 if (status < 1)
676 return NULL;
677 else if ((size_t)status >= str_len) {
678 str_len = 0;
679 break;
680 }
681 else {
682 str_ptr += status;
683 str_len -= (size_t)status;
684 }
685 }
687 if (str_len <= 2) {
688 log_err ("c_psql_write: Failed to stringify value names");
689 return NULL;
690 }
692 /* overwrite the first comma */
693 string[0] = '{';
694 str_ptr[0] = '}';
695 str_ptr[1] = '\0';
697 return string;
698 } /* values_name_to_sqlarray */
700 static char *values_type_to_sqlarray (const data_set_t *ds,
701 char *string, size_t string_len, _Bool store_rates)
702 {
703 char *str_ptr;
704 size_t str_len;
706 int i;
708 str_ptr = string;
709 str_len = string_len;
711 for (i = 0; i < ds->ds_num; ++i) {
712 int status;
714 if (store_rates)
715 status = ssnprintf(str_ptr, str_len, ",'gauge'");
716 else
717 status = ssnprintf(str_ptr, str_len, ",'%s'",
718 DS_TYPE_TO_STRING (ds->ds[i].type));
720 if (status < 1) {
721 str_len = 0;
722 break;
723 }
724 else if ((size_t)status >= str_len) {
725 str_len = 0;
726 break;
727 }
728 else {
729 str_ptr += status;
730 str_len -= (size_t)status;
731 }
732 }
734 if (str_len <= 2) {
735 log_err ("c_psql_write: Failed to stringify value types");
736 return NULL;
737 }
739 /* overwrite the first comma */
740 string[0] = '{';
741 str_ptr[0] = '}';
742 str_ptr[1] = '\0';
744 return string;
745 } /* values_type_to_sqlarray */
747 static char *values_to_sqlarray (const data_set_t *ds, const value_list_t *vl,
748 char *string, size_t string_len, _Bool store_rates)
749 {
750 char *str_ptr;
751 size_t str_len;
753 gauge_t *rates = NULL;
755 int i;
757 str_ptr = string;
758 str_len = string_len;
760 for (i = 0; i < vl->values_len; ++i) {
761 int status = 0;
763 if ((ds->ds[i].type != DS_TYPE_GAUGE)
764 && (ds->ds[i].type != DS_TYPE_COUNTER)
765 && (ds->ds[i].type != DS_TYPE_DERIVE)
766 && (ds->ds[i].type != DS_TYPE_ABSOLUTE)) {
767 log_err ("c_psql_write: Unknown data source type: %i",
768 ds->ds[i].type);
769 sfree (rates);
770 return NULL;
771 }
773 if (ds->ds[i].type == DS_TYPE_GAUGE)
774 status = ssnprintf (str_ptr, str_len,
775 ",%f", vl->values[i].gauge);
776 else if (store_rates) {
777 if (rates == NULL)
778 rates = uc_get_rate (ds, vl);
780 if (rates == NULL) {
781 log_err ("c_psql_write: Failed to determine rate");
782 return NULL;
783 }
785 status = ssnprintf (str_ptr, str_len,
786 ",%lf", rates[i]);
787 }
788 else if (ds->ds[i].type == DS_TYPE_COUNTER)
789 status = ssnprintf (str_ptr, str_len,
790 ",%llu", vl->values[i].counter);
791 else if (ds->ds[i].type == DS_TYPE_DERIVE)
792 status = ssnprintf (str_ptr, str_len,
793 ",%"PRIi64, vl->values[i].derive);
794 else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
795 status = ssnprintf (str_ptr, str_len,
796 ",%"PRIu64, vl->values[i].absolute);
798 if (status < 1) {
799 str_len = 0;
800 break;
801 }
802 else if ((size_t)status >= str_len) {
803 str_len = 0;
804 break;
805 }
806 else {
807 str_ptr += status;
808 str_len -= (size_t)status;
809 }
810 }
812 sfree (rates);
814 if (str_len <= 2) {
815 log_err ("c_psql_write: Failed to stringify value list");
816 return NULL;
817 }
819 /* overwrite the first comma */
820 string[0] = '{';
821 str_ptr[0] = '}';
822 str_ptr[1] = '\0';
824 return string;
825 } /* values_to_sqlarray */
827 static int c_psql_write (const data_set_t *ds, const value_list_t *vl,
828 user_data_t *ud)
829 {
830 c_psql_database_t *db;
832 char time_str[32];
833 char values_name_str[1024];
834 char values_type_str[1024];
835 char values_str[1024];
837 const char *params[9];
839 int success = 0;
840 int i;
842 if ((ud == NULL) || (ud->data == NULL)) {
843 log_err ("c_psql_write: Invalid user data.");
844 return -1;
845 }
847 db = ud->data;
848 assert (db->database != NULL);
849 assert (db->writers != NULL);
851 if (cdtime_to_iso8601 (time_str, sizeof (time_str), vl->time) == 0) {
852 log_err ("c_psql_write: Failed to convert time to ISO 8601 format");
853 return -1;
854 }
856 if (values_name_to_sqlarray (ds,
857 values_name_str, sizeof (values_name_str)) == NULL)
858 return -1;
860 #define VALUE_OR_NULL(v) ((((v) == NULL) || (*(v) == '\0')) ? NULL : (v))
862 params[0] = time_str;
863 params[1] = vl->host;
864 params[2] = vl->plugin;
865 params[3] = VALUE_OR_NULL(vl->plugin_instance);
866 params[4] = vl->type;
867 params[5] = VALUE_OR_NULL(vl->type_instance);
868 params[6] = values_name_str;
870 #undef VALUE_OR_NULL
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 = (c_psql_user_data_t *) smalloc (sizeof (*data));
1043 if (NULL == data) {
1044 log_err ("Out of memory.");
1045 return -1;
1046 }
1047 memset (data, 0, sizeof (*data));
1048 data->params = NULL;
1049 }
1051 tmp = (c_psql_param_t *) realloc (data->params,
1052 (data->params_num + 1) * sizeof (c_psql_param_t));
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 udb_query_set_user_data (q, data);
1078 return (0);
1079 } /* config_query_param_add */
1081 static int config_query_callback (udb_query_t *q, oconfig_item_t *ci)
1082 {
1083 if (0 == strcasecmp ("Param", ci->key))
1084 return config_query_param_add (q, ci);
1086 log_err ("Option not allowed within a Query block: `%s'", ci->key);
1088 return (-1);
1089 } /* config_query_callback */
1091 static int config_add_writer (oconfig_item_t *ci,
1092 c_psql_writer_t *src_writers, size_t src_writers_num,
1093 c_psql_writer_t ***dst_writers, size_t *dst_writers_num)
1094 {
1095 char *name;
1097 size_t i;
1099 if ((ci == NULL) || (dst_writers == NULL) || (dst_writers_num == NULL))
1100 return -1;
1102 if ((ci->values_num != 1)
1103 || (ci->values[0].type != OCONFIG_TYPE_STRING)) {
1104 log_err ("`Writer' expects a single string argument.");
1105 return 1;
1106 }
1108 name = ci->values[0].value.string;
1110 for (i = 0; i < src_writers_num; ++i) {
1111 c_psql_writer_t **tmp;
1113 if (strcasecmp (name, src_writers[i].name) != 0)
1114 continue;
1116 tmp = (c_psql_writer_t **)realloc (*dst_writers,
1117 sizeof (**dst_writers) * (*dst_writers_num + 1));
1118 if (tmp == NULL) {
1119 log_err ("Out of memory.");
1120 return -1;
1121 }
1123 tmp[*dst_writers_num] = src_writers + i;
1125 *dst_writers = tmp;
1126 ++(*dst_writers_num);
1127 break;
1128 }
1130 if (i >= src_writers_num) {
1131 log_err ("No such writer: `%s'", name);
1132 return -1;
1133 }
1135 return 0;
1136 } /* config_add_writer */
1138 static int c_psql_config_writer (oconfig_item_t *ci)
1139 {
1140 c_psql_writer_t *writer;
1141 c_psql_writer_t *tmp;
1143 int status = 0;
1144 int i;
1146 if ((ci->values_num != 1)
1147 || (ci->values[0].type != OCONFIG_TYPE_STRING)) {
1148 log_err ("<Writer> expects a single string argument.");
1149 return 1;
1150 }
1152 tmp = (c_psql_writer_t *)realloc (writers,
1153 sizeof (*writers) * (writers_num + 1));
1154 if (tmp == NULL) {
1155 log_err ("Out of memory.");
1156 return -1;
1157 }
1159 writers = tmp;
1160 writer = writers + writers_num;
1161 ++writers_num;
1163 writer->name = sstrdup (ci->values[0].value.string);
1164 writer->statement = NULL;
1165 writer->store_rates = 1;
1167 for (i = 0; i < ci->children_num; ++i) {
1168 oconfig_item_t *c = ci->children + i;
1170 if (strcasecmp ("Statement", c->key) == 0)
1171 status = cf_util_get_string (c, &writer->statement);
1172 else if (strcasecmp ("StoreRates", c->key) == 0)
1173 status = cf_util_get_boolean (c, &writer->store_rates);
1174 else
1175 log_warn ("Ignoring unknown config key \"%s\".", c->key);
1176 }
1178 if (status != 0) {
1179 sfree (writer->statement);
1180 sfree (writer->name);
1181 sfree (writer);
1182 return status;
1183 }
1185 return 0;
1186 } /* c_psql_config_writer */
1188 static int c_psql_config_database (oconfig_item_t *ci)
1189 {
1190 c_psql_database_t *db;
1192 char cb_name[DATA_MAX_NAME_LEN];
1193 struct timespec cb_interval = { 0, 0 };
1194 user_data_t ud;
1196 static _Bool have_flush = 0;
1198 int i;
1200 if ((1 != ci->values_num)
1201 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1202 log_err ("<Database> expects a single string argument.");
1203 return 1;
1204 }
1206 memset (&ud, 0, sizeof (ud));
1208 db = c_psql_database_new (ci->values[0].value.string);
1209 if (db == NULL)
1210 return -1;
1212 for (i = 0; i < ci->children_num; ++i) {
1213 oconfig_item_t *c = ci->children + i;
1215 if (0 == strcasecmp (c->key, "Host"))
1216 cf_util_get_string (c, &db->host);
1217 else if (0 == strcasecmp (c->key, "Port"))
1218 cf_util_get_service (c, &db->port);
1219 else if (0 == strcasecmp (c->key, "User"))
1220 cf_util_get_string (c, &db->user);
1221 else if (0 == strcasecmp (c->key, "Password"))
1222 cf_util_get_string (c, &db->password);
1223 else if (0 == strcasecmp (c->key, "Instance"))
1224 cf_util_get_string (c, &db->instance);
1225 else if (0 == strcasecmp (c->key, "SSLMode"))
1226 cf_util_get_string (c, &db->sslmode);
1227 else if (0 == strcasecmp (c->key, "KRBSrvName"))
1228 cf_util_get_string (c, &db->krbsrvname);
1229 else if (0 == strcasecmp (c->key, "Service"))
1230 cf_util_get_string (c, &db->service);
1231 else if (0 == strcasecmp (c->key, "Query"))
1232 udb_query_pick_from_list (c, queries, queries_num,
1233 &db->queries, &db->queries_num);
1234 else if (0 == strcasecmp (c->key, "Writer"))
1235 config_add_writer (c, writers, writers_num,
1236 &db->writers, &db->writers_num);
1237 else if (0 == strcasecmp (c->key, "Interval"))
1238 cf_util_get_cdtime (c, &db->interval);
1239 else if (strcasecmp ("CommitInterval", c->key) == 0)
1240 cf_util_get_cdtime (c, &db->commit_interval);
1241 else
1242 log_warn ("Ignoring unknown config key \"%s\".", c->key);
1243 }
1245 /* If no `Query' options were given, add the default queries.. */
1246 if ((db->queries_num == 0) && (db->writers_num == 0)){
1247 for (i = 0; i < def_queries_num; i++)
1248 udb_query_pick_from_list_by_name (def_queries[i],
1249 queries, queries_num,
1250 &db->queries, &db->queries_num);
1251 }
1253 if (db->queries_num > 0) {
1254 db->q_prep_areas = (udb_query_preparation_area_t **) calloc (
1255 db->queries_num, sizeof (*db->q_prep_areas));
1257 if (db->q_prep_areas == NULL) {
1258 log_err ("Out of memory.");
1259 c_psql_database_delete (db);
1260 return -1;
1261 }
1262 }
1264 for (i = 0; (size_t)i < db->queries_num; ++i) {
1265 c_psql_user_data_t *data;
1266 data = udb_query_get_user_data (db->queries[i]);
1267 if ((data != NULL) && (data->params_num > db->max_params_num))
1268 db->max_params_num = data->params_num;
1270 db->q_prep_areas[i]
1271 = udb_query_allocate_preparation_area (db->queries[i]);
1273 if (db->q_prep_areas[i] == NULL) {
1274 log_err ("Out of memory.");
1275 c_psql_database_delete (db);
1276 return -1;
1277 }
1278 }
1280 ud.data = db;
1281 ud.free_func = c_psql_database_delete;
1283 ssnprintf (cb_name, sizeof (cb_name), "postgresql-%s", db->instance);
1285 if (db->queries_num > 0) {
1286 CDTIME_T_TO_TIMESPEC (db->interval, &cb_interval);
1288 ++db->ref_cnt;
1289 plugin_register_complex_read ("postgresql", cb_name, c_psql_read,
1290 /* interval = */ (db->interval > 0) ? &cb_interval : NULL,
1291 &ud);
1292 }
1293 if (db->writers_num > 0) {
1294 ++db->ref_cnt;
1295 plugin_register_write (cb_name, c_psql_write, &ud);
1297 if (! have_flush) {
1298 /* flush all */
1299 plugin_register_flush ("postgresql",
1300 c_psql_flush, /* user data = */ NULL);
1301 have_flush = 1;
1302 }
1304 /* flush this connection only */
1305 ++db->ref_cnt;
1306 plugin_register_flush (cb_name, c_psql_flush, &ud);
1307 }
1308 else if (db->commit_interval > 0) {
1309 log_warn ("Database '%s': You do not have any writers assigned to "
1310 "this database connection. Setting 'CommitInterval' does "
1311 "not have any effect.", db->database);
1312 }
1313 return 0;
1314 } /* c_psql_config_database */
1316 static int c_psql_config (oconfig_item_t *ci)
1317 {
1318 static int have_def_config = 0;
1320 int i;
1322 if (0 == have_def_config) {
1323 oconfig_item_t *c;
1325 have_def_config = 1;
1327 c = oconfig_parse_file (C_PSQL_DEFAULT_CONF);
1328 if (NULL == c)
1329 log_err ("Failed to read default config ("C_PSQL_DEFAULT_CONF").");
1330 else
1331 c_psql_config (c);
1333 if (NULL == queries)
1334 log_err ("Default config ("C_PSQL_DEFAULT_CONF") did not define "
1335 "any queries - please check your installation.");
1336 }
1338 for (i = 0; i < ci->children_num; ++i) {
1339 oconfig_item_t *c = ci->children + i;
1341 if (0 == strcasecmp (c->key, "Query"))
1342 udb_query_create (&queries, &queries_num, c,
1343 /* callback = */ config_query_callback);
1344 else if (0 == strcasecmp (c->key, "Writer"))
1345 c_psql_config_writer (c);
1346 else if (0 == strcasecmp (c->key, "Database"))
1347 c_psql_config_database (c);
1348 else
1349 log_warn ("Ignoring unknown config key \"%s\".", c->key);
1350 }
1351 return 0;
1352 } /* c_psql_config */
1354 void module_register (void)
1355 {
1356 plugin_register_complex_config ("postgresql", c_psql_config);
1357 plugin_register_shutdown ("postgresql", c_psql_shutdown);
1358 } /* module_register */
1360 /* vim: set sw=4 ts=4 tw=78 noexpandtab : */