src/postgresql.c

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