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