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