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