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 *db;
225 db = (c_psql_database_t *)realloc (databases,
226 (databases_num + 1) * sizeof (*db));
227 if (NULL == db) {
228 log_err ("Out of memory.");
229 return NULL;
230 }
232 databases = db;
233 db = databases + databases_num;
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;
259 db->database = sstrdup (name);
260 db->host = NULL;
261 db->port = NULL;
262 db->user = NULL;
263 db->password = NULL;
265 db->instance = sstrdup (name);
267 db->sslmode = NULL;
269 db->krbsrvname = NULL;
271 db->service = NULL;
273 db->ref_cnt = 0;
274 return db;
275 } /* c_psql_database_new */
277 static void c_psql_database_delete (void *data)
278 {
279 size_t i;
281 c_psql_database_t *db = data;
283 --db->ref_cnt;
284 /* readers and writers may access this database */
285 if (db->ref_cnt > 0)
286 return;
288 /* wait for the lock to be released by the last writer */
289 pthread_mutex_lock (&db->db_lock);
291 if (db->next_commit > 0)
292 c_psql_commit (db);
294 PQfinish (db->conn);
295 db->conn = NULL;
297 if (db->q_prep_areas)
298 for (i = 0; i < db->queries_num; ++i)
299 udb_query_delete_preparation_area (db->q_prep_areas[i]);
300 free (db->q_prep_areas);
302 sfree (db->queries);
303 db->queries_num = 0;
305 sfree (db->writers);
306 db->writers_num = 0;
308 pthread_mutex_unlock (&db->db_lock);
310 pthread_mutex_destroy (&db->db_lock);
312 sfree (db->database);
313 sfree (db->host);
314 sfree (db->port);
315 sfree (db->user);
316 sfree (db->password);
318 sfree (db->instance);
320 sfree (db->sslmode);
322 sfree (db->krbsrvname);
324 sfree (db->service);
326 /* don't care about freeing or reordering the 'databases' array
327 * this is done in 'shutdown' */
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 /* "ping" */
375 PQclear (PQexec (db->conn, "SELECT 42;"));
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 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 log_err ("Failed to execute SQL query: %s",
518 PQerrorMessage (db->conn));
519 log_info ("SQL query was: %s",
520 udb_query_get_statement (q));
521 PQclear (res);
522 return -1;
523 }
525 #define BAIL_OUT(status) \
526 sfree (column_names); \
527 sfree (column_values); \
528 PQclear (res); \
529 pthread_mutex_lock (&db->db_lock); \
530 return status
532 rows_num = PQntuples (res);
533 if (1 > rows_num) {
534 BAIL_OUT (0);
535 }
537 column_num = PQnfields (res);
538 column_names = (char **) calloc (column_num, sizeof (char *));
539 if (NULL == column_names) {
540 log_err ("calloc failed.");
541 BAIL_OUT (-1);
542 }
544 column_values = (char **) calloc (column_num, sizeof (char *));
545 if (NULL == column_values) {
546 log_err ("calloc failed.");
547 BAIL_OUT (-1);
548 }
550 for (col = 0; col < column_num; ++col) {
551 /* Pointers returned by `PQfname' are freed by `PQclear' via
552 * `BAIL_OUT'. */
553 column_names[col] = PQfname (res, col);
554 if (NULL == column_names[col]) {
555 log_err ("Failed to resolve name of column %i.", col);
556 BAIL_OUT (-1);
557 }
558 }
560 if (C_PSQL_IS_UNIX_DOMAIN_SOCKET (db->host)
561 || (0 == strcmp (db->host, "localhost")))
562 host = hostname_g;
563 else
564 host = db->host;
566 status = udb_query_prepare_result (q, prep_area, host, "postgresql",
567 db->instance, column_names, (size_t) column_num, db->interval);
568 if (0 != status) {
569 log_err ("udb_query_prepare_result failed with status %i.",
570 status);
571 BAIL_OUT (-1);
572 }
574 for (row = 0; row < rows_num; ++row) {
575 for (col = 0; col < column_num; ++col) {
576 /* Pointers returned by `PQgetvalue' are freed by `PQclear' via
577 * `BAIL_OUT'. */
578 column_values[col] = PQgetvalue (res, row, col);
579 if (NULL == column_values[col]) {
580 log_err ("Failed to get value at (row = %i, col = %i).",
581 row, col);
582 break;
583 }
584 }
586 /* check for an error */
587 if (col < column_num)
588 continue;
590 status = udb_query_handle_result (q, prep_area, column_values);
591 if (status != 0) {
592 log_err ("udb_query_handle_result failed with status %i.",
593 status);
594 }
595 } /* for (row = 0; row < rows_num; ++row) */
597 udb_query_finish_result (q, prep_area);
599 BAIL_OUT (0);
600 #undef BAIL_OUT
601 } /* c_psql_exec_query */
603 static int c_psql_read (user_data_t *ud)
604 {
605 c_psql_database_t *db;
607 int success = 0;
608 int i;
610 if ((ud == NULL) || (ud->data == NULL)) {
611 log_err ("c_psql_read: Invalid user data.");
612 return -1;
613 }
615 db = ud->data;
617 assert (NULL != db->database);
618 assert (NULL != db->instance);
619 assert (NULL != db->queries);
621 pthread_mutex_lock (&db->db_lock);
623 if (0 != c_psql_check_connection (db)) {
624 pthread_mutex_unlock (&db->db_lock);
625 return -1;
626 }
628 for (i = 0; i < db->queries_num; ++i)
629 {
630 udb_query_preparation_area_t *prep_area;
631 udb_query_t *q;
633 prep_area = db->q_prep_areas[i];
634 q = db->queries[i];
636 if ((0 != db->server_version)
637 && (udb_query_check_version (q, db->server_version) <= 0))
638 continue;
640 if (0 == c_psql_exec_query (db, q, prep_area))
641 success = 1;
642 }
644 pthread_mutex_unlock (&db->db_lock);
646 if (! success)
647 return -1;
648 return 0;
649 } /* c_psql_read */
651 static char *values_name_to_sqlarray (const data_set_t *ds,
652 char *string, size_t string_len)
653 {
654 char *str_ptr;
655 size_t str_len;
657 int i;
659 str_ptr = string;
660 str_len = string_len;
662 for (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 int i;
698 str_ptr = string;
699 str_len = string_len;
701 for (i = 0; i < ds->ds_num; ++i) {
702 int status;
704 if (store_rates)
705 status = ssnprintf(str_ptr, str_len, ",'gauge'");
706 else
707 status = ssnprintf(str_ptr, str_len, ",'%s'",
708 DS_TYPE_TO_STRING (ds->ds[i].type));
710 if (status < 1) {
711 str_len = 0;
712 break;
713 }
714 else if ((size_t)status >= str_len) {
715 str_len = 0;
716 break;
717 }
718 else {
719 str_ptr += status;
720 str_len -= (size_t)status;
721 }
722 }
724 if (str_len <= 2) {
725 log_err ("c_psql_write: Failed to stringify value types");
726 return NULL;
727 }
729 /* overwrite the first comma */
730 string[0] = '{';
731 str_ptr[0] = '}';
732 str_ptr[1] = '\0';
734 return string;
735 } /* values_type_to_sqlarray */
737 static char *values_to_sqlarray (const data_set_t *ds, const value_list_t *vl,
738 char *string, size_t string_len, _Bool store_rates)
739 {
740 char *str_ptr;
741 size_t str_len;
743 gauge_t *rates = NULL;
745 int i;
747 str_ptr = string;
748 str_len = string_len;
750 for (i = 0; i < vl->values_len; ++i) {
751 int status = 0;
753 if ((ds->ds[i].type != DS_TYPE_GAUGE)
754 && (ds->ds[i].type != DS_TYPE_COUNTER)
755 && (ds->ds[i].type != DS_TYPE_DERIVE)
756 && (ds->ds[i].type != DS_TYPE_ABSOLUTE)) {
757 log_err ("c_psql_write: Unknown data source type: %i",
758 ds->ds[i].type);
759 sfree (rates);
760 return NULL;
761 }
763 if (ds->ds[i].type == DS_TYPE_GAUGE)
764 status = ssnprintf (str_ptr, str_len,
765 ",%f", vl->values[i].gauge);
766 else if (store_rates) {
767 if (rates == NULL)
768 rates = uc_get_rate (ds, vl);
770 if (rates == NULL) {
771 log_err ("c_psql_write: Failed to determine rate");
772 return NULL;
773 }
775 status = ssnprintf (str_ptr, str_len,
776 ",%lf", rates[i]);
777 }
778 else if (ds->ds[i].type == DS_TYPE_COUNTER)
779 status = ssnprintf (str_ptr, str_len,
780 ",%llu", vl->values[i].counter);
781 else if (ds->ds[i].type == DS_TYPE_DERIVE)
782 status = ssnprintf (str_ptr, str_len,
783 ",%"PRIi64, vl->values[i].derive);
784 else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
785 status = ssnprintf (str_ptr, str_len,
786 ",%"PRIu64, vl->values[i].absolute);
788 if (status < 1) {
789 str_len = 0;
790 break;
791 }
792 else if ((size_t)status >= str_len) {
793 str_len = 0;
794 break;
795 }
796 else {
797 str_ptr += status;
798 str_len -= (size_t)status;
799 }
800 }
802 sfree (rates);
804 if (str_len <= 2) {
805 log_err ("c_psql_write: Failed to stringify value list");
806 return NULL;
807 }
809 /* overwrite the first comma */
810 string[0] = '{';
811 str_ptr[0] = '}';
812 str_ptr[1] = '\0';
814 return string;
815 } /* values_to_sqlarray */
817 static int c_psql_write (const data_set_t *ds, const value_list_t *vl,
818 user_data_t *ud)
819 {
820 c_psql_database_t *db;
822 char time_str[32];
823 char values_name_str[1024];
824 char values_type_str[1024];
825 char values_str[1024];
827 const char *params[9];
829 int success = 0;
830 int i;
832 if ((ud == NULL) || (ud->data == NULL)) {
833 log_err ("c_psql_write: Invalid user data.");
834 return -1;
835 }
837 db = ud->data;
838 assert (db->database != NULL);
839 assert (db->writers != NULL);
841 if (cdtime_to_iso8601 (time_str, sizeof (time_str), vl->time) == 0) {
842 log_err ("c_psql_write: Failed to convert time to ISO 8601 format");
843 return -1;
844 }
846 if (values_name_to_sqlarray (ds,
847 values_name_str, sizeof (values_name_str)) == NULL)
848 return -1;
850 #define VALUE_OR_NULL(v) ((((v) == NULL) || (*(v) == '\0')) ? NULL : (v))
852 params[0] = time_str;
853 params[1] = vl->host;
854 params[2] = vl->plugin;
855 params[3] = VALUE_OR_NULL(vl->plugin_instance);
856 params[4] = vl->type;
857 params[5] = VALUE_OR_NULL(vl->type_instance);
858 params[6] = values_name_str;
860 #undef VALUE_OR_NULL
862 pthread_mutex_lock (&db->db_lock);
864 if (0 != c_psql_check_connection (db)) {
865 pthread_mutex_unlock (&db->db_lock);
866 return -1;
867 }
869 if ((db->commit_interval > 0)
870 && (db->next_commit == 0))
871 c_psql_begin (db);
873 for (i = 0; i < db->writers_num; ++i) {
874 c_psql_writer_t *writer;
875 PGresult *res;
877 writer = db->writers[i];
879 if (values_type_to_sqlarray (ds,
880 values_type_str, sizeof (values_type_str),
881 writer->store_rates) == NULL) {
882 pthread_mutex_unlock (&db->db_lock);
883 return -1;
884 }
886 if (values_to_sqlarray (ds, vl,
887 values_str, sizeof (values_str),
888 writer->store_rates) == NULL) {
889 pthread_mutex_unlock (&db->db_lock);
890 return -1;
891 }
893 params[7] = values_type_str;
894 params[8] = values_str;
896 res = PQexecParams (db->conn, writer->statement,
897 STATIC_ARRAY_SIZE (params), NULL,
898 (const char *const *)params,
899 NULL, NULL, /* return text data */ 0);
901 if ((PGRES_COMMAND_OK != PQresultStatus (res))
902 && (PGRES_TUPLES_OK != PQresultStatus (res))) {
903 if ((CONNECTION_OK != PQstatus (db->conn))
904 && (0 == c_psql_check_connection (db))) {
905 PQclear (res);
907 /* try again */
908 res = PQexecParams (db->conn, writer->statement,
909 STATIC_ARRAY_SIZE (params), NULL,
910 (const char *const *)params,
911 NULL, NULL, /* return text data */ 0);
913 if ((PGRES_COMMAND_OK == PQresultStatus (res))
914 || (PGRES_TUPLES_OK == PQresultStatus (res))) {
915 success = 1;
916 continue;
917 }
918 }
920 log_err ("Failed to execute SQL query: %s",
921 PQerrorMessage (db->conn));
922 log_info ("SQL query was: '%s', "
923 "params: %s, %s, %s, %s, %s, %s, %s, %s",
924 writer->statement,
925 params[0], params[1], params[2], params[3],
926 params[4], params[5], params[6], params[7]);
928 /* this will abort any current transaction -> restart */
929 if (db->next_commit > 0)
930 c_psql_commit (db);
932 pthread_mutex_unlock (&db->db_lock);
933 return -1;
934 }
935 success = 1;
936 }
938 if ((db->next_commit > 0)
939 && (cdtime () > db->next_commit))
940 c_psql_commit (db);
942 pthread_mutex_unlock (&db->db_lock);
944 if (! success)
945 return -1;
946 return 0;
947 } /* c_psql_write */
949 /* We cannot flush single identifiers as all we do is to commit the currently
950 * running transaction, thus making sure that all written data is actually
951 * visible to everybody. */
952 static int c_psql_flush (cdtime_t timeout,
953 __attribute__((unused)) const char *ident,
954 user_data_t *ud)
955 {
956 c_psql_database_t *dbs = databases;
957 size_t dbs_num = databases_num;
958 size_t i;
960 if ((ud != NULL) && (ud->data != NULL)) {
961 dbs = ud->data;
962 dbs_num = 1;
963 }
965 for (i = 0; i < dbs_num; ++i) {
966 c_psql_database_t *db = dbs + i;
968 /* don't commit if the timeout is larger than the regular commit
969 * interval as in that case all requested data has already been
970 * committed */
971 if ((db->next_commit > 0) && (db->commit_interval > timeout))
972 c_psql_commit (db);
973 }
974 return 0;
975 } /* c_psql_flush */
977 static int c_psql_shutdown (void)
978 {
979 size_t i = 0;
981 _Bool had_flush = 0;
983 plugin_unregister_read_group ("postgresql");
985 for (i = 0; i < databases_num; ++i) {
986 c_psql_database_t *db = databases + i;
988 if (db->writers_num > 0) {
989 char cb_name[DATA_MAX_NAME_LEN];
990 ssnprintf (cb_name, sizeof (cb_name), "postgresql-%s",
991 db->database);
993 if (! had_flush) {
994 plugin_unregister_flush ("postgresql");
995 had_flush = 1;
996 }
998 plugin_unregister_flush (cb_name);
999 plugin_unregister_write (cb_name);
1000 }
1001 }
1003 udb_query_free (queries, queries_num);
1004 queries = NULL;
1005 queries_num = 0;
1007 sfree (writers);
1008 writers = NULL;
1009 writers_num = 0;
1011 sfree (databases);
1012 databases = NULL;
1013 databases_num = 0;
1015 return 0;
1016 } /* c_psql_shutdown */
1018 static int config_query_param_add (udb_query_t *q, oconfig_item_t *ci)
1019 {
1020 c_psql_user_data_t *data;
1021 const char *param_str;
1023 c_psql_param_t *tmp;
1025 data = udb_query_get_user_data (q);
1026 if (NULL == data) {
1027 data = (c_psql_user_data_t *) smalloc (sizeof (*data));
1028 if (NULL == data) {
1029 log_err ("Out of memory.");
1030 return -1;
1031 }
1032 memset (data, 0, sizeof (*data));
1033 data->params = NULL;
1034 }
1036 tmp = (c_psql_param_t *) realloc (data->params,
1037 (data->params_num + 1) * sizeof (c_psql_param_t));
1038 if (NULL == tmp) {
1039 log_err ("Out of memory.");
1040 return -1;
1041 }
1042 data->params = tmp;
1044 param_str = ci->values[0].value.string;
1045 if (0 == strcasecmp (param_str, "hostname"))
1046 data->params[data->params_num] = C_PSQL_PARAM_HOST;
1047 else if (0 == strcasecmp (param_str, "database"))
1048 data->params[data->params_num] = C_PSQL_PARAM_DB;
1049 else if (0 == strcasecmp (param_str, "username"))
1050 data->params[data->params_num] = C_PSQL_PARAM_USER;
1051 else if (0 == strcasecmp (param_str, "interval"))
1052 data->params[data->params_num] = C_PSQL_PARAM_INTERVAL;
1053 else if (0 == strcasecmp (param_str, "instance"))
1054 data->params[data->params_num] = C_PSQL_PARAM_INSTANCE;
1055 else {
1056 log_err ("Invalid parameter \"%s\".", param_str);
1057 return 1;
1058 }
1060 data->params_num++;
1061 udb_query_set_user_data (q, data);
1063 return (0);
1064 } /* config_query_param_add */
1066 static int config_query_callback (udb_query_t *q, oconfig_item_t *ci)
1067 {
1068 if (0 == strcasecmp ("Param", ci->key))
1069 return config_query_param_add (q, ci);
1071 log_err ("Option not allowed within a Query block: `%s'", ci->key);
1073 return (-1);
1074 } /* config_query_callback */
1076 static int config_add_writer (oconfig_item_t *ci,
1077 c_psql_writer_t *src_writers, size_t src_writers_num,
1078 c_psql_writer_t ***dst_writers, size_t *dst_writers_num)
1079 {
1080 char *name;
1082 size_t i;
1084 if ((ci == NULL) || (dst_writers == NULL) || (dst_writers_num == NULL))
1085 return -1;
1087 if ((ci->values_num != 1)
1088 || (ci->values[0].type != OCONFIG_TYPE_STRING)) {
1089 log_err ("`Writer' expects a single string argument.");
1090 return 1;
1091 }
1093 name = ci->values[0].value.string;
1095 for (i = 0; i < src_writers_num; ++i) {
1096 c_psql_writer_t **tmp;
1098 if (strcasecmp (name, src_writers[i].name) != 0)
1099 continue;
1101 tmp = (c_psql_writer_t **)realloc (*dst_writers,
1102 sizeof (**dst_writers) * (*dst_writers_num + 1));
1103 if (tmp == NULL) {
1104 log_err ("Out of memory.");
1105 return -1;
1106 }
1108 tmp[*dst_writers_num] = src_writers + i;
1110 *dst_writers = tmp;
1111 ++(*dst_writers_num);
1112 break;
1113 }
1115 if (i >= src_writers_num) {
1116 log_err ("No such writer: `%s'", name);
1117 return -1;
1118 }
1120 return 0;
1121 } /* config_add_writer */
1123 static int c_psql_config_writer (oconfig_item_t *ci)
1124 {
1125 c_psql_writer_t *writer;
1126 c_psql_writer_t *tmp;
1128 int status = 0;
1129 int i;
1131 if ((ci->values_num != 1)
1132 || (ci->values[0].type != OCONFIG_TYPE_STRING)) {
1133 log_err ("<Writer> expects a single string argument.");
1134 return 1;
1135 }
1137 tmp = (c_psql_writer_t *)realloc (writers,
1138 sizeof (*writers) * (writers_num + 1));
1139 if (tmp == NULL) {
1140 log_err ("Out of memory.");
1141 return -1;
1142 }
1144 writers = tmp;
1145 writer = writers + writers_num;
1146 ++writers_num;
1148 writer->name = sstrdup (ci->values[0].value.string);
1149 writer->statement = NULL;
1150 writer->store_rates = 1;
1152 for (i = 0; i < ci->children_num; ++i) {
1153 oconfig_item_t *c = ci->children + i;
1155 if (strcasecmp ("Statement", c->key) == 0)
1156 status = cf_util_get_string (c, &writer->statement);
1157 else if (strcasecmp ("StoreRates", c->key) == 0)
1158 status = cf_util_get_boolean (c, &writer->store_rates);
1159 else
1160 log_warn ("Ignoring unknown config key \"%s\".", c->key);
1161 }
1163 if (status != 0) {
1164 sfree (writer->statement);
1165 sfree (writer->name);
1166 sfree (writer);
1167 return status;
1168 }
1170 return 0;
1171 } /* c_psql_config_writer */
1173 static int c_psql_config_database (oconfig_item_t *ci)
1174 {
1175 c_psql_database_t *db;
1177 char cb_name[DATA_MAX_NAME_LEN];
1178 struct timespec cb_interval = { 0, 0 };
1179 user_data_t ud;
1181 static _Bool have_flush = 0;
1183 int i;
1185 if ((1 != ci->values_num)
1186 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1187 log_err ("<Database> expects a single string argument.");
1188 return 1;
1189 }
1191 memset (&ud, 0, sizeof (ud));
1193 db = c_psql_database_new (ci->values[0].value.string);
1194 if (db == NULL)
1195 return -1;
1197 for (i = 0; i < ci->children_num; ++i) {
1198 oconfig_item_t *c = ci->children + i;
1200 if (0 == strcasecmp (c->key, "Host"))
1201 cf_util_get_string (c, &db->host);
1202 else if (0 == strcasecmp (c->key, "Port"))
1203 cf_util_get_service (c, &db->port);
1204 else if (0 == strcasecmp (c->key, "User"))
1205 cf_util_get_string (c, &db->user);
1206 else if (0 == strcasecmp (c->key, "Password"))
1207 cf_util_get_string (c, &db->password);
1208 else if (0 == strcasecmp (c->key, "Instance"))
1209 cf_util_get_string (c, &db->instance);
1210 else if (0 == strcasecmp (c->key, "SSLMode"))
1211 cf_util_get_string (c, &db->sslmode);
1212 else if (0 == strcasecmp (c->key, "KRBSrvName"))
1213 cf_util_get_string (c, &db->krbsrvname);
1214 else if (0 == strcasecmp (c->key, "Service"))
1215 cf_util_get_string (c, &db->service);
1216 else if (0 == strcasecmp (c->key, "Query"))
1217 udb_query_pick_from_list (c, queries, queries_num,
1218 &db->queries, &db->queries_num);
1219 else if (0 == strcasecmp (c->key, "Writer"))
1220 config_add_writer (c, writers, writers_num,
1221 &db->writers, &db->writers_num);
1222 else if (0 == strcasecmp (c->key, "Interval"))
1223 cf_util_get_cdtime (c, &db->interval);
1224 else if (strcasecmp ("CommitInterval", c->key) == 0)
1225 cf_util_get_cdtime (c, &db->commit_interval);
1226 else
1227 log_warn ("Ignoring unknown config key \"%s\".", c->key);
1228 }
1230 /* If no `Query' options were given, add the default queries.. */
1231 if ((db->queries_num == 0) && (db->writers_num == 0)){
1232 for (i = 0; i < def_queries_num; i++)
1233 udb_query_pick_from_list_by_name (def_queries[i],
1234 queries, queries_num,
1235 &db->queries, &db->queries_num);
1236 }
1238 if (db->queries_num > 0) {
1239 db->q_prep_areas = (udb_query_preparation_area_t **) calloc (
1240 db->queries_num, sizeof (*db->q_prep_areas));
1242 if (db->q_prep_areas == NULL) {
1243 log_err ("Out of memory.");
1244 c_psql_database_delete (db);
1245 return -1;
1246 }
1247 }
1249 for (i = 0; (size_t)i < db->queries_num; ++i) {
1250 c_psql_user_data_t *data;
1251 data = udb_query_get_user_data (db->queries[i]);
1252 if ((data != NULL) && (data->params_num > db->max_params_num))
1253 db->max_params_num = data->params_num;
1255 db->q_prep_areas[i]
1256 = udb_query_allocate_preparation_area (db->queries[i]);
1258 if (db->q_prep_areas[i] == NULL) {
1259 log_err ("Out of memory.");
1260 c_psql_database_delete (db);
1261 return -1;
1262 }
1263 }
1265 ud.data = db;
1266 ud.free_func = c_psql_database_delete;
1268 ssnprintf (cb_name, sizeof (cb_name), "postgresql-%s", db->instance);
1270 if (db->queries_num > 0) {
1271 CDTIME_T_TO_TIMESPEC (db->interval, &cb_interval);
1273 ++db->ref_cnt;
1274 plugin_register_complex_read ("postgresql", cb_name, c_psql_read,
1275 /* interval = */ (db->interval > 0) ? &cb_interval : NULL,
1276 &ud);
1277 }
1278 if (db->writers_num > 0) {
1279 ++db->ref_cnt;
1280 plugin_register_write (cb_name, c_psql_write, &ud);
1282 if (! have_flush) {
1283 /* flush all */
1284 plugin_register_flush ("postgresql",
1285 c_psql_flush, /* user data = */ NULL);
1286 have_flush = 1;
1287 }
1289 /* flush this connection only */
1290 ++db->ref_cnt;
1291 plugin_register_flush (cb_name, c_psql_flush, &ud);
1292 }
1293 else if (db->commit_interval > 0) {
1294 log_warn ("Database '%s': You do not have any writers assigned to "
1295 "this database connection. Setting 'CommitInterval' does "
1296 "not have any effect.", db->database);
1297 }
1298 return 0;
1299 } /* c_psql_config_database */
1301 static int c_psql_config (oconfig_item_t *ci)
1302 {
1303 static int have_def_config = 0;
1305 int i;
1307 if (0 == have_def_config) {
1308 oconfig_item_t *c;
1310 have_def_config = 1;
1312 c = oconfig_parse_file (C_PSQL_DEFAULT_CONF);
1313 if (NULL == c)
1314 log_err ("Failed to read default config ("C_PSQL_DEFAULT_CONF").");
1315 else
1316 c_psql_config (c);
1318 if (NULL == queries)
1319 log_err ("Default config ("C_PSQL_DEFAULT_CONF") did not define "
1320 "any queries - please check your installation.");
1321 }
1323 for (i = 0; i < ci->children_num; ++i) {
1324 oconfig_item_t *c = ci->children + i;
1326 if (0 == strcasecmp (c->key, "Query"))
1327 udb_query_create (&queries, &queries_num, c,
1328 /* callback = */ config_query_callback);
1329 else if (0 == strcasecmp (c->key, "Writer"))
1330 c_psql_config_writer (c);
1331 else if (0 == strcasecmp (c->key, "Database"))
1332 c_psql_config_database (c);
1333 else
1334 log_warn ("Ignoring unknown config key \"%s\".", c->key);
1335 }
1336 return 0;
1337 } /* c_psql_config */
1339 void module_register (void)
1340 {
1341 plugin_register_complex_config ("postgresql", c_psql_config);
1342 plugin_register_shutdown ("postgresql", c_psql_shutdown);
1343 } /* module_register */
1345 /* vim: set sw=4 ts=4 tw=78 noexpandtab : */