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