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