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