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