src/write_graphite.c

   1 /**
   2  * collectd - src/write_graphite.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-2013  Florian octo Forster
   8  *
   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  * 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  *
  29  * Based on the write_http plugin.
  30  **/
  31
  32  /* write_graphite plugin configuation example
  33   *
  34   * <Plugin write_graphite>
  35   *   <Carbon>
  36   *     Host "localhost"
  37   *     Port "2003"
  38   *     Protocol "udp"
  39   *     LogSendErrors true
  40   *     Prefix "collectd"
  41   *   </Carbon>
  42   * </Plugin>
  43   */
  44
  45 #include "collectd.h"
  46
  47 #include "common.h"
  48 #include "plugin.h"
  49
  50 #include "utils_complain.h"
  51 #include "utils_format_graphite.h"
  52
  53 #include <netdb.h>
  54
  55 #ifndef WG_DEFAULT_NODE
  56 # define WG_DEFAULT_NODE "localhost"
  57 #endif
  58
  59 #ifndef WG_DEFAULT_SERVICE
  60 # define WG_DEFAULT_SERVICE "2003"
  61 #endif
  62
  63 #ifndef WG_DEFAULT_PROTOCOL
  64 # define WG_DEFAULT_PROTOCOL "tcp"
  65 #endif
  66
  67 #ifndef WG_DEFAULT_LOG_SEND_ERRORS
  68 # define WG_DEFAULT_LOG_SEND_ERRORS 1
  69 #endif
  70
  71 #ifndef WG_DEFAULT_ESCAPE
  72 # define WG_DEFAULT_ESCAPE '_'
  73 #endif
  74
  75 /* Ethernet - (IPv6 + TCP) = 1500 - (40 + 32) = 1428 */
  76 #ifndef WG_SEND_BUF_SIZE
  77 # define WG_SEND_BUF_SIZE 1428
  78 #endif
  79
  80 #ifndef WG_MIN_RECONNECT_INTERVAL
  81 # define WG_MIN_RECONNECT_INTERVAL TIME_T_TO_CDTIME_T (1)
  82 #endif
  83
  84 /*
  85  * Private variables
  86  */
  87 struct wg_callback
  88 {
  89     int      sock_fd;
  90
  91     char    *name;
  92
  93     char    *node;
  94     char    *service;
  95     char    *protocol;
  96     _Bool   log_send_errors;
  97     char    *prefix;
  98     char    *postfix;
  99     char     escape_char;
 100
 101     unsigned int format_flags;
 102
 103     char     send_buf[WG_SEND_BUF_SIZE];
 104     size_t   send_buf_free;
 105     size_t   send_buf_fill;
 106     cdtime_t send_buf_init_time;
 107
 108     pthread_mutex_t send_lock;
 109     c_complain_t init_complaint;
 110     cdtime_t last_connect_time;
 111
 112     /* Force reconnect useful for load balanced environments */
 113     cdtime_t last_reconnect_time;
 114     cdtime_t reconnect_interval;
 115     _Bool reconnect_interval_reached;
 116 };
 117
 118 /* wg_force_reconnect_check closes cb->sock_fd when it was open for longer
 119  * than cb->reconnect_interval. Must hold cb->send_lock when calling. */
 120 static void wg_force_reconnect_check (struct wg_callback *cb)
 121 {
 122     cdtime_t now;
 123
 124     if (cb->reconnect_interval == 0)
 125         return;
 126
 127     /* check if address changes if addr_timeout */
 128     now = cdtime ();
 129     if ((now - cb->last_reconnect_time) < cb->reconnect_interval)
 130         return;
 131
 132     /* here we should close connection on next */
 133     close (cb->sock_fd);
 134     cb->sock_fd = -1;
 135     cb->last_reconnect_time = now;
 136     cb->reconnect_interval_reached = 1;
 137
 138     INFO ("write_graphite plugin: Connection closed after %.3f seconds.",
 139           CDTIME_T_TO_DOUBLE (now - cb->last_reconnect_time));
 140 }
 141
 142 /*
 143  * Functions
 144  */
 145 static void wg_reset_buffer (struct wg_callback *cb)
 146 {
 147     memset (cb->send_buf, 0, sizeof (cb->send_buf));
 148     cb->send_buf_free = sizeof (cb->send_buf);
 149     cb->send_buf_fill = 0;
 150     cb->send_buf_init_time = cdtime ();
 151 }
 152
 153 static int wg_send_buffer (struct wg_callback *cb)
 154 {
 155     ssize_t status;
 156
 157     if (cb->sock_fd < 0)
 158         return (-1);
 159
 160     status = swrite (cb->sock_fd, cb->send_buf, strlen (cb->send_buf));
 161     if (status != 0)
 162     {
 163         if (cb->log_send_errors)
 164         {
 165             char errbuf[1024];
 166             ERROR ("write_graphite plugin: send to %s:%s (%s) failed with status %zi (%s)",
 167                     cb->node, cb->service, cb->protocol,
 168                     status, sstrerror (errno, errbuf, sizeof (errbuf)));
 169         }
 170
 171         close (cb->sock_fd);
 172         cb->sock_fd = -1;
 173
 174         return (-1);
 175     }
 176
 177     return (0);
 178 }
 179
 180 /* NOTE: You must hold cb->send_lock when calling this function! */
 181 static int wg_flush_nolock (cdtime_t timeout, struct wg_callback *cb)
 182 {
 183     int status;
 184
 185     DEBUG ("write_graphite plugin: wg_flush_nolock: timeout = %.3f; "
 186             "send_buf_fill = %zu;",
 187             (double)timeout,
 188             cb->send_buf_fill);
 189
 190     /* timeout == 0  => flush unconditionally */
 191     if (timeout > 0)
 192     {
 193         cdtime_t now;
 194
 195         now = cdtime ();
 196         if ((cb->send_buf_init_time + timeout) > now)
 197             return (0);
 198     }
 199
 200     if (cb->send_buf_fill == 0)
 201     {
 202         cb->send_buf_init_time = cdtime ();
 203         return (0);
 204     }
 205
 206     status = wg_send_buffer (cb);
 207     wg_reset_buffer (cb);
 208
 209     return (status);
 210 }
 211
 212 static int wg_callback_init (struct wg_callback *cb)
 213 {
 214     struct addrinfo *ai_list;
 215     cdtime_t now;
 216     int status;
 217
 218     char connerr[1024] = "";
 219
 220     if (cb->sock_fd > 0)
 221         return (0);
 222
 223     /* Don't try to reconnect too often. By default, one reconnection attempt
 224      * is made per second. */
 225     now = cdtime ();
 226     if ((now - cb->last_connect_time) < WG_MIN_RECONNECT_INTERVAL)
 227         return (EAGAIN);
 228     cb->last_connect_time = now;
 229
 230     struct addrinfo ai_hints = {
 231         .ai_family = AF_UNSPEC,
 232         .ai_flags  = AI_ADDRCONFIG
 233     };
 234
 235     if (0 == strcasecmp ("tcp", cb->protocol))
 236         ai_hints.ai_socktype = SOCK_STREAM;
 237     else
 238         ai_hints.ai_socktype = SOCK_DGRAM;
 239
 240     status = getaddrinfo (cb->node, cb->service, &ai_hints, &ai_list);
 241     if (status != 0)
 242     {
 243         ERROR ("write_graphite plugin: getaddrinfo (%s, %s, %s) failed: %s",
 244                 cb->node, cb->service, cb->protocol, gai_strerror (status));
 245         return (-1);
 246     }
 247
 248     assert (ai_list != NULL);
 249     for (struct addrinfo *ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
 250     {
 251         cb->sock_fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype,
 252                 ai_ptr->ai_protocol);
 253         if (cb->sock_fd < 0) {
 254             char errbuf[1024];
 255             snprintf (connerr, sizeof (connerr), "failed to open socket: %s",
 256                     sstrerror (errno, errbuf, sizeof (errbuf)));
 257             continue;
 258         }
 259
 260         set_sock_opts (cb->sock_fd);
 261
 262         status = connect (cb->sock_fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
 263         if (status != 0)
 264         {
 265             char errbuf[1024];
 266             snprintf (connerr, sizeof (connerr), "failed to connect to remote "
 267                     "host: %s", sstrerror (errno, errbuf, sizeof (errbuf)));
 268             close (cb->sock_fd);
 269             cb->sock_fd = -1;
 270             continue;
 271         }
 272
 273         break;
 274     }
 275
 276     freeaddrinfo (ai_list);
 277
 278     if (cb->sock_fd < 0)
 279     {
 280         if (connerr[0] == '\0')
 281             /* this should not happen but try to get a message anyway */
 282             sstrerror (errno, connerr, sizeof (connerr));
 283         c_complain (LOG_ERR, &cb->init_complaint,
 284                   "write_graphite plugin: Connecting to %s:%s via %s failed. "
 285                   "The last error was: %s", cb->node, cb->service, cb->protocol, connerr);
 286         return (-1);
 287     }
 288     else
 289     {
 290         c_release (LOG_INFO, &cb->init_complaint,
 291                 "write_graphite plugin: Successfully connected to %s:%s via %s.",
 292                 cb->node, cb->service, cb->protocol);
 293     }
 294
 295     /* wg_force_reconnect_check does not flush the buffer before closing a
 296      * sending socket, so only call wg_reset_buffer() if the socket was closed
 297      * for a different reason (tracked in cb->reconnect_interval_reached). */
 298     if (!cb->reconnect_interval_reached || (cb->send_buf_free == 0))
 299         wg_reset_buffer (cb);
 300     else
 301         cb->reconnect_interval_reached = 0;
 302
 303     return (0);
 304 }
 305
 306 static void wg_callback_free (void *data)
 307 {
 308     struct wg_callback *cb;
 309
 310     if (data == NULL)
 311         return;
 312
 313     cb = data;
 314
 315     pthread_mutex_lock (&cb->send_lock);
 316
 317     wg_flush_nolock (/* timeout = */ 0, cb);
 318
 319     if (cb->sock_fd >= 0)
 320     {
 321         close (cb->sock_fd);
 322         cb->sock_fd = -1;
 323     }
 324
 325     sfree(cb->name);
 326     sfree(cb->node);
 327     sfree(cb->protocol);
 328     sfree(cb->service);
 329     sfree(cb->prefix);
 330     sfree(cb->postfix);
 331
 332     pthread_mutex_destroy (&cb->send_lock);
 333
 334     sfree(cb);
 335 }
 336
 337 static int wg_flush (cdtime_t timeout,
 338         const char *identifier __attribute__((unused)),
 339         user_data_t *user_data)
 340 {
 341     struct wg_callback *cb;
 342     int status;
 343
 344     if (user_data == NULL)
 345         return (-EINVAL);
 346
 347     cb = user_data->data;
 348
 349     pthread_mutex_lock (&cb->send_lock);
 350
 351     if (cb->sock_fd < 0)
 352     {
 353         status = wg_callback_init (cb);
 354         if (status != 0)
 355         {
 356             /* An error message has already been printed. */
 357             pthread_mutex_unlock (&cb->send_lock);
 358             return (-1);
 359         }
 360     }
 361
 362     status = wg_flush_nolock (timeout, cb);
 363     pthread_mutex_unlock (&cb->send_lock);
 364
 365     return (status);
 366 }
 367
 368 static int wg_send_message (char const *message, struct wg_callback *cb)
 369 {
 370     int status;
 371     size_t message_len;
 372
 373     message_len = strlen (message);
 374
 375     pthread_mutex_lock (&cb->send_lock);
 376
 377     wg_force_reconnect_check (cb);
 378
 379     if (cb->sock_fd < 0)
 380     {
 381         status = wg_callback_init (cb);
 382         if (status != 0)
 383         {
 384             /* An error message has already been printed. */
 385             pthread_mutex_unlock (&cb->send_lock);
 386             return (-1);
 387         }
 388     }
 389
 390     if (message_len >= cb->send_buf_free)
 391     {
 392         status = wg_flush_nolock (/* timeout = */ 0, cb);
 393         if (status != 0)
 394         {
 395             pthread_mutex_unlock (&cb->send_lock);
 396             return (status);
 397         }
 398     }
 399
 400     /* Assert that we have enough space for this message. */
 401     assert (message_len < cb->send_buf_free);
 402
 403     /* `message_len + 1' because `message_len' does not include the
 404      * trailing null byte. Neither does `send_buffer_fill'. */
 405     memcpy (cb->send_buf + cb->send_buf_fill,
 406             message, message_len + 1);
 407     cb->send_buf_fill += message_len;
 408     cb->send_buf_free -= message_len;
 409
 410     DEBUG ("write_graphite plugin: [%s]:%s (%s) buf %zu/%zu (%.1f %%) \"%s\"",
 411             cb->node, cb->service, cb->protocol,
 412             cb->send_buf_fill, sizeof (cb->send_buf),
 413             100.0 * ((double) cb->send_buf_fill) / ((double) sizeof (cb->send_buf)),
 414             message);
 415
 416     pthread_mutex_unlock (&cb->send_lock);
 417
 418     return (0);
 419 }
 420
 421 static int wg_write_messages (const data_set_t *ds, const value_list_t *vl,
 422         struct wg_callback *cb)
 423 {
 424     char buffer[WG_SEND_BUF_SIZE] = { 0 };
 425     int status;
 426
 427     if (0 != strcmp (ds->type, vl->type))
 428     {
 429         ERROR ("write_graphite plugin: DS type does not match "
 430                 "value list type");
 431         return -1;
 432     }
 433
 434     status = format_graphite (buffer, sizeof (buffer), ds, vl,
 435             cb->prefix, cb->postfix, cb->escape_char, cb->format_flags);
 436     if (status != 0) /* error message has been printed already. */
 437         return (status);
 438
 439     /* Send the message to graphite */
 440     status = wg_send_message (buffer, cb);
 441     if (status != 0) /* error message has been printed already. */
 442         return (status);
 443
 444     return (0);
 445 } /* int wg_write_messages */
 446
 447 static int wg_write (const data_set_t *ds, const value_list_t *vl,
 448         user_data_t *user_data)
 449 {
 450     struct wg_callback *cb;
 451     int status;
 452
 453     if (user_data == NULL)
 454         return (EINVAL);
 455
 456     cb = user_data->data;
 457
 458     status = wg_write_messages (ds, vl, cb);
 459
 460     return (status);
 461 }
 462
 463 static int config_set_char (char *dest,
 464         oconfig_item_t *ci)
 465 {
 466     char buffer[4] = { 0 };
 467     int status;
 468
 469     status = cf_util_get_string_buffer (ci, buffer, sizeof (buffer));
 470     if (status != 0)
 471         return (status);
 472
 473     if (buffer[0] == 0)
 474     {
 475         ERROR ("write_graphite plugin: Cannot use an empty string for the "
 476                 "\"EscapeCharacter\" option.");
 477         return (-1);
 478     }
 479
 480     if (buffer[1] != 0)
 481     {
 482         WARNING ("write_graphite plugin: Only the first character of the "
 483                 "\"EscapeCharacter\" option ('%c') will be used.",
 484                 (int) buffer[0]);
 485     }
 486
 487     *dest = buffer[0];
 488
 489     return (0);
 490 }
 491
 492 static int wg_config_node (oconfig_item_t *ci)
 493 {
 494     struct wg_callback *cb;
 495     char callback_name[DATA_MAX_NAME_LEN];
 496     int status = 0;
 497
 498     cb = calloc (1, sizeof (*cb));
 499     if (cb == NULL)
 500     {
 501         ERROR ("write_graphite plugin: calloc failed.");
 502         return (-1);
 503     }
 504     cb->sock_fd = -1;
 505     cb->name = NULL;
 506     cb->node = strdup (WG_DEFAULT_NODE);
 507     cb->service = strdup (WG_DEFAULT_SERVICE);
 508     cb->protocol = strdup (WG_DEFAULT_PROTOCOL);
 509     cb->last_reconnect_time = cdtime();
 510     cb->reconnect_interval = 0;
 511     cb->reconnect_interval_reached = 0;
 512     cb->log_send_errors = WG_DEFAULT_LOG_SEND_ERRORS;
 513     cb->prefix = NULL;
 514     cb->postfix = NULL;
 515     cb->escape_char = WG_DEFAULT_ESCAPE;
 516     cb->format_flags = GRAPHITE_STORE_RATES;
 517
 518     /* FIXME: Legacy configuration syntax. */
 519     if (strcasecmp ("Carbon", ci->key) != 0)
 520     {
 521         status = cf_util_get_string (ci, &cb->name);
 522         if (status != 0)
 523         {
 524             wg_callback_free (cb);
 525             return (status);
 526         }
 527     }
 528
 529     pthread_mutex_init (&cb->send_lock, /* attr = */ NULL);
 530     C_COMPLAIN_INIT (&cb->init_complaint);
 531
 532     for (int i = 0; i < ci->children_num; i++)
 533     {
 534         oconfig_item_t *child = ci->children + i;
 535
 536         if (strcasecmp ("Host", child->key) == 0)
 537             cf_util_get_string (child, &cb->node);
 538         else if (strcasecmp ("Port", child->key) == 0)
 539             cf_util_get_service (child, &cb->service);
 540         else if (strcasecmp ("Protocol", child->key) == 0)
 541         {
 542             cf_util_get_string (child, &cb->protocol);
 543
 544             if (strcasecmp ("UDP", cb->protocol) != 0 &&
 545                 strcasecmp ("TCP", cb->protocol) != 0)
 546             {
 547                 ERROR ("write_graphite plugin: Unknown protocol (%s)",
 548                         cb->protocol);
 549                 status = -1;
 550             }
 551         }
 552         else if (strcasecmp ("ReconnectInterval", child->key) == 0)
 553             cf_util_get_cdtime (child, &cb->reconnect_interval);
 554         else if (strcasecmp ("LogSendErrors", child->key) == 0)
 555             cf_util_get_boolean (child, &cb->log_send_errors);
 556         else if (strcasecmp ("Prefix", child->key) == 0)
 557             cf_util_get_string (child, &cb->prefix);
 558         else if (strcasecmp ("Postfix", child->key) == 0)
 559             cf_util_get_string (child, &cb->postfix);
 560         else if (strcasecmp ("StoreRates", child->key) == 0)
 561             cf_util_get_flag (child, &cb->format_flags,
 562                     GRAPHITE_STORE_RATES);
 563         else if (strcasecmp ("SeparateInstances", child->key) == 0)
 564             cf_util_get_flag (child, &cb->format_flags,
 565                     GRAPHITE_SEPARATE_INSTANCES);
 566         else if (strcasecmp ("AlwaysAppendDS", child->key) == 0)
 567             cf_util_get_flag (child, &cb->format_flags,
 568                     GRAPHITE_ALWAYS_APPEND_DS);
 569         else if (strcasecmp ("PreserveSeparator", child->key) == 0)
 570             cf_util_get_flag (child, &cb->format_flags,
 571                     GRAPHITE_PRESERVE_SEPARATOR);
 572         else if (strcasecmp ("DropDuplicateFields", child->key) == 0)
 573             cf_util_get_flag (child, &cb->format_flags,
 574                     GRAPHITE_DROP_DUPE_FIELDS);
 575         else if (strcasecmp ("EscapeCharacter", child->key) == 0)
 576             config_set_char (&cb->escape_char, child);
 577         else
 578         {
 579             ERROR ("write_graphite plugin: Invalid configuration "
 580                         "option: %s.", child->key);
 581             status = -1;
 582         }
 583
 584         if (status != 0)
 585             break;
 586     }
 587
 588     if (status != 0)
 589     {
 590         wg_callback_free (cb);
 591         return (status);
 592     }
 593
 594     /* FIXME: Legacy configuration syntax. */
 595     if (cb->name == NULL)
 596         ssnprintf (callback_name, sizeof (callback_name), "write_graphite/%s/%s/%s",
 597                 cb->node, cb->service, cb->protocol);
 598     else
 599         ssnprintf (callback_name, sizeof (callback_name), "write_graphite/%s",
 600                 cb->name);
 601
 602     plugin_register_write (callback_name, wg_write,
 603             &(user_data_t) {
 604                 .data = cb,
 605                 .free_func = wg_callback_free,
 606             });
 607
 608     plugin_register_flush (callback_name, wg_flush, &(user_data_t) { .data = cb });
 609
 610     return (0);
 611 }
 612
 613 static int wg_config (oconfig_item_t *ci)
 614 {
 615     for (int i = 0; i < ci->children_num; i++)
 616     {
 617         oconfig_item_t *child = ci->children + i;
 618
 619         if (strcasecmp ("Node", child->key) == 0)
 620             wg_config_node (child);
 621         /* FIXME: Remove this legacy mode in version 6. */
 622         else if (strcasecmp ("Carbon", child->key) == 0)
 623             wg_config_node (child);
 624         else
 625         {
 626             ERROR ("write_graphite plugin: Invalid configuration "
 627                     "option: %s.", child->key);
 628         }
 629     }
 630
 631     return (0);
 632 }
 633
 634 void module_register (void)
 635 {
 636     plugin_register_complex_config ("write_graphite", wg_config);
 637 }
 638
 639 /* vim: set sw=4 ts=4 sts=4 tw=78 et : */