src/write_graphite.c

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