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 PQclear (res);
905 if ((CONNECTION_OK != PQstatus (db->conn))
906 && (0 == c_psql_check_connection (db))) {
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 PQclear (res);
916 success = 1;
917 continue;
918 }
919 }
921 log_err ("Failed to execute SQL query: %s",
922 PQerrorMessage (db->conn));
923 log_info ("SQL query was: '%s', "
924 "params: %s, %s, %s, %s, %s, %s, %s, %s",
925 writer->statement,
926 params[0], params[1], params[2], params[3],
927 params[4], params[5], params[6], params[7]);
929 /* this will abort any current transaction -> restart */
930 if (db->next_commit > 0)
931 c_psql_commit (db);
933 pthread_mutex_unlock (&db->db_lock);
934 return -1;
935 }
937 PQclear (res);
938 success = 1;
939 }
941 if ((db->next_commit > 0)
942 && (cdtime () > db->next_commit))
943 c_psql_commit (db);
945 pthread_mutex_unlock (&db->db_lock);
947 if (! success)
948 return -1;
949 return 0;
950 } /* c_psql_write */
952 /* We cannot flush single identifiers as all we do is to commit the currently
953 * running transaction, thus making sure that all written data is actually
954 * visible to everybody. */
955 static int c_psql_flush (cdtime_t timeout,
956 __attribute__((unused)) const char *ident,
957 user_data_t *ud)
958 {
959 c_psql_database_t *dbs = databases;
960 size_t dbs_num = databases_num;
961 size_t i;
963 if ((ud != NULL) && (ud->data != NULL)) {
964 dbs = ud->data;
965 dbs_num = 1;
966 }
968 for (i = 0; i < dbs_num; ++i) {
969 c_psql_database_t *db = dbs + i;
971 /* don't commit if the timeout is larger than the regular commit
972 * interval as in that case all requested data has already been
973 * committed */
974 if ((db->next_commit > 0) && (db->commit_interval > timeout))
975 c_psql_commit (db);
976 }
977 return 0;
978 } /* c_psql_flush */
980 static int c_psql_shutdown (void)
981 {
982 size_t i = 0;
984 _Bool had_flush = 0;
986 plugin_unregister_read_group ("postgresql");
988 for (i = 0; i < databases_num; ++i) {
989 c_psql_database_t *db = databases + i;
991 if (db->writers_num > 0) {
992 char cb_name[DATA_MAX_NAME_LEN];
993 ssnprintf (cb_name, sizeof (cb_name), "postgresql-%s",
994 db->database);
996 if (! had_flush) {
997 plugin_unregister_flush ("postgresql");
998 had_flush = 1;
999 }
1001 plugin_unregister_flush (cb_name);
1002 plugin_unregister_write (cb_name);
1003 }
1004 }
1006 udb_query_free (queries, queries_num);
1007 queries = NULL;
1008 queries_num = 0;
1010 sfree (writers);
1011 writers = NULL;
1012 writers_num = 0;
1014 sfree (databases);
1015 databases = NULL;
1016 databases_num = 0;
1018 return 0;
1019 } /* c_psql_shutdown */
1021 static int config_query_param_add (udb_query_t *q, oconfig_item_t *ci)
1022 {
1023 c_psql_user_data_t *data;
1024 const char *param_str;
1026 c_psql_param_t *tmp;
1028 data = udb_query_get_user_data (q);
1029 if (NULL == data) {
1030 data = (c_psql_user_data_t *) smalloc (sizeof (*data));
1031 if (NULL == data) {
1032 log_err ("Out of memory.");
1033 return -1;
1034 }
1035 memset (data, 0, sizeof (*data));
1036 data->params = NULL;
1037 }
1039 tmp = (c_psql_param_t *) realloc (data->params,
1040 (data->params_num + 1) * sizeof (c_psql_param_t));
1041 if (NULL == tmp) {
1042 log_err ("Out of memory.");
1043 return -1;
1044 }
1045 data->params = tmp;
1047 param_str = ci->values[0].value.string;
1048 if (0 == strcasecmp (param_str, "hostname"))
1049 data->params[data->params_num] = C_PSQL_PARAM_HOST;
1050 else if (0 == strcasecmp (param_str, "database"))
1051 data->params[data->params_num] = C_PSQL_PARAM_DB;
1052 else if (0 == strcasecmp (param_str, "username"))
1053 data->params[data->params_num] = C_PSQL_PARAM_USER;
1054 else if (0 == strcasecmp (param_str, "interval"))
1055 data->params[data->params_num] = C_PSQL_PARAM_INTERVAL;
1056 else if (0 == strcasecmp (param_str, "instance"))
1057 data->params[data->params_num] = C_PSQL_PARAM_INSTANCE;
1058 else {
1059 log_err ("Invalid parameter \"%s\".", param_str);
1060 return 1;
1061 }
1063 data->params_num++;
1064 udb_query_set_user_data (q, data);
1066 return (0);
1067 } /* config_query_param_add */
1069 static int config_query_callback (udb_query_t *q, oconfig_item_t *ci)
1070 {
1071 if (0 == strcasecmp ("Param", ci->key))
1072 return config_query_param_add (q, ci);
1074 log_err ("Option not allowed within a Query block: `%s'", ci->key);
1076 return (-1);
1077 } /* config_query_callback */
1079 static int config_add_writer (oconfig_item_t *ci,
1080 c_psql_writer_t *src_writers, size_t src_writers_num,
1081 c_psql_writer_t ***dst_writers, size_t *dst_writers_num)
1082 {
1083 char *name;
1085 size_t i;
1087 if ((ci == NULL) || (dst_writers == NULL) || (dst_writers_num == NULL))
1088 return -1;
1090 if ((ci->values_num != 1)
1091 || (ci->values[0].type != OCONFIG_TYPE_STRING)) {
1092 log_err ("`Writer' expects a single string argument.");
1093 return 1;
1094 }
1096 name = ci->values[0].value.string;
1098 for (i = 0; i < src_writers_num; ++i) {
1099 c_psql_writer_t **tmp;
1101 if (strcasecmp (name, src_writers[i].name) != 0)
1102 continue;
1104 tmp = (c_psql_writer_t **)realloc (*dst_writers,
1105 sizeof (**dst_writers) * (*dst_writers_num + 1));
1106 if (tmp == NULL) {
1107 log_err ("Out of memory.");
1108 return -1;
1109 }
1111 tmp[*dst_writers_num] = src_writers + i;
1113 *dst_writers = tmp;
1114 ++(*dst_writers_num);
1115 break;
1116 }
1118 if (i >= src_writers_num) {
1119 log_err ("No such writer: `%s'", name);
1120 return -1;
1121 }
1123 return 0;
1124 } /* config_add_writer */
1126 static int c_psql_config_writer (oconfig_item_t *ci)
1127 {
1128 c_psql_writer_t *writer;
1129 c_psql_writer_t *tmp;
1131 int status = 0;
1132 int i;
1134 if ((ci->values_num != 1)
1135 || (ci->values[0].type != OCONFIG_TYPE_STRING)) {
1136 log_err ("<Writer> expects a single string argument.");
1137 return 1;
1138 }
1140 tmp = (c_psql_writer_t *)realloc (writers,
1141 sizeof (*writers) * (writers_num + 1));
1142 if (tmp == NULL) {
1143 log_err ("Out of memory.");
1144 return -1;
1145 }
1147 writers = tmp;
1148 writer = writers + writers_num;
1149 ++writers_num;
1151 writer->name = sstrdup (ci->values[0].value.string);
1152 writer->statement = NULL;
1153 writer->store_rates = 1;
1155 for (i = 0; i < ci->children_num; ++i) {
1156 oconfig_item_t *c = ci->children + i;
1158 if (strcasecmp ("Statement", c->key) == 0)
1159 status = cf_util_get_string (c, &writer->statement);
1160 else if (strcasecmp ("StoreRates", c->key) == 0)
1161 status = cf_util_get_boolean (c, &writer->store_rates);
1162 else
1163 log_warn ("Ignoring unknown config key \"%s\".", c->key);
1164 }
1166 if (status != 0) {
1167 sfree (writer->statement);
1168 sfree (writer->name);
1169 sfree (writer);
1170 return status;
1171 }
1173 return 0;
1174 } /* c_psql_config_writer */
1176 static int c_psql_config_database (oconfig_item_t *ci)
1177 {
1178 c_psql_database_t *db;
1180 char cb_name[DATA_MAX_NAME_LEN];
1181 struct timespec cb_interval = { 0, 0 };
1182 user_data_t ud;
1184 static _Bool have_flush = 0;
1186 int i;
1188 if ((1 != ci->values_num)
1189 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1190 log_err ("<Database> expects a single string argument.");
1191 return 1;
1192 }
1194 memset (&ud, 0, sizeof (ud));
1196 db = c_psql_database_new (ci->values[0].value.string);
1197 if (db == NULL)
1198 return -1;
1200 for (i = 0; i < ci->children_num; ++i) {
1201 oconfig_item_t *c = ci->children + i;
1203 if (0 == strcasecmp (c->key, "Host"))
1204 cf_util_get_string (c, &db->host);
1205 else if (0 == strcasecmp (c->key, "Port"))
1206 cf_util_get_service (c, &db->port);
1207 else if (0 == strcasecmp (c->key, "User"))
1208 cf_util_get_string (c, &db->user);
1209 else if (0 == strcasecmp (c->key, "Password"))
1210 cf_util_get_string (c, &db->password);
1211 else if (0 == strcasecmp (c->key, "Instance"))
1212 cf_util_get_string (c, &db->instance);
1213 else if (0 == strcasecmp (c->key, "SSLMode"))
1214 cf_util_get_string (c, &db->sslmode);
1215 else if (0 == strcasecmp (c->key, "KRBSrvName"))
1216 cf_util_get_string (c, &db->krbsrvname);
1217 else if (0 == strcasecmp (c->key, "Service"))
1218 cf_util_get_string (c, &db->service);
1219 else if (0 == strcasecmp (c->key, "Query"))
1220 udb_query_pick_from_list (c, queries, queries_num,
1221 &db->queries, &db->queries_num);
1222 else if (0 == strcasecmp (c->key, "Writer"))
1223 config_add_writer (c, writers, writers_num,
1224 &db->writers, &db->writers_num);
1225 else if (0 == strcasecmp (c->key, "Interval"))
1226 cf_util_get_cdtime (c, &db->interval);
1227 else if (strcasecmp ("CommitInterval", c->key) == 0)
1228 cf_util_get_cdtime (c, &db->commit_interval);
1229 else
1230 log_warn ("Ignoring unknown config key \"%s\".", c->key);
1231 }
1233 /* If no `Query' options were given, add the default queries.. */
1234 if ((db->queries_num == 0) && (db->writers_num == 0)){
1235 for (i = 0; i < def_queries_num; i++)
1236 udb_query_pick_from_list_by_name (def_queries[i],
1237 queries, queries_num,
1238 &db->queries, &db->queries_num);
1239 }
1241 if (db->queries_num > 0) {
1242 db->q_prep_areas = (udb_query_preparation_area_t **) calloc (
1243 db->queries_num, sizeof (*db->q_prep_areas));
1245 if (db->q_prep_areas == NULL) {
1246 log_err ("Out of memory.");
1247 c_psql_database_delete (db);
1248 return -1;
1249 }
1250 }
1252 for (i = 0; (size_t)i < db->queries_num; ++i) {
1253 c_psql_user_data_t *data;
1254 data = udb_query_get_user_data (db->queries[i]);
1255 if ((data != NULL) && (data->params_num > db->max_params_num))
1256 db->max_params_num = data->params_num;
1258 db->q_prep_areas[i]
1259 = udb_query_allocate_preparation_area (db->queries[i]);
1261 if (db->q_prep_areas[i] == NULL) {
1262 log_err ("Out of memory.");
1263 c_psql_database_delete (db);
1264 return -1;
1265 }
1266 }
1268 ud.data = db;
1269 ud.free_func = c_psql_database_delete;
1271 ssnprintf (cb_name, sizeof (cb_name), "postgresql-%s", db->instance);
1273 if (db->queries_num > 0) {
1274 CDTIME_T_TO_TIMESPEC (db->interval, &cb_interval);
1276 ++db->ref_cnt;
1277 plugin_register_complex_read ("postgresql", cb_name, c_psql_read,
1278 /* interval = */ (db->interval > 0) ? &cb_interval : NULL,
1279 &ud);
1280 }
1281 if (db->writers_num > 0) {
1282 ++db->ref_cnt;
1283 plugin_register_write (cb_name, c_psql_write, &ud);
1285 if (! have_flush) {
1286 /* flush all */
1287 plugin_register_flush ("postgresql",
1288 c_psql_flush, /* user data = */ NULL);
1289 have_flush = 1;
1290 }
1292 /* flush this connection only */
1293 ++db->ref_cnt;
1294 plugin_register_flush (cb_name, c_psql_flush, &ud);
1295 }
1296 else if (db->commit_interval > 0) {
1297 log_warn ("Database '%s': You do not have any writers assigned to "
1298 "this database connection. Setting 'CommitInterval' does "
1299 "not have any effect.", db->database);
1300 }
1301 return 0;
1302 } /* c_psql_config_database */
1304 static int c_psql_config (oconfig_item_t *ci)
1305 {
1306 static int have_def_config = 0;
1308 int i;
1310 if (0 == have_def_config) {
1311 oconfig_item_t *c;
1313 have_def_config = 1;
1315 c = oconfig_parse_file (C_PSQL_DEFAULT_CONF);
1316 if (NULL == c)
1317 log_err ("Failed to read default config ("C_PSQL_DEFAULT_CONF").");
1318 else
1319 c_psql_config (c);
1321 if (NULL == queries)
1322 log_err ("Default config ("C_PSQL_DEFAULT_CONF") did not define "
1323 "any queries - please check your installation.");
1324 }
1326 for (i = 0; i < ci->children_num; ++i) {
1327 oconfig_item_t *c = ci->children + i;
1329 if (0 == strcasecmp (c->key, "Query"))
1330 udb_query_create (&queries, &queries_num, c,
1331 /* callback = */ config_query_callback);
1332 else if (0 == strcasecmp (c->key, "Writer"))
1333 c_psql_config_writer (c);
1334 else if (0 == strcasecmp (c->key, "Database"))
1335 c_psql_config_database (c);
1336 else
1337 log_warn ("Ignoring unknown config key \"%s\".", c->key);
1338 }
1339 return 0;
1340 } /* c_psql_config */
1342 void module_register (void)
1343 {
1344 plugin_register_complex_config ("postgresql", c_psql_config);
1345 plugin_register_shutdown ("postgresql", c_psql_shutdown);
1346 } /* module_register */
1348 /* vim: set sw=4 ts=4 tw=78 noexpandtab : */