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_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 #define WG_DEFAULT_NODE "localhost"
  61 #define WG_DEFAULT_SERVICE "2003"
  62 #define WG_DEFAULT_PROTOCOL "tcp"
  63 #define WG_DEFAULT_LOG_SEND_ERRORS 1
  64 #define WG_DEFAULT_ESCAPE '_'
  65
  66 /* Ethernet - (IPv6 + TCP) = 1500 - (40 + 32) = 1428 */
  67 #define WG_SEND_BUF_SIZE 1428
  68
  69 #define WG_MIN_RECONNECT_INTERVAL TIME_T_TO_CDTIME_T (1)
  70
  71 /*
  72  * Private variables
  73  */
  74 struct wg_callback
  75 {
  76     int      sock_fd;
  77
  78     char    *name;
  79
  80     char    *node;
  81     char    *service;
  82     char    *protocol;
  83     _Bool   log_send_errors;
  84     char    *prefix;
  85     char    *postfix;
  86     char     escape_char;
  87
  88     unsigned int format_flags;
  89
  90     char     send_buf[WG_SEND_BUF_SIZE];
  91     size_t   send_buf_free;
  92     size_t   send_buf_fill;
  93     cdtime_t send_buf_init_time;
  94
  95     pthread_mutex_t send_lock;
  96     c_complain_t init_complaint;
  97     cdtime_t last_connect_time;
  98 };
  99
 100
 101 /*
 102  * Functions
 103  */
 104 static void wg_reset_buffer (struct wg_callback *cb)
 105 {
 106     memset (cb->send_buf, 0, sizeof (cb->send_buf));
 107     cb->send_buf_free = sizeof (cb->send_buf);
 108     cb->send_buf_fill = 0;
 109     cb->send_buf_init_time = cdtime ();
 110 }
 111
 112 static int wg_send_buffer (struct wg_callback *cb)
 113 {
 114     ssize_t status = 0;
 115
 116     status = swrite (cb->sock_fd, cb->send_buf, strlen (cb->send_buf));
 117     if (status < 0)
 118     {
 119         if (cb->log_send_errors)
 120         {
 121             char errbuf[1024];
 122             ERROR ("write_graphite plugin: send to %s:%s (%s) failed with status %zi (%s)",
 123                     cb->node, cb->service, cb->protocol,
 124                     status, sstrerror (errno, errbuf, sizeof (errbuf)));
 125         }
 126
 127         close (cb->sock_fd);
 128         cb->sock_fd = -1;
 129
 130         return (-1);
 131     }
 132
 133     return (0);
 134 }
 135
 136 /* NOTE: You must hold cb->send_lock when calling this function! */
 137 static int wg_flush_nolock (cdtime_t timeout, struct wg_callback *cb)
 138 {
 139     int status;
 140
 141     DEBUG ("write_graphite plugin: wg_flush_nolock: timeout = %.3f; "
 142             "send_buf_fill = %zu;",
 143             (double)timeout,
 144             cb->send_buf_fill);
 145
 146     /* timeout == 0  => flush unconditionally */
 147     if (timeout > 0)
 148     {
 149         cdtime_t now;
 150
 151         now = cdtime ();
 152         if ((cb->send_buf_init_time + timeout) > now)
 153             return (0);
 154     }
 155
 156     if (cb->send_buf_fill <= 0)
 157     {
 158         cb->send_buf_init_time = cdtime ();
 159         return (0);
 160     }
 161
 162     status = wg_send_buffer (cb);
 163     wg_reset_buffer (cb);
 164
 165     return (status);
 166 }
 167
 168 static int wg_callback_init (struct wg_callback *cb)
 169 {
 170     struct addrinfo ai_hints;
 171     struct addrinfo *ai_list;
 172     struct addrinfo *ai_ptr;
 173     cdtime_t now;
 174     int status;
 175
 176     char connerr[1024] = "";
 177
 178     if (cb->sock_fd > 0)
 179         return (0);
 180
 181     /* Don't try to reconnect too often. By default, one reconnection attempt
 182      * is made per second. */
 183     now = cdtime ();
 184     if ((now - cb->last_connect_time) < WG_MIN_RECONNECT_INTERVAL)
 185         return (EAGAIN);
 186     cb->last_connect_time = now;
 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", cb->protocol))
 195         ai_hints.ai_socktype = SOCK_STREAM;
 196     else
 197         ai_hints.ai_socktype = SOCK_DGRAM;
 198
 199     ai_list = NULL;
 200
 201     status = getaddrinfo (cb->node, cb->service, &ai_hints, &ai_list);
 202     if (status != 0)
 203     {
 204         ERROR ("write_graphite plugin: getaddrinfo (%s, %s, %s) failed: %s",
 205                 cb->node, cb->service, cb->protocol, gai_strerror (status));
 206         return (-1);
 207     }
 208
 209     assert (ai_list != NULL);
 210     for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
 211     {
 212         cb->sock_fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype,
 213                 ai_ptr->ai_protocol);
 214         if (cb->sock_fd < 0) {
 215             char errbuf[1024];
 216             snprintf (connerr, sizeof (connerr), "failed to open socket: %s",
 217                     sstrerror (errno, errbuf, sizeof (errbuf)));
 218             continue;
 219         }
 220
 221         status = connect (cb->sock_fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
 222         if (status != 0)
 223         {
 224             char errbuf[1024];
 225             snprintf (connerr, sizeof (connerr), "failed to connect to remote "
 226                     "host: %s", sstrerror (errno, errbuf, sizeof (errbuf)));
 227             close (cb->sock_fd);
 228             cb->sock_fd = -1;
 229             continue;
 230         }
 231
 232         break;
 233     }
 234
 235     freeaddrinfo (ai_list);
 236
 237     if (cb->sock_fd < 0)
 238     {
 239         if (connerr[0] == '\0')
 240             /* this should not happen but try to get a message anyway */
 241             sstrerror (errno, connerr, sizeof (connerr));
 242         c_complain (LOG_ERR, &cb->init_complaint,
 243                   "write_graphite plugin: Connecting to %s:%s via %s failed. "
 244                   "The last error was: %s", cb->node, cb->service, cb->protocol, connerr);
 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                 cb->node, cb->service, cb->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, cb->service, 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 = strdup (WG_DEFAULT_NODE);
 464     cb->service = strdup (WG_DEFAULT_SERVICE);
 465     cb->protocol = strdup (WG_DEFAULT_PROTOCOL);
 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, cb->service, cb->protocol);
 544     else
 545         ssnprintf (callback_name, sizeof (callback_name), "write_graphite/%s",
 546                 cb->name);
 547
 548     memset (&user_data, 0, sizeof (user_data));
 549     user_data.data = cb;
 550     user_data.free_func = wg_callback_free;
 551     plugin_register_write (callback_name, wg_write, &user_data);
 552
 553     user_data.free_func = NULL;
 554     plugin_register_flush (callback_name, wg_flush, &user_data);
 555
 556     return (0);
 557 }
 558
 559 static int wg_config (oconfig_item_t *ci)
 560 {
 561     int i;
 562
 563     for (i = 0; i < ci->children_num; i++)
 564     {
 565         oconfig_item_t *child = ci->children + i;
 566
 567         if (strcasecmp ("Node", child->key) == 0)
 568             wg_config_node (child);
 569         /* FIXME: Remove this legacy mode in version 6. */
 570         else if (strcasecmp ("Carbon", child->key) == 0)
 571             wg_config_node (child);
 572         else
 573         {
 574             ERROR ("write_graphite plugin: Invalid configuration "
 575                     "option: %s.", child->key);
 576         }
 577     }
 578
 579     return (0);
 580 }
 581
 582 void module_register (void)
 583 {
 584     plugin_register_complex_config ("write_graphite", wg_config);
 585 }
 586
 587 /* vim: set sw=4 ts=4 sts=4 tw=78 et : */