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_unlock(&cb->send_lock);
 223   pthread_mutex_destroy(&cb->send_lock);
 224
 225   sfree(cb);
 226 }
 227
 228 static int wt_flush(cdtime_t timeout,
 229                     const char *identifier __attribute__((unused)),
 230                     user_data_t *user_data) {
 231   struct wt_callback *cb;
 232   int status;
 233
 234   if (user_data == NULL)
 235     return -EINVAL;
 236
 237   cb = user_data->data;
 238
 239   pthread_mutex_lock(&cb->send_lock);
 240
 241   if (cb->sock_fd < 0) {
 242     status = wt_callback_init(cb);
 243     if (status != 0) {
 244       ERROR("write_tsdb plugin: wt_callback_init failed.");
 245       pthread_mutex_unlock(&cb->send_lock);
 246       return -1;
 247     }
 248   }
 249
 250   status = wt_flush_nolock(timeout, cb);
 251   pthread_mutex_unlock(&cb->send_lock);
 252
 253   return status;
 254 }
 255
 256 static int wt_format_values(char *ret, size_t ret_len, int ds_num,
 257                             const data_set_t *ds, const value_list_t *vl,
 258                             _Bool store_rates) {
 259   size_t offset = 0;
 260   int status;
 261   gauge_t *rates = NULL;
 262
 263   assert(0 == strcmp(ds->type, vl->type));
 264
 265   memset(ret, 0, ret_len);
 266
 267 #define BUFFER_ADD(...)                                                        \
 268   do {                                                                         \
 269     status = ssnprintf(ret + offset, ret_len - offset, __VA_ARGS__);           \
 270     if (status < 1) {                                                          \
 271       sfree(rates);                                                            \
 272       return -1;                                                               \
 273     } else if (((size_t)status) >= (ret_len - offset)) {                       \
 274       sfree(rates);                                                            \
 275       return -1;                                                               \
 276     } else                                                                     \
 277       offset += ((size_t)status);                                              \
 278   } while (0)
 279
 280   if (ds->ds[ds_num].type == DS_TYPE_GAUGE)
 281     BUFFER_ADD(GAUGE_FORMAT, vl->values[ds_num].gauge);
 282   else if (store_rates) {
 283     if (rates == NULL)
 284       rates = uc_get_rate(ds, vl);
 285     if (rates == NULL) {
 286       WARNING("format_values: "
 287               "uc_get_rate failed.");
 288       return -1;
 289     }
 290     BUFFER_ADD(GAUGE_FORMAT, rates[ds_num]);
 291   } else if (ds->ds[ds_num].type == DS_TYPE_COUNTER)
 292     BUFFER_ADD("%llu", vl->values[ds_num].counter);
 293   else if (ds->ds[ds_num].type == DS_TYPE_DERIVE)
 294     BUFFER_ADD("%" PRIi64, vl->values[ds_num].derive);
 295   else if (ds->ds[ds_num].type == DS_TYPE_ABSOLUTE)
 296     BUFFER_ADD("%" PRIu64, vl->values[ds_num].absolute);
 297   else {
 298     ERROR("format_values plugin: Unknown data source type: %i",
 299           ds->ds[ds_num].type);
 300     sfree(rates);
 301     return -1;
 302   }
 303
 304 #undef BUFFER_ADD
 305
 306   sfree(rates);
 307   return 0;
 308 }
 309
 310 static int wt_format_name(char *ret, int ret_len, const value_list_t *vl,
 311                           const struct wt_callback *cb, const char *ds_name) {
 312   int status;
 313   char *temp = NULL;
 314   const char *prefix = "";
 315   const char *meta_prefix = "tsdb_prefix";
 316
 317   if (vl->meta) {
 318     status = meta_data_get_string(vl->meta, meta_prefix, &temp);
 319     if (status == -ENOENT) {
 320       /* defaults to empty string */
 321     } else if (status < 0) {
 322       sfree(temp);
 323       return status;
 324     } else {
 325       prefix = temp;
 326     }
 327   }
 328
 329   if (ds_name != NULL) {
 330     if (vl->plugin_instance[0] == '\0') {
 331       if (vl->type_instance[0] == '\0') {
 332         ssnprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin, vl->type,
 333                   ds_name);
 334       } else {
 335         ssnprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin, vl->type,
 336                   vl->type_instance, ds_name);
 337       }
 338     } else { /* vl->plugin_instance != "" */
 339       if (vl->type_instance[0] == '\0') {
 340         ssnprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin,
 341                   vl->plugin_instance, vl->type, ds_name);
 342       } else {
 343         ssnprintf(ret, ret_len, "%s%s.%s.%s.%s.%s", prefix, vl->plugin,
 344                   vl->plugin_instance, vl->type, vl->type_instance, ds_name);
 345       }
 346     }
 347   } else { /* ds_name == NULL */
 348     if (vl->plugin_instance[0] == '\0') {
 349       if (vl->type_instance[0] == '\0') {
 350         ssnprintf(ret, ret_len, "%s%s.%s", prefix, vl->plugin, vl->type);
 351       } else {
 352         ssnprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin,
 353                   vl->type_instance, vl->type);
 354       }
 355     } else { /* vl->plugin_instance != "" */
 356       if (vl->type_instance[0] == '\0') {
 357         ssnprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin,
 358                   vl->plugin_instance, vl->type);
 359       } else {
 360         ssnprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin,
 361                   vl->plugin_instance, vl->type, vl->type_instance);
 362       }
 363     }
 364   }
 365
 366   sfree(temp);
 367   return 0;
 368 }
 369
 370 static int wt_send_message(const char *key, const char *value, cdtime_t time,
 371                            struct wt_callback *cb, const char *host,
 372                            meta_data_t *md) {
 373   int status;
 374   size_t message_len;
 375   char *temp = NULL;
 376   const char *tags = "";
 377   char message[1024];
 378   const char *host_tags = cb->host_tags ? cb->host_tags : "";
 379   const char *meta_tsdb = "tsdb_tags";
 380
 381   /* skip if value is NaN */
 382   if (value[0] == 'n')
 383     return 0;
 384
 385   if (md) {
 386     status = meta_data_get_string(md, meta_tsdb, &temp);
 387     if (status == -ENOENT) {
 388       /* defaults to empty string */
 389     } else if (status < 0) {
 390       ERROR("write_tsdb plugin: tags metadata get failure");
 391       sfree(temp);
 392       pthread_mutex_unlock(&cb->send_lock);
 393       return status;
 394     } else {
 395       tags = temp;
 396     }
 397   }
 398
 399   status =
 400       ssnprintf(message, sizeof(message), "put %s %.0f %s fqdn=%s %s %s\r\n",
 401                 key, CDTIME_T_TO_DOUBLE(time), value, host, tags, host_tags);
 402   sfree(temp);
 403   if (status < 0)
 404     return -1;
 405   message_len = (size_t)status;
 406
 407   if (message_len >= sizeof(message)) {
 408     ERROR("write_tsdb plugin: message buffer too small: "
 409           "Need %zu bytes.",
 410           message_len + 1);
 411     return -1;
 412   }
 413
 414   pthread_mutex_lock(&cb->send_lock);
 415
 416   if (cb->sock_fd < 0) {
 417     status = wt_callback_init(cb);
 418     if (status != 0) {
 419       ERROR("write_tsdb plugin: wt_callback_init failed.");
 420       pthread_mutex_unlock(&cb->send_lock);
 421       return -1;
 422     }
 423   }
 424
 425   if (message_len >= cb->send_buf_free) {
 426     status = wt_flush_nolock(0, cb);
 427     if (status != 0) {
 428       pthread_mutex_unlock(&cb->send_lock);
 429       return status;
 430     }
 431   }
 432
 433   /* Assert that we have enough space for this message. */
 434   assert(message_len < cb->send_buf_free);
 435
 436   /* `message_len + 1' because `message_len' does not include the
 437    * trailing null byte. Neither does `send_buffer_fill'. */
 438   memcpy(cb->send_buf + cb->send_buf_fill, message, message_len + 1);
 439   cb->send_buf_fill += message_len;
 440   cb->send_buf_free -= message_len;
 441
 442   DEBUG("write_tsdb plugin: [%s]:%s buf %zu/%zu (%.1f %%) \"%s\"", cb->node,
 443         cb->service, cb->send_buf_fill, sizeof(cb->send_buf),
 444         100.0 * ((double)cb->send_buf_fill) / ((double)sizeof(cb->send_buf)),
 445         message);
 446
 447   pthread_mutex_unlock(&cb->send_lock);
 448
 449   return 0;
 450 }
 451
 452 static int wt_write_messages(const data_set_t *ds, const value_list_t *vl,
 453                              struct wt_callback *cb) {
 454   char key[10 * DATA_MAX_NAME_LEN];
 455   char values[512];
 456
 457   int status;
 458
 459   if (0 != strcmp(ds->type, vl->type)) {
 460     ERROR("write_tsdb plugin: DS type does not match "
 461           "value list type");
 462     return -1;
 463   }
 464
 465   for (size_t i = 0; i < ds->ds_num; i++) {
 466     const char *ds_name = NULL;
 467
 468     if (cb->always_append_ds || (ds->ds_num > 1))
 469       ds_name = ds->ds[i].name;
 470
 471     /* Copy the identifier to 'key' and escape it. */
 472     status = wt_format_name(key, sizeof(key), vl, cb, ds_name);
 473     if (status != 0) {
 474       ERROR("write_tsdb plugin: error with format_name");
 475       return status;
 476     }
 477
 478     escape_string(key, sizeof(key));
 479     /* Convert the values to an ASCII representation and put that into
 480      * 'values'. */
 481     status =
 482         wt_format_values(values, sizeof(values), i, ds, vl, cb->store_rates);
 483     if (status != 0) {
 484       ERROR("write_tsdb plugin: error with "
 485             "wt_format_values");
 486       return status;
 487     }
 488
 489     /* Send the message to tsdb */
 490     status = wt_send_message(key, values, vl->time, cb, vl->host, vl->meta);
 491     if (status != 0) {
 492       ERROR("write_tsdb plugin: error with "
 493             "wt_send_message");
 494       return status;
 495     }
 496   }
 497
 498   return 0;
 499 }
 500
 501 static int wt_write(const data_set_t *ds, const value_list_t *vl,
 502                     user_data_t *user_data) {
 503   struct wt_callback *cb;
 504   int status;
 505
 506   if (user_data == NULL)
 507     return EINVAL;
 508
 509   cb = user_data->data;
 510
 511   status = wt_write_messages(ds, vl, cb);
 512
 513   return status;
 514 }
 515
 516 static int wt_config_tsd(oconfig_item_t *ci) {
 517   struct wt_callback *cb;
 518   char callback_name[DATA_MAX_NAME_LEN];
 519
 520   cb = calloc(1, sizeof(*cb));
 521   if (cb == NULL) {
 522     ERROR("write_tsdb plugin: calloc failed.");
 523     return -1;
 524   }
 525   cb->sock_fd = -1;
 526   cb->node = NULL;
 527   cb->service = NULL;
 528   cb->host_tags = NULL;
 529   cb->store_rates = 0;
 530
 531   pthread_mutex_init(&cb->send_lock, NULL);
 532
 533   for (int i = 0; i < ci->children_num; i++) {
 534     oconfig_item_t *child = ci->children + i;
 535
 536     if (strcasecmp("Host", child->key) == 0)
 537       cf_util_get_string(child, &cb->node);
 538     else if (strcasecmp("Port", child->key) == 0)
 539       cf_util_get_service(child, &cb->service);
 540     else if (strcasecmp("HostTags", child->key) == 0)
 541       cf_util_get_string(child, &cb->host_tags);
 542     else if (strcasecmp("StoreRates", child->key) == 0)
 543       cf_util_get_boolean(child, &cb->store_rates);
 544     else if (strcasecmp("AlwaysAppendDS", child->key) == 0)
 545       cf_util_get_boolean(child, &cb->always_append_ds);
 546     else {
 547       ERROR("write_tsdb plugin: Invalid configuration "
 548             "option: %s.",
 549             child->key);
 550     }
 551   }
 552
 553   ssnprintf(callback_name, sizeof(callback_name), "write_tsdb/%s/%s",
 554             cb->node != NULL ? cb->node : WT_DEFAULT_NODE,
 555             cb->service != NULL ? cb->service : WT_DEFAULT_SERVICE);
 556
 557   user_data_t user_data = {.data = cb, .free_func = wt_callback_free};
 558
 559   plugin_register_write(callback_name, wt_write, &user_data);
 560
 561   user_data.free_func = NULL;
 562   plugin_register_flush(callback_name, wt_flush, &user_data);
 563
 564   return 0;
 565 }
 566
 567 static int wt_config(oconfig_item_t *ci) {
 568   for (int i = 0; i < ci->children_num; i++) {
 569     oconfig_item_t *child = ci->children + i;
 570
 571     if (strcasecmp("Node", child->key) == 0)
 572       wt_config_tsd(child);
 573     else {
 574       ERROR("write_tsdb plugin: Invalid configuration "
 575             "option: %s.",
 576             child->key);
 577     }
 578   }
 579
 580   return 0;
 581 }
 582
 583 void module_register(void) {
 584   plugin_register_complex_config("write_tsdb", wt_config);
 585 }
 586
 587 /* vim: set sw=4 ts=4 sts=4 tw=78 et : */