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