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