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