src/postgresql.c

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