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-2012  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   *     Prefix "collectd"
  39   *   </Carbon>
  40   * </Plugin>
  41   */
  42
  43 #include "collectd.h"
  44 #include "common.h"
  45 #include "plugin.h"
  46 #include "configfile.h"
  47
  48 #include "utils_cache.h"
  49 #include "utils_parse_option.h"
  50
  51 /* Folks without pthread will need to disable this plugin. */
  52 #include <pthread.h>
  53
  54 #include <sys/socket.h>
  55 #include <netdb.h>
  56
  57 #ifndef WG_FORMAT_NAME
  58 #define WG_FORMAT_NAME(ret, ret_len, vl, cb, ds_name) \
  59         wg_format_name (ret, ret_len, (vl)->host, \
  60                          (vl)->plugin, (vl)->plugin_instance, \
  61                          (vl)->type, (vl)->type_instance, \
  62                          (cb)->prefix, (cb)->postfix, \
  63                          ds_name, (cb)->escape_char)
  64 #endif
  65
  66 #ifndef WG_DEFAULT_NODE
  67 # define WG_DEFAULT_NODE "localhost"
  68 #endif
  69
  70 #ifndef WG_DEFAULT_SERVICE
  71 # define WG_DEFAULT_SERVICE "2003"
  72 #endif
  73
  74 #ifndef WG_SEND_BUF_SIZE
  75 # define WG_SEND_BUF_SIZE 4096
  76 #endif
  77
  78 /*
  79  * Private variables
  80  */
  81 struct wg_callback
  82 {
  83     int      sock_fd;
  84
  85     char    *node;
  86     char    *service;
  87     char    *prefix;
  88     char    *postfix;
  89     char     escape_char;
  90
  91     char     send_buf[WG_SEND_BUF_SIZE];
  92     size_t   send_buf_free;
  93     size_t   send_buf_fill;
  94     cdtime_t send_buf_init_time;
  95
  96     pthread_mutex_t send_lock;
  97 };
  98
  99
 100 /*
 101  * Functions
 102  */
 103 static void wg_reset_buffer (struct wg_callback *cb)
 104 {
 105     memset (cb->send_buf, 0, sizeof (cb->send_buf));
 106     cb->send_buf_free = sizeof (cb->send_buf);
 107     cb->send_buf_fill = 0;
 108     cb->send_buf_init_time = cdtime ();
 109 }
 110
 111 static int wg_send_buffer (struct wg_callback *cb)
 112 {
 113     int status = 0;
 114
 115     status = write (cb->sock_fd, cb->send_buf, strlen (cb->send_buf));
 116     if (status < 0)
 117     {
 118         ERROR ("write_graphite plugin: send failed with "
 119                 "status %i (%s)",
 120                 status,
 121                 strerror (errno));
 122
 123         close (cb->sock_fd);
 124         cb->sock_fd = -1;
 125
 126         return (-1);
 127     }
 128     return (0);
 129 }
 130
 131 /* NOTE: You must hold cb->send_lock when calling this function! */
 132 static int wg_flush_nolock (cdtime_t timeout, struct wg_callback *cb)
 133 {
 134     int status;
 135
 136     DEBUG ("write_graphite plugin: wg_flush_nolock: timeout = %.3f; "
 137             "send_buf_fill = %zu;",
 138             (double)timeout,
 139             cb->send_buf_fill);
 140
 141     /* timeout == 0  => flush unconditionally */
 142     if (timeout > 0)
 143     {
 144         cdtime_t now;
 145
 146         now = cdtime ();
 147         if ((cb->send_buf_init_time + timeout) > now)
 148             return (0);
 149     }
 150
 151     if (cb->send_buf_fill <= 0)
 152     {
 153         cb->send_buf_init_time = cdtime ();
 154         return (0);
 155     }
 156
 157     status = wg_send_buffer (cb);
 158     wg_reset_buffer (cb);
 159
 160     return (status);
 161 }
 162
 163 static int wg_callback_init (struct wg_callback *cb)
 164 {
 165     struct addrinfo ai_hints;
 166     struct addrinfo *ai_list;
 167     struct addrinfo *ai_ptr;
 168     int status;
 169
 170     const char *node = cb->node ? cb->node : WG_DEFAULT_NODE;
 171     const char *service = cb->service ? cb->service : WG_DEFAULT_SERVICE;
 172
 173     if (cb->sock_fd > 0)
 174         return (0);
 175
 176     memset (&ai_hints, 0, sizeof (ai_hints));
 177 #ifdef AI_ADDRCONFIG
 178     ai_hints.ai_flags |= AI_ADDRCONFIG;
 179 #endif
 180     ai_hints.ai_family = AF_UNSPEC;
 181     ai_hints.ai_socktype = SOCK_STREAM;
 182
 183     ai_list = NULL;
 184
 185     status = getaddrinfo (node, service, &ai_hints, &ai_list);
 186     if (status != 0)
 187     {
 188         ERROR ("write_graphite plugin: getaddrinfo (%s, %s) failed: %s",
 189                 node, service, gai_strerror (status));
 190         return (-1);
 191     }
 192
 193     assert (ai_list != NULL);
 194     for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
 195     {
 196         cb->sock_fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype,
 197                 ai_ptr->ai_protocol);
 198         if (cb->sock_fd < 0)
 199             continue;
 200
 201         status = connect (cb->sock_fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
 202         if (status != 0)
 203         {
 204             close (cb->sock_fd);
 205             cb->sock_fd = -1;
 206             continue;
 207         }
 208
 209         break;
 210     }
 211
 212     freeaddrinfo (ai_list);
 213
 214     if (cb->sock_fd < 0)
 215     {
 216         char errbuf[1024];
 217         ERROR ("write_graphite plugin: Connecting to %s:%s failed. "
 218                 "The last error was: %s", node, service,
 219                 sstrerror (errno, errbuf, sizeof (errbuf)));
 220         close (cb->sock_fd);
 221         return (-1);
 222     }
 223
 224     wg_reset_buffer (cb);
 225
 226     return (0);
 227 }
 228
 229 static void wg_callback_free (void *data)
 230 {
 231     struct wg_callback *cb;
 232
 233     if (data == NULL)
 234         return;
 235
 236     cb = data;
 237
 238     pthread_mutex_lock (&cb->send_lock);
 239
 240     wg_flush_nolock (/* timeout = */ 0, cb);
 241
 242     close(cb->sock_fd);
 243     cb->sock_fd = -1;
 244
 245     sfree(cb->node);
 246     sfree(cb->service);
 247     sfree(cb->prefix);
 248     sfree(cb->postfix);
 249
 250     pthread_mutex_destroy (&cb->send_lock);
 251
 252     sfree(cb);
 253 }
 254
 255 static int wg_flush (cdtime_t timeout,
 256         const char *identifier __attribute__((unused)),
 257         user_data_t *user_data)
 258 {
 259     struct wg_callback *cb;
 260     int status;
 261
 262     if (user_data == NULL)
 263         return (-EINVAL);
 264
 265     cb = user_data->data;
 266
 267     pthread_mutex_lock (&cb->send_lock);
 268
 269     if (cb->sock_fd < 0)
 270     {
 271         status = wg_callback_init (cb);
 272         if (status != 0)
 273         {
 274             ERROR ("write_graphite plugin: wg_callback_init failed.");
 275             pthread_mutex_unlock (&cb->send_lock);
 276             return (-1);
 277         }
 278     }
 279
 280     status = wg_flush_nolock (timeout, cb);
 281     pthread_mutex_unlock (&cb->send_lock);
 282
 283     return (status);
 284 }
 285
 286 static int wg_format_values (char *ret, size_t ret_len,
 287         int ds_num, const data_set_t *ds, const value_list_t *vl,
 288         _Bool store_rates)
 289 {
 290     size_t offset = 0;
 291     int status;
 292     gauge_t *rates = NULL;
 293
 294     assert (0 == strcmp (ds->type, vl->type));
 295
 296     memset (ret, 0, ret_len);
 297
 298 #define BUFFER_ADD(...) do { \
 299     status = ssnprintf (ret + offset, ret_len - offset, \
 300             __VA_ARGS__); \
 301     if (status < 1) \
 302     { \
 303         sfree (rates); \
 304         return (-1); \
 305     } \
 306     else if (((size_t) status) >= (ret_len - offset)) \
 307     { \
 308         sfree (rates); \
 309         return (-1); \
 310     } \
 311     else \
 312     offset += ((size_t) status); \
 313 } while (0)
 314
 315     if (ds->ds[ds_num].type == DS_TYPE_GAUGE)
 316         BUFFER_ADD ("%f", vl->values[ds_num].gauge);
 317     else if (store_rates)
 318     {
 319         if (rates == NULL)
 320             rates = uc_get_rate (ds, vl);
 321         if (rates == NULL)
 322         {
 323             WARNING ("format_values: "
 324                     "uc_get_rate failed.");
 325             return (-1);
 326         }
 327         BUFFER_ADD ("%g", rates[ds_num]);
 328     }
 329     else if (ds->ds[ds_num].type == DS_TYPE_COUNTER)
 330         BUFFER_ADD ("%llu", vl->values[ds_num].counter);
 331     else if (ds->ds[ds_num].type == DS_TYPE_DERIVE)
 332         BUFFER_ADD ("%"PRIi64, vl->values[ds_num].derive);
 333     else if (ds->ds[ds_num].type == DS_TYPE_ABSOLUTE)
 334         BUFFER_ADD ("%"PRIu64, vl->values[ds_num].absolute);
 335     else
 336     {
 337         ERROR ("format_values plugin: Unknown data source type: %i",
 338                 ds->ds[ds_num].type);
 339         sfree (rates);
 340         return (-1);
 341     }
 342
 343 #undef BUFFER_ADD
 344
 345     sfree (rates);
 346     return (0);
 347 }
 348
 349 static void wg_copy_escape_part (char *dst, const char *src, size_t dst_len,
 350     char escape_char)
 351 {
 352     size_t i;
 353
 354     memset (dst, 0, dst_len);
 355
 356     if (src == NULL)
 357         return;
 358
 359     for (i = 0; i < dst_len; i++)
 360     {
 361         if ((src[i] == '.')
 362                 || isspace ((int) src[i])
 363                 || iscntrl ((int) src[i]))
 364             dst[i] = escape_char;
 365         else
 366             dst[i] = src[i];
 367
 368         if (src[i] == 0)
 369             break;
 370     }
 371 }
 372
 373 static int wg_format_name (char *ret, int ret_len,
 374         const char *hostname,
 375         const char *plugin, const char *plugin_instance,
 376         const char *type, const char *type_instance,
 377         const char *prefix, const char *postfix,
 378         const char *ds_name, char escape_char)
 379 {
 380     char n_hostname[DATA_MAX_NAME_LEN];
 381     char n_plugin[DATA_MAX_NAME_LEN];
 382     char n_plugin_instance[DATA_MAX_NAME_LEN];
 383     char n_type[DATA_MAX_NAME_LEN];
 384     char n_type_instance[DATA_MAX_NAME_LEN];
 385     int  status;
 386
 387     assert (hostname != NULL);
 388     assert (plugin != NULL);
 389     assert (type != NULL);
 390     assert (ds_name != NULL);
 391
 392     if (prefix == NULL)
 393         prefix = "";
 394
 395     if (postfix == NULL)
 396         postfix = "";
 397
 398     wg_copy_escape_part (n_hostname, hostname,
 399             sizeof (n_hostname), escape_char);
 400     wg_copy_escape_part (n_plugin, plugin,
 401             sizeof (n_plugin), escape_char);
 402     wg_copy_escape_part (n_plugin_instance, plugin_instance,
 403             sizeof (n_plugin_instance), escape_char);
 404     wg_copy_escape_part (n_type, type,
 405             sizeof (n_type), escape_char);
 406     wg_copy_escape_part (n_type_instance, type_instance,
 407             sizeof (n_type_instance), escape_char);
 408
 409     if (n_plugin_instance[0] == '\0')
 410     {
 411         if (n_type_instance[0] == '\0')
 412         {
 413             status = ssnprintf (ret, ret_len, "%s%s%s.%s.%s.%s",
 414                     prefix, n_hostname, postfix, n_plugin, n_type, ds_name);
 415         }
 416         else
 417         {
 418             status = ssnprintf (ret, ret_len, "%s%s%s.%s.%s-%s.%s",
 419                     prefix, n_hostname, postfix, n_plugin, n_type,
 420                     n_type_instance, ds_name);
 421         }
 422     }
 423     else
 424     {
 425         if (n_type_instance[0] == '\0')
 426         {
 427             status = ssnprintf (ret, ret_len, "%s%s%s.%s.%s.%s.%s",
 428                     prefix, n_hostname, postfix, n_plugin,
 429                     n_plugin_instance, n_type, ds_name);
 430         }
 431         else
 432         {
 433             status = ssnprintf (ret, ret_len, "%s%s%s.%s.%s.%s-%s.%s",
 434                     prefix, n_hostname, postfix, n_plugin,
 435                     n_plugin_instance, n_type, n_type_instance, ds_name);
 436         }
 437     }
 438
 439     if ((status < 1) || (status >= ret_len))
 440         return (-1);
 441
 442     return (0);
 443 }
 444
 445 static int wg_send_message (const char* key, const char* value,
 446         cdtime_t time, struct wg_callback *cb)
 447 {
 448     int status;
 449     size_t message_len;
 450     char message[1024];
 451
 452     message_len = (size_t) ssnprintf (message, sizeof (message),
 453             "%s %s %.0f\n",
 454             key,
 455             value,
 456             CDTIME_T_TO_DOUBLE(time));
 457     if (message_len >= sizeof (message)) {
 458         ERROR ("write_graphite plugin: message buffer too small: "
 459                 "Need %zu bytes.", message_len + 1);
 460         return (-1);
 461     }
 462
 463
 464     pthread_mutex_lock (&cb->send_lock);
 465
 466     if (cb->sock_fd < 0)
 467     {
 468         status = wg_callback_init (cb);
 469         if (status != 0)
 470         {
 471             ERROR ("write_graphite plugin: wg_callback_init failed.");
 472             pthread_mutex_unlock (&cb->send_lock);
 473             return (-1);
 474         }
 475     }
 476
 477     if (message_len >= cb->send_buf_free)
 478     {
 479         status = wg_flush_nolock (/* timeout = */ 0, cb);
 480         if (status != 0)
 481         {
 482             pthread_mutex_unlock (&cb->send_lock);
 483             return (status);
 484         }
 485     }
 486     assert (message_len < cb->send_buf_free);
 487
 488     /* `message_len + 1' because `message_len' does not include the
 489      * trailing null byte. Neither does `send_buffer_fill'. */
 490     memcpy (cb->send_buf + cb->send_buf_fill,
 491             message, message_len + 1);
 492     cb->send_buf_fill += message_len;
 493     cb->send_buf_free -= message_len;
 494
 495     DEBUG ("write_graphite plugin: <%s:%s> buf %zu/%zu (%g%%) \"%s\"",
 496             cb->node,
 497             cb->service,
 498             cb->send_buf_fill, sizeof (cb->send_buf),
 499             100.0 * ((double) cb->send_buf_fill) / ((double) sizeof (cb->send_buf)),
 500             message);
 501
 502     /* Check if we have enough space for this message. */
 503     pthread_mutex_unlock (&cb->send_lock);
 504
 505     return (0);
 506 }
 507
 508 static int wg_write_messages (const data_set_t *ds, const value_list_t *vl,
 509         struct wg_callback *cb)
 510 {
 511     char key[10*DATA_MAX_NAME_LEN];
 512     char values[512];
 513
 514     int status, i;
 515
 516     if (0 != strcmp (ds->type, vl->type))
 517     {
 518         ERROR ("write_graphite plugin: DS type does not match "
 519                 "value list type");
 520         return -1;
 521     }
 522
 523     if (ds->ds_num > 1)
 524     {
 525         for (i = 0; i < ds->ds_num; i++)
 526         {
 527             /* Copy the identifier to `key' and escape it. */
 528             status = WG_FORMAT_NAME (key, sizeof (key), vl, cb, ds->ds[i].name);
 529             if (status != 0)
 530             {
 531                 ERROR ("write_graphite plugin: error with format_name");
 532                 return (status);
 533             }
 534
 535             escape_string (key, sizeof (key));
 536             /* Convert the values to an ASCII representation and put that
 537              * into `values'. */
 538             status = wg_format_values (values, sizeof (values), i, ds, vl, 0);
 539             if (status != 0)
 540             {
 541                 ERROR ("write_graphite plugin: error with "
 542                         "wg_format_values");
 543                 return (status);
 544             }
 545
 546             /* Send the message to graphite */
 547             status = wg_send_message (key, values, vl->time, cb);
 548             if (status != 0)
 549             {
 550                 ERROR ("write_graphite plugin: error with "
 551                         "wg_send_message");
 552                 return (status);
 553             }
 554         }
 555     }
 556     else
 557     {
 558         /* Copy the identifier to `key' and escape it. */
 559         status = WG_FORMAT_NAME (key, sizeof (key), vl, cb, NULL);
 560         if (status != 0)
 561         {
 562             ERROR ("write_graphite plugin: error with format_name");
 563             return (status);
 564         }
 565
 566         escape_string (key, sizeof (key));
 567         /* Convert the values to an ASCII representation and put that into
 568          * `values'. */
 569         status = wg_format_values (values, sizeof (values), 0, ds, vl, 0);
 570         if (status != 0)
 571         {
 572             ERROR ("write_graphite plugin: error with "
 573                     "wg_format_values");
 574             return (status);
 575         }
 576
 577         /* Send the message to graphite */
 578         status = wg_send_message (key, values, vl->time, cb);
 579         if (status != 0)
 580         {
 581             ERROR ("write_graphite plugin: error with "
 582                     "wg_send_message");
 583             return (status);
 584         }
 585     }
 586
 587     return (0);
 588 }
 589
 590 static int wg_write (const data_set_t *ds, const value_list_t *vl,
 591         user_data_t *user_data)
 592 {
 593     struct wg_callback *cb;
 594     int status;
 595
 596     if (user_data == NULL)
 597         return (-EINVAL);
 598
 599     cb = user_data->data;
 600
 601     status = wg_write_messages (ds, vl, cb);
 602
 603     return (status);
 604 }
 605
 606 static int config_set_char (char *dest,
 607         oconfig_item_t *ci)
 608 {
 609     if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
 610     {
 611         WARNING ("write_graphite plugin: The `%s' config option "
 612                 "needs exactly one string argument.", ci->key);
 613         return (-1);
 614     }
 615
 616     *dest = ci->values[0].value.string[0];
 617
 618     return (0);
 619 }
 620
 621 static int wg_config_carbon (oconfig_item_t *ci)
 622 {
 623     struct wg_callback *cb;
 624     user_data_t user_data;
 625     int i;
 626
 627     cb = malloc (sizeof (*cb));
 628     if (cb == NULL)
 629     {
 630         ERROR ("write_graphite plugin: malloc failed.");
 631         return (-1);
 632     }
 633     memset (cb, 0, sizeof (*cb));
 634     cb->sock_fd = -1;
 635     cb->node = NULL;
 636     cb->service = NULL;
 637     cb->prefix = NULL;
 638     cb->postfix = NULL;
 639     cb->escape_char = '_';
 640
 641     pthread_mutex_init (&cb->send_lock, /* attr = */ NULL);
 642
 643     for (i = 0; i < ci->children_num; i++)
 644     {
 645         oconfig_item_t *child = ci->children + i;
 646
 647         if (strcasecmp ("Host", child->key) == 0)
 648             cf_util_get_string (child, &cb->node);
 649         else if (strcasecmp ("Port", child->key) == 0)
 650             cf_util_get_string (child, &cb->service);
 651         else if (strcasecmp ("Prefix", child->key) == 0)
 652             cf_util_get_string (child, &cb->prefix);
 653         else if (strcasecmp ("Postfix", child->key) == 0)
 654             cf_util_get_string (child, &cb->postfix);
 655         else if (strcasecmp ("EscapeCharacter", child->key) == 0)
 656             config_set_char (&cb->escape_char, child);
 657         else
 658         {
 659             ERROR ("write_graphite plugin: Invalid configuration "
 660                         "option: %s.", child->key);
 661         }
 662     }
 663
 664     DEBUG ("write_graphite: Registering write callback to carbon agent %s:%s",
 665             cb->node ? cb->node : WG_DEFAULT_NODE,
 666             cb->service ? cb->service : WG_DEFAULT_SERVICE);
 667
 668     memset (&user_data, 0, sizeof (user_data));
 669     user_data.data = cb;
 670     user_data.free_func = NULL;
 671     plugin_register_flush ("write_graphite", wg_flush, &user_data);
 672
 673     user_data.free_func = wg_callback_free;
 674     plugin_register_write ("write_graphite", wg_write, &user_data);
 675
 676     return (0);
 677 }
 678
 679 static int wg_config (oconfig_item_t *ci)
 680 {
 681     int i;
 682
 683     for (i = 0; i < ci->children_num; i++)
 684     {
 685         oconfig_item_t *child = ci->children + i;
 686
 687         if (strcasecmp ("Carbon", child->key) == 0)
 688             wg_config_carbon (child);
 689         else
 690         {
 691             ERROR ("write_graphite plugin: Invalid configuration "
 692                     "option: %s.", child->key);
 693         }
 694     }
 695
 696     return (0);
 697 }
 698
 699 void module_register (void)
 700 {
 701     plugin_register_complex_config ("write_graphite", wg_config);
 702 }
 703
 704 /* vim: set sw=4 ts=4 sts=4 tw=78 et : */