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