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