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