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