src/write_tsdb.c

   1 /**
   2  * collectd - src/write_tsdb.c
   3  * Copyright (C) 2012       Pierre-Yves Ritschard
   4  * Copyright (C) 2011       Scott Sanders
   5  * Copyright (C) 2009       Paul Sadauskas
   6  * Copyright (C) 2009       Doug MacEachern
   7  * Copyright (C) 2007-2012  Florian octo Forster
   8  * Copyright (C) 2013-2014  Limelight Networks, Inc.
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU General Public License as published by the
  11  * Free Software Foundation; only version 2 of the License is applicable.
  12  *
  13  * This program is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with this program; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  21  *
  22  * Based on the write_graphite plugin. Authors:
  23  *   Florian octo Forster <octo at collectd.org>
  24  *   Doug MacEachern <dougm at hyperic.com>
  25  *   Paul Sadauskas <psadauskas at gmail.com>
  26  *   Scott Sanders <scott at jssjr.com>
  27  *   Pierre-Yves Ritschard <pyr at spootnik.org>
  28  * write_tsdb Authors:
  29  *   Brett Hawn <bhawn at llnw.com>
  30  *   Kevin Bowling <kbowling@llnw.com>
  31  **/
  32
  33 /* write_tsdb plugin configuation example
  34  *
  35  * <Plugin write_tsdb>
  36  *   <Node>
  37  *     Host "localhost"
  38  *     Port "4242"
  39  *     HostTags "status=production deviceclass=www"
  40  *   </Node>
  41  * </Plugin>
  42  */
  43
  44 #include "collectd.h"
  45 #include "common.h"
  46 #include "plugin.h"
  47 #include "configfile.h"
  48
  49 #include "utils_cache.h"
  50
  51 #include <pthread.h>
  52 #include <sys/socket.h>
  53 #include <netdb.h>
  54
  55 #ifndef WT_DEFAULT_NODE
  56 # define WT_DEFAULT_NODE "localhost"
  57 #endif
  58
  59 #ifndef WT_DEFAULT_SERVICE
  60 # define WT_DEFAULT_SERVICE "4242"
  61 #endif
  62
  63 #ifndef WT_DEFAULT_ESCAPE
  64 # define WT_DEFAULT_ESCAPE '.'
  65 #endif
  66
  67 /* Ethernet - (IPv6 + TCP) = 1500 - (40 + 32) = 1428 */
  68 #ifndef WT_SEND_BUF_SIZE
  69 # define WT_SEND_BUF_SIZE 1428
  70 #endif
  71
  72 /*
  73  * Private variables
  74  */
  75 struct wt_callback
  76 {
  77     int      sock_fd;
  78
  79     char     *node;
  80     char     *service;
  81     char     *host_tags;
  82
  83     _Bool    store_rates;
  84     _Bool    always_append_ds;
  85
  86     char     send_buf[WT_SEND_BUF_SIZE];
  87     size_t   send_buf_free;
  88     size_t   send_buf_fill;
  89     cdtime_t send_buf_init_time;
  90
  91     pthread_mutex_t send_lock;
  92 };
  93
  94
  95 /*
  96  * Functions
  97  */
  98 static void wt_reset_buffer(struct wt_callback *cb)
  99 {
 100     memset(cb->send_buf, 0, sizeof(cb->send_buf));
 101     cb->send_buf_free = sizeof(cb->send_buf);
 102     cb->send_buf_fill = 0;
 103     cb->send_buf_init_time = cdtime();
 104 }
 105
 106 static int wt_send_buffer(struct wt_callback *cb)
 107 {
 108     ssize_t status = 0;
 109
 110     status = swrite(cb->sock_fd, cb->send_buf, strlen(cb->send_buf));
 111     if (status < 0)
 112     {
 113         char errbuf[1024];
 114         ERROR("write_tsdb plugin: send failed with status %zi (%s)",
 115               status, sstrerror (errno, errbuf, sizeof (errbuf)));
 116
 117         close (cb->sock_fd);
 118         cb->sock_fd = -1;
 119
 120         return -1;
 121     }
 122
 123     return 0;
 124 }
 125
 126 /* NOTE: You must hold cb->send_lock when calling this function! */
 127 static int wt_flush_nolock(cdtime_t timeout, struct wt_callback *cb)
 128 {
 129     int status;
 130
 131     DEBUG("write_tsdb plugin: wt_flush_nolock: timeout = %.3f; "
 132           "send_buf_fill = %zu;",
 133           (double)timeout,
 134           cb->send_buf_fill);
 135
 136     /* timeout == 0  => flush unconditionally */
 137     if (timeout > 0)
 138     {
 139         cdtime_t now;
 140
 141         now = cdtime();
 142         if ((cb->send_buf_init_time + timeout) > now)
 143             return 0;
 144     }
 145
 146     if (cb->send_buf_fill <= 0)
 147     {
 148         cb->send_buf_init_time = cdtime();
 149         return 0;
 150     }
 151
 152     status = wt_send_buffer(cb);
 153     wt_reset_buffer(cb);
 154
 155     return status;
 156 }
 157
 158 static int wt_callback_init(struct wt_callback *cb)
 159 {
 160     struct addrinfo ai_hints;
 161     struct addrinfo *ai_list;
 162     struct addrinfo *ai_ptr;
 163     int status;
 164
 165     const char *node = cb->node ? cb->node : WT_DEFAULT_NODE;
 166     const char *service = cb->service ? cb->service : WT_DEFAULT_SERVICE;
 167
 168     if (cb->sock_fd > 0)
 169         return 0;
 170
 171     memset(&ai_hints, 0, sizeof(ai_hints));
 172 #ifdef AI_ADDRCONFIG
 173     ai_hints.ai_flags    |= AI_ADDRCONFIG;
 174 #endif
 175     ai_hints.ai_family   = AF_UNSPEC;
 176     ai_hints.ai_socktype = SOCK_STREAM;
 177
 178     ai_list = NULL;
 179
 180     status = getaddrinfo(node, service, &ai_hints, &ai_list);
 181     if (status != 0)
 182     {
 183         ERROR("write_tsdb plugin: getaddrinfo (%s, %s) failed: %s",
 184               node, service, gai_strerror (status));
 185         return -1;
 186     }
 187
 188     assert (ai_list != NULL);
 189     for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
 190     {
 191         cb->sock_fd = socket(ai_ptr->ai_family, ai_ptr->ai_socktype,
 192                              ai_ptr->ai_protocol);
 193         if (cb->sock_fd < 0)
 194             continue;
 195
 196         status = connect(cb->sock_fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
 197         if (status != 0)
 198         {
 199             close(cb->sock_fd);
 200             cb->sock_fd = -1;
 201             continue;
 202         }
 203
 204         break;
 205     }
 206
 207     freeaddrinfo(ai_list);
 208
 209     if (cb->sock_fd < 0)
 210     {
 211         char errbuf[1024];
 212         ERROR("write_tsdb plugin: Connecting to %s:%s failed. "
 213               "The last error was: %s", node, service,
 214               sstrerror (errno, errbuf, sizeof(errbuf)));
 215         close(cb->sock_fd);
 216         return -1;
 217     }
 218
 219     wt_reset_buffer(cb);
 220
 221     return 0;
 222 }
 223
 224 static void wt_callback_free(void *data)
 225 {
 226     struct wt_callback *cb;
 227
 228     if (data == NULL)
 229         return;
 230
 231     cb = data;
 232
 233     pthread_mutex_lock(&cb->send_lock);
 234
 235     wt_flush_nolock(0, cb);
 236
 237     close(cb->sock_fd);
 238     cb->sock_fd = -1;
 239
 240     sfree(cb->node);
 241     sfree(cb->service);
 242     sfree(cb->host_tags);
 243
 244     pthread_mutex_destroy(&cb->send_lock);
 245
 246     sfree(cb);
 247 }
 248
 249 static int wt_flush(cdtime_t timeout,
 250                     const char *identifier __attribute__((unused)),
 251                     user_data_t *user_data)
 252 {
 253     struct wt_callback *cb;
 254     int status;
 255
 256     if (user_data == NULL)
 257         return -EINVAL;
 258
 259     cb = user_data->data;
 260
 261     pthread_mutex_lock(&cb->send_lock);
 262
 263     if (cb->sock_fd < 0)
 264     {
 265         status = wt_callback_init(cb);
 266         if (status != 0)
 267         {
 268             ERROR("write_tsdb plugin: wt_callback_init failed.");
 269             pthread_mutex_unlock(&cb->send_lock);
 270             return -1;
 271         }
 272     }
 273
 274     status = wt_flush_nolock(timeout, cb);
 275     pthread_mutex_unlock(&cb->send_lock);
 276
 277     return status;
 278 }
 279
 280 static int wt_format_values(char *ret, size_t ret_len,
 281                             int ds_num, const data_set_t *ds,
 282                             const value_list_t *vl,
 283                             _Bool store_rates)
 284 {
 285     size_t offset = 0;
 286     int status;
 287     gauge_t *rates = NULL;
 288
 289     assert(0 == strcmp (ds->type, vl->type));
 290
 291     memset(ret, 0, ret_len);
 292
 293 #define BUFFER_ADD(...) do { \
 294         status = ssnprintf (ret + offset, ret_len - offset, \
 295                             __VA_ARGS__); \
 296         if (status < 1) \
 297         { \
 298             sfree(rates); \
 299             return -1; \
 300         } \
 301         else if (((size_t) status) >= (ret_len - offset)) \
 302         { \
 303             sfree(rates); \
 304             return -1; \
 305         } \
 306         else \
 307             offset += ((size_t) status); \
 308 } while (0)
 309
 310     if (ds->ds[ds_num].type == DS_TYPE_GAUGE)
 311         BUFFER_ADD("%f", vl->values[ds_num].gauge);
 312     else if (store_rates)
 313     {
 314         if (rates == NULL)
 315             rates = uc_get_rate (ds, vl);
 316         if (rates == NULL)
 317         {
 318             WARNING("format_values: "
 319                     "uc_get_rate failed.");
 320             return -1;
 321         }
 322         BUFFER_ADD("%f", rates[ds_num]);
 323     }
 324     else if (ds->ds[ds_num].type == DS_TYPE_COUNTER)
 325         BUFFER_ADD("%llu", vl->values[ds_num].counter);
 326     else if (ds->ds[ds_num].type == DS_TYPE_DERIVE)
 327         BUFFER_ADD("%" PRIi64, vl->values[ds_num].derive);
 328     else if (ds->ds[ds_num].type == DS_TYPE_ABSOLUTE)
 329         BUFFER_ADD("%" PRIu64, vl->values[ds_num].absolute);
 330     else
 331     {
 332         ERROR("format_values plugin: Unknown data source type: %i",
 333               ds->ds[ds_num].type);
 334         sfree(rates);
 335         return -1;
 336     }
 337
 338 #undef BUFFER_ADD
 339
 340     sfree(rates);
 341     return 0;
 342 }
 343
 344 static int wt_format_name(char *ret, int ret_len,
 345                           const value_list_t *vl,
 346                           const struct wt_callback *cb,
 347                           const char *ds_name)
 348 {
 349     int status;
 350     char *temp = NULL;
 351     char *prefix = "";
 352     const char *meta_prefix = "tsdb_prefix";
 353
 354     if (vl->meta) {
 355         status = meta_data_get_string(vl->meta, meta_prefix, &temp);
 356         if (status == -ENOENT) {
 357             /* defaults to empty string */
 358         } else if (status < 0) {
 359             sfree(temp);
 360             return status;
 361         } else {
 362             prefix = temp;
 363         }
 364     }
 365
 366     if (ds_name != NULL) {
 367         if (vl->plugin_instance[0] == '\0') {
 368             ssnprintf(ret, ret_len, "%s%s.%s",
 369                       prefix, vl->plugin, ds_name);
 370         } else if (vl->type_instance == '\0') {
 371             ssnprintf(ret, ret_len, "%s%s.%s.%s.%s",
 372                       prefix, vl->plugin, vl->plugin_instance,
 373                       vl->type_instance, ds_name);
 374         } else {
 375             ssnprintf(ret, ret_len, "%s%s.%s.%s.%s",
 376                       prefix, vl->plugin, vl->plugin_instance, vl->type,
 377                       ds_name);
 378         }
 379     } else if (vl->plugin_instance[0] == '\0') {
 380         if (vl->type_instance[0] == '\0')
 381             ssnprintf(ret, ret_len, "%s%s.%s",
 382                       prefix, vl->plugin, vl->type);
 383         else
 384             ssnprintf(ret, ret_len, "%s%s.%s",
 385                       prefix, vl->plugin, vl->type_instance);
 386     } else if (vl->type_instance[0] == '\0') {
 387         ssnprintf(ret, ret_len, "%s%s.%s.%s",
 388                   prefix, vl->plugin, vl->plugin_instance, vl->type);
 389     } else {
 390         ssnprintf(ret, ret_len, "%s%s.%s.%s",
 391                   prefix, vl->plugin, vl->plugin_instance, vl->type_instance);
 392     }
 393
 394     sfree(temp);
 395     return 0;
 396 }
 397
 398 static int wt_send_message (const char* key, const char* value,
 399                             cdtime_t time, struct wt_callback *cb,
 400                             const char* host, meta_data_t *md)
 401 {
 402     int status;
 403     int message_len;
 404     char *temp = NULL;
 405     char *tags = "";
 406     char message[1024];
 407     char *host_tags = cb->host_tags ? cb->host_tags : "";
 408     const char *meta_tsdb = "tsdb_tags";
 409
 410     /* skip if value is NaN */
 411     if (value[0] == 'n')
 412         return 0;
 413
 414     if (md) {
 415         status = meta_data_get_string(md, meta_tsdb, &temp);
 416         if (status == -ENOENT) {
 417             /* defaults to empty string */
 418         } else if (status < 0) {
 419             ERROR("write_tsdb plugin: tags metadata get failure");
 420             sfree(temp);
 421             pthread_mutex_unlock(&cb->send_lock);
 422             return status;
 423         } else {
 424             tags = temp;
 425         }
 426     }
 427
 428     message_len = ssnprintf (message,
 429                              sizeof(message),
 430                              "put %s %.0f %s fqdn=%s %s %s\r\n",
 431                              key,
 432                              CDTIME_T_TO_DOUBLE(time),
 433                              value,
 434                              host,
 435                              tags,
 436                              host_tags);
 437
 438     sfree(temp);
 439
 440     if (message_len >= sizeof(message)) {
 441         ERROR("write_tsdb plugin: message buffer too small: "
 442               "Need %d bytes.", message_len + 1);
 443         return -1;
 444     }
 445
 446     pthread_mutex_lock(&cb->send_lock);
 447
 448     if (cb->sock_fd < 0)
 449     {
 450         status = wt_callback_init(cb);
 451         if (status != 0)
 452         {
 453             ERROR("write_tsdb plugin: wt_callback_init failed.");
 454             pthread_mutex_unlock(&cb->send_lock);
 455             return -1;
 456         }
 457     }
 458
 459     if (message_len >= cb->send_buf_free)
 460     {
 461         status = wt_flush_nolock(0, cb);
 462         if (status != 0)
 463         {
 464             pthread_mutex_unlock(&cb->send_lock);
 465             return status;
 466         }
 467     }
 468
 469     /* Assert that we have enough space for this message. */
 470     assert(message_len < cb->send_buf_free);
 471
 472     /* `message_len + 1' because `message_len' does not include the
 473      * trailing null byte. Neither does `send_buffer_fill'. */
 474     memcpy(cb->send_buf + cb->send_buf_fill,
 475             message, message_len + 1);
 476     cb->send_buf_fill += message_len;
 477     cb->send_buf_free -= message_len;
 478
 479     DEBUG("write_tsdb plugin: [%s]:%s buf %zu/%zu (%.1f %%) \"%s\"",
 480           cb->node,
 481           cb->service,
 482           cb->send_buf_fill, sizeof(cb->send_buf),
 483           100.0 * ((double) cb->send_buf_fill) /
 484           ((double) sizeof(cb->send_buf)),
 485           message);
 486
 487     pthread_mutex_unlock(&cb->send_lock);
 488
 489     return 0;
 490 }
 491
 492 static int wt_write_messages(const data_set_t *ds, const value_list_t *vl,
 493                              struct wt_callback *cb)
 494 {
 495     char key[10*DATA_MAX_NAME_LEN];
 496     char values[512];
 497
 498     int status, i;
 499
 500     if (0 != strcmp(ds->type, vl->type))
 501     {
 502         ERROR("write_tsdb plugin: DS type does not match "
 503               "value list type");
 504         return -1;
 505     }
 506
 507     for (i = 0; i < ds->ds_num; i++)
 508     {
 509         const char *ds_name = NULL;
 510
 511         if (cb->always_append_ds || (ds->ds_num > 1))
 512             ds_name = ds->ds[i].name;
 513
 514         /* Copy the identifier to 'key' and escape it. */
 515         status = wt_format_name(key, sizeof(key), vl, cb, ds_name);
 516         if (status != 0)
 517         {
 518             ERROR("write_tsdb plugin: error with format_name");
 519             return status;
 520         }
 521
 522         escape_string(key, sizeof(key));
 523         /* Convert the values to an ASCII representation and put that into
 524          * 'values'. */
 525         status = wt_format_values(values, sizeof(values), i, ds, vl,
 526                                   cb->store_rates);
 527         if (status != 0)
 528         {
 529             ERROR("write_tsdb plugin: error with "
 530                   "wt_format_values");
 531             return status;
 532         }
 533
 534         /* Send the message to tsdb */
 535         status = wt_send_message(key, values, vl->time, cb, vl->host, vl->meta);
 536         if (status != 0)
 537         {
 538             ERROR("write_tsdb plugin: error with "
 539                   "wt_send_message");
 540             return status;
 541         }
 542     }
 543
 544     return 0;
 545 }
 546
 547 static int wt_write(const data_set_t *ds, const value_list_t *vl,
 548                     user_data_t *user_data)
 549 {
 550     struct wt_callback *cb;
 551     int status;
 552
 553     if (user_data == NULL)
 554         return EINVAL;
 555
 556     cb = user_data->data;
 557
 558     status = wt_write_messages(ds, vl, cb);
 559
 560     return status;
 561 }
 562
 563 static int wt_config_tsd(oconfig_item_t *ci)
 564 {
 565     struct wt_callback *cb;
 566     user_data_t user_data;
 567     char callback_name[DATA_MAX_NAME_LEN];
 568     int i;
 569
 570     cb = malloc(sizeof(*cb));
 571     if (cb == NULL)
 572     {
 573         ERROR("write_tsdb plugin: malloc failed.");
 574         return -1;
 575     }
 576     memset(cb, 0, sizeof(*cb));
 577     cb->sock_fd = -1;
 578     cb->node = NULL;
 579     cb->service = NULL;
 580     cb->host_tags = NULL;
 581     cb->store_rates = 0;
 582
 583     pthread_mutex_init (&cb->send_lock, NULL);
 584
 585     for (i = 0; i < ci->children_num; i++)
 586     {
 587         oconfig_item_t *child = ci->children + i;
 588
 589         if (strcasecmp("Host", child->key) == 0)
 590             cf_util_get_string(child, &cb->node);
 591         else if (strcasecmp("Port", child->key) == 0)
 592             cf_util_get_service(child, &cb->service);
 593         else if (strcasecmp("HostTags", child->key) == 0)
 594             cf_util_get_string(child, &cb->host_tags);
 595         else if (strcasecmp("StoreRates", child->key) == 0)
 596             cf_util_get_boolean(child, &cb->store_rates);
 597         else if (strcasecmp("AlwaysAppendDS", child->key) == 0)
 598             cf_util_get_boolean(child, &cb->always_append_ds);
 599         else
 600         {
 601             ERROR("write_tsdb plugin: Invalid configuration "
 602                   "option: %s.", child->key);
 603         }
 604     }
 605
 606     ssnprintf(callback_name, sizeof(callback_name), "write_tsdb/%s/%s",
 607               cb->node != NULL ? cb->node : WT_DEFAULT_NODE,
 608               cb->service != NULL ? cb->service : WT_DEFAULT_SERVICE);
 609
 610     memset(&user_data, 0, sizeof(user_data));
 611     user_data.data = cb;
 612     user_data.free_func = wt_callback_free;
 613     plugin_register_write(callback_name, wt_write, &user_data);
 614
 615     user_data.free_func = NULL;
 616     plugin_register_flush(callback_name, wt_flush, &user_data);
 617
 618     return 0;
 619 }
 620
 621 static int wt_config(oconfig_item_t *ci)
 622 {
 623     int i;
 624
 625     for (i = 0; i < ci->children_num; i++)
 626     {
 627         oconfig_item_t *child = ci->children + i;
 628
 629         if (strcasecmp("Node", child->key) == 0)
 630             wt_config_tsd(child);
 631         else
 632         {
 633             ERROR("write_tsdb plugin: Invalid configuration "
 634                   "option: %s.", child->key);
 635         }
 636     }
 637
 638     return 0;
 639 }
 640
 641 void module_register(void)
 642 {
 643     plugin_register_complex_config("write_tsdb", wt_config);
 644 }
 645
 646 /* vim: set sw=4 ts=4 sts=4 tw=78 et : */