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