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