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