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 = %" PRIsz ";",
 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_destroy(&cb->send_lock);
 283
 284   sfree(cb);
 285 }
 286
 287 static int wt_flush(cdtime_t timeout,
 288                     const char *identifier __attribute__((unused)),
 289                     user_data_t *user_data) {
 290   struct wt_callback *cb;
 291   int status;
 292
 293   if (user_data == NULL)
 294     return -EINVAL;
 295
 296   cb = user_data->data;
 297
 298   pthread_mutex_lock(&cb->send_lock);
 299
 300   if (cb->sock_fd < 0) {
 301     status = wt_callback_init(cb);
 302     if (status != 0) {
 303       ERROR("write_tsdb plugin: wt_callback_init failed.");
 304       pthread_mutex_unlock(&cb->send_lock);
 305       return -1;
 306     }
 307   }
 308
 309   status = wt_flush_nolock(timeout, cb);
 310   pthread_mutex_unlock(&cb->send_lock);
 311
 312   return status;
 313 }
 314
 315 static int wt_format_values(char *ret, size_t ret_len, int ds_num,
 316                             const data_set_t *ds, const value_list_t *vl,
 317                             _Bool store_rates) {
 318   size_t offset = 0;
 319   int status;
 320   gauge_t *rates = NULL;
 321
 322   assert(0 == strcmp(ds->type, vl->type));
 323
 324   memset(ret, 0, ret_len);
 325
 326 #define BUFFER_ADD(...)                                                        \
 327   do {                                                                         \
 328     status = snprintf(ret + offset, ret_len - offset, __VA_ARGS__);            \
 329     if (status < 1) {                                                          \
 330       sfree(rates);                                                            \
 331       return -1;                                                               \
 332     } else if (((size_t)status) >= (ret_len - offset)) {                       \
 333       sfree(rates);                                                            \
 334       return -1;                                                               \
 335     } else                                                                     \
 336       offset += ((size_t)status);                                              \
 337   } while (0)
 338
 339   if (ds->ds[ds_num].type == DS_TYPE_GAUGE)
 340     BUFFER_ADD(GAUGE_FORMAT, vl->values[ds_num].gauge);
 341   else if (store_rates) {
 342     if (rates == NULL)
 343       rates = uc_get_rate(ds, vl);
 344     if (rates == NULL) {
 345       WARNING("format_values: "
 346               "uc_get_rate failed.");
 347       return -1;
 348     }
 349     BUFFER_ADD(GAUGE_FORMAT, rates[ds_num]);
 350   } else if (ds->ds[ds_num].type == DS_TYPE_COUNTER)
 351     BUFFER_ADD("%" PRIu64, (uint64_t)vl->values[ds_num].counter);
 352   else if (ds->ds[ds_num].type == DS_TYPE_DERIVE)
 353     BUFFER_ADD("%" PRIi64, vl->values[ds_num].derive);
 354   else if (ds->ds[ds_num].type == DS_TYPE_ABSOLUTE)
 355     BUFFER_ADD("%" PRIu64, vl->values[ds_num].absolute);
 356   else {
 357     ERROR("format_values plugin: Unknown data source type: %i",
 358           ds->ds[ds_num].type);
 359     sfree(rates);
 360     return -1;
 361   }
 362
 363 #undef BUFFER_ADD
 364
 365   sfree(rates);
 366   return 0;
 367 }
 368
 369 static int wt_format_name(char *ret, int ret_len, const value_list_t *vl,
 370                           const struct wt_callback *cb, const char *ds_name) {
 371   int status;
 372   char *temp = NULL;
 373   const char *prefix = "";
 374   const char *meta_prefix = "tsdb_prefix";
 375
 376   if (vl->meta) {
 377     status = meta_data_get_string(vl->meta, meta_prefix, &temp);
 378     if (status == -ENOENT) {
 379       /* defaults to empty string */
 380     } else if (status < 0) {
 381       sfree(temp);
 382       return status;
 383     } else {
 384       prefix = temp;
 385     }
 386   }
 387
 388   if (ds_name != NULL) {
 389     if (vl->plugin_instance[0] == '\0') {
 390       if (vl->type_instance[0] == '\0') {
 391         snprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin, vl->type,
 392                  ds_name);
 393       } else {
 394         snprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin, vl->type,
 395                  vl->type_instance, ds_name);
 396       }
 397     } else { /* vl->plugin_instance != "" */
 398       if (vl->type_instance[0] == '\0') {
 399         snprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin,
 400                  vl->plugin_instance, vl->type, ds_name);
 401       } else {
 402         snprintf(ret, ret_len, "%s%s.%s.%s.%s.%s", prefix, vl->plugin,
 403                  vl->plugin_instance, vl->type, vl->type_instance, ds_name);
 404       }
 405     }
 406   } else { /* ds_name == NULL */
 407     if (vl->plugin_instance[0] == '\0') {
 408       if (vl->type_instance[0] == '\0') {
 409         snprintf(ret, ret_len, "%s%s.%s", prefix, vl->plugin, vl->type);
 410       } else {
 411         snprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin,
 412                  vl->type_instance, vl->type);
 413       }
 414     } else { /* vl->plugin_instance != "" */
 415       if (vl->type_instance[0] == '\0') {
 416         snprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin,
 417                  vl->plugin_instance, vl->type);
 418       } else {
 419         snprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin,
 420                  vl->plugin_instance, vl->type, vl->type_instance);
 421       }
 422     }
 423   }
 424
 425   sfree(temp);
 426   return 0;
 427 }
 428
 429 static int wt_send_message(const char *key, const char *value, cdtime_t time,
 430                            struct wt_callback *cb, const char *host,
 431                            meta_data_t *md) {
 432   int status;
 433   size_t message_len;
 434   char *temp = NULL;
 435   const char *tags = "";
 436   char message[1024];
 437   const char *host_tags = cb->host_tags ? cb->host_tags : "";
 438   const char *meta_tsdb = "tsdb_tags";
 439
 440   /* skip if value is NaN */
 441   if (value[0] == 'n')
 442     return 0;
 443
 444   if (md) {
 445     status = meta_data_get_string(md, meta_tsdb, &temp);
 446     if (status == -ENOENT) {
 447       /* defaults to empty string */
 448     } else if (status < 0) {
 449       ERROR("write_tsdb plugin: tags metadata get failure");
 450       sfree(temp);
 451       pthread_mutex_unlock(&cb->send_lock);
 452       return status;
 453     } else {
 454       tags = temp;
 455     }
 456   }
 457
 458   status =
 459       snprintf(message, sizeof(message), "put %s %.0f %s fqdn=%s %s %s\r\n",
 460                key, CDTIME_T_TO_DOUBLE(time), value, host, tags, host_tags);
 461   sfree(temp);
 462   if (status < 0)
 463     return -1;
 464   message_len = (size_t)status;
 465
 466   if (message_len >= sizeof(message)) {
 467     ERROR("write_tsdb plugin: message buffer too small: "
 468           "Need %" PRIsz " bytes.",
 469           message_len + 1);
 470     return -1;
 471   }
 472
 473   pthread_mutex_lock(&cb->send_lock);
 474
 475   if (cb->sock_fd < 0) {
 476     status = wt_callback_init(cb);
 477     if (status != 0) {
 478       ERROR("write_tsdb plugin: wt_callback_init failed.");
 479       pthread_mutex_unlock(&cb->send_lock);
 480       return -1;
 481     }
 482   }
 483
 484   if (message_len >= cb->send_buf_free) {
 485     status = wt_flush_nolock(0, cb);
 486     if (status != 0) {
 487       pthread_mutex_unlock(&cb->send_lock);
 488       return status;
 489     }
 490   }
 491
 492   /* Assert that we have enough space for this message. */
 493   assert(message_len < cb->send_buf_free);
 494
 495   /* `message_len + 1' because `message_len' does not include the
 496    * trailing null byte. Neither does `send_buffer_fill'. */
 497   memcpy(cb->send_buf + cb->send_buf_fill, message, message_len + 1);
 498   cb->send_buf_fill += message_len;
 499   cb->send_buf_free -= message_len;
 500
 501   DEBUG("write_tsdb plugin: [%s]:%s buf %" PRIsz "/%" PRIsz " (%.1f %%) \"%s\"",
 502         cb->node, cb->service, cb->send_buf_fill, sizeof(cb->send_buf),
 503         100.0 * ((double)cb->send_buf_fill) / ((double)sizeof(cb->send_buf)),
 504         message);
 505
 506   pthread_mutex_unlock(&cb->send_lock);
 507
 508   return 0;
 509 }
 510
 511 static int wt_write_messages(const data_set_t *ds, const value_list_t *vl,
 512                              struct wt_callback *cb) {
 513   char key[10 * DATA_MAX_NAME_LEN];
 514   char values[512];
 515
 516   int status;
 517
 518   if (0 != strcmp(ds->type, vl->type)) {
 519     ERROR("write_tsdb plugin: DS type does not match "
 520           "value list type");
 521     return -1;
 522   }
 523
 524   for (size_t i = 0; i < ds->ds_num; i++) {
 525     const char *ds_name = NULL;
 526
 527     if (cb->always_append_ds || (ds->ds_num > 1))
 528       ds_name = ds->ds[i].name;
 529
 530     /* Copy the identifier to 'key' and escape it. */
 531     status = wt_format_name(key, sizeof(key), vl, cb, ds_name);
 532     if (status != 0) {
 533       ERROR("write_tsdb plugin: error with format_name");
 534       return status;
 535     }
 536
 537     escape_string(key, sizeof(key));
 538     /* Convert the values to an ASCII representation and put that into
 539      * 'values'. */
 540     status =
 541         wt_format_values(values, sizeof(values), i, ds, vl, cb->store_rates);
 542     if (status != 0) {
 543       ERROR("write_tsdb plugin: error with "
 544             "wt_format_values");
 545       return status;
 546     }
 547
 548     /* Send the message to tsdb */
 549     status = wt_send_message(key, values, vl->time, cb, vl->host, vl->meta);
 550     if (status != 0) {
 551       ERROR("write_tsdb plugin: error with "
 552             "wt_send_message");
 553       return status;
 554     }
 555   }
 556
 557   return 0;
 558 }
 559
 560 static int wt_write(const data_set_t *ds, const value_list_t *vl,
 561                     user_data_t *user_data) {
 562   struct wt_callback *cb;
 563   int status;
 564
 565   if (user_data == NULL)
 566     return EINVAL;
 567
 568   cb = user_data->data;
 569
 570   status = wt_write_messages(ds, vl, cb);
 571
 572   return status;
 573 }
 574
 575 static int wt_config_tsd(oconfig_item_t *ci) {
 576   struct wt_callback *cb;
 577   char callback_name[DATA_MAX_NAME_LEN];
 578
 579   cb = calloc(1, sizeof(*cb));
 580   if (cb == NULL) {
 581     ERROR("write_tsdb plugin: calloc failed.");
 582     return -1;
 583   }
 584   cb->sock_fd = -1;
 585   cb->connect_failed_log_enabled = 1;
 586   cb->next_random_ttl = new_random_ttl();
 587
 588   pthread_mutex_init(&cb->send_lock, NULL);
 589
 590   for (int i = 0; i < ci->children_num; i++) {
 591     oconfig_item_t *child = ci->children + i;
 592
 593     if (strcasecmp("Host", child->key) == 0)
 594       cf_util_get_string(child, &cb->node);
 595     else if (strcasecmp("Port", child->key) == 0)
 596       cf_util_get_service(child, &cb->service);
 597     else if (strcasecmp("HostTags", child->key) == 0)
 598       cf_util_get_string(child, &cb->host_tags);
 599     else if (strcasecmp("StoreRates", child->key) == 0)
 600       cf_util_get_boolean(child, &cb->store_rates);
 601     else if (strcasecmp("AlwaysAppendDS", child->key) == 0)
 602       cf_util_get_boolean(child, &cb->always_append_ds);
 603     else {
 604       ERROR("write_tsdb plugin: Invalid configuration "
 605             "option: %s.",
 606             child->key);
 607     }
 608   }
 609
 610   snprintf(callback_name, sizeof(callback_name), "write_tsdb/%s/%s",
 611            cb->node != NULL ? cb->node : WT_DEFAULT_NODE,
 612            cb->service != NULL ? cb->service : WT_DEFAULT_SERVICE);
 613
 614   user_data_t user_data = {.data = cb, .free_func = wt_callback_free};
 615
 616   plugin_register_write(callback_name, wt_write, &user_data);
 617
 618   user_data.free_func = NULL;
 619   plugin_register_flush(callback_name, wt_flush, &user_data);
 620
 621   return 0;
 622 }
 623
 624 static int wt_config(oconfig_item_t *ci) {
 625   if ((resolve_interval == 0) && (resolve_jitter == 0))
 626     resolve_interval = resolve_jitter = plugin_get_interval();
 627
 628   for (int i = 0; i < ci->children_num; i++) {
 629     oconfig_item_t *child = ci->children + i;
 630
 631     if (strcasecmp("Node", child->key) == 0)
 632       wt_config_tsd(child);
 633     else if (strcasecmp("ResolveInterval", child->key) == 0)
 634       cf_util_get_cdtime(child, &resolve_interval);
 635     else if (strcasecmp("ResolveJitter", child->key) == 0)
 636       cf_util_get_cdtime(child, &resolve_jitter);
 637     else {
 638       ERROR("write_tsdb plugin: Invalid configuration "
 639             "option: %s.",
 640             child->key);
 641     }
 642   }
 643
 644   return 0;
 645 }
 646
 647 void module_register(void) {
 648   plugin_register_complex_config("write_tsdb", wt_config);
 649 }