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