src/postgresql.c

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