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