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