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