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