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