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
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.
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.
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
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>
29 * Based on the write_http plugin.
32 /* write_graphite plugin configuation example
34 * <Plugin write_graphite>
46 #include "configfile.h"
48 #include "utils_cache.h"
49 #include "utils_parse_option.h"
50 #include "utils_format_graphite.h"
52 /* Folks without pthread will need to disable this plugin. */
55 #include <sys/socket.h>
58 #ifndef WG_DEFAULT_NODE
59 # define WG_DEFAULT_NODE "localhost"
62 #ifndef WG_DEFAULT_SERVICE
63 # define WG_DEFAULT_SERVICE "2003"
66 #ifndef WG_DEFAULT_ESCAPE
67 # define WG_DEFAULT_ESCAPE '_'
70 /* Ethernet - (IPv6 + TCP) = 1500 - (40 + 32) = 1428 */
71 #ifndef WG_SEND_BUF_SIZE
72 # define WG_SEND_BUF_SIZE 1428
89 _Bool separate_instances;
90 _Bool always_append_ds;
92 char send_buf[WG_SEND_BUF_SIZE];
95 cdtime_t send_buf_init_time;
97 pthread_mutex_t send_lock;
104 static void wg_reset_buffer (struct wg_callback *cb)
106 memset (cb->send_buf, 0, sizeof (cb->send_buf));
107 cb->send_buf_free = sizeof (cb->send_buf);
108 cb->send_buf_fill = 0;
109 cb->send_buf_init_time = cdtime ();
112 static int wg_send_buffer (struct wg_callback *cb)
116 status = swrite (cb->sock_fd, cb->send_buf, strlen (cb->send_buf));
120 ERROR ("write_graphite plugin: send failed with status %zi (%s)",
121 status, sstrerror (errno, errbuf, sizeof (errbuf)));
133 /* NOTE: You must hold cb->send_lock when calling this function! */
134 static int wg_flush_nolock (cdtime_t timeout, struct wg_callback *cb)
138 DEBUG ("write_graphite plugin: wg_flush_nolock: timeout = %.3f; "
139 "send_buf_fill = %zu;",
143 /* timeout == 0 => flush unconditionally */
149 if ((cb->send_buf_init_time + timeout) > now)
153 if (cb->send_buf_fill <= 0)
155 cb->send_buf_init_time = cdtime ();
159 status = wg_send_buffer (cb);
160 wg_reset_buffer (cb);
165 static int wg_callback_init (struct wg_callback *cb)
167 struct addrinfo ai_hints;
168 struct addrinfo *ai_list;
169 struct addrinfo *ai_ptr;
172 const char *node = cb->node ? cb->node : WG_DEFAULT_NODE;
173 const char *service = cb->service ? cb->service : WG_DEFAULT_SERVICE;
178 memset (&ai_hints, 0, sizeof (ai_hints));
180 ai_hints.ai_flags |= AI_ADDRCONFIG;
182 ai_hints.ai_family = AF_UNSPEC;
183 ai_hints.ai_socktype = SOCK_STREAM;
187 status = getaddrinfo (node, service, &ai_hints, &ai_list);
190 ERROR ("write_graphite plugin: getaddrinfo (%s, %s) failed: %s",
191 node, service, gai_strerror (status));
195 assert (ai_list != NULL);
196 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
198 cb->sock_fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype,
199 ai_ptr->ai_protocol);
203 status = connect (cb->sock_fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
214 freeaddrinfo (ai_list);
219 ERROR ("write_graphite plugin: Connecting to %s:%s failed. "
220 "The last error was: %s", node, service,
221 sstrerror (errno, errbuf, sizeof (errbuf)));
226 wg_reset_buffer (cb);
231 static void wg_callback_free (void *data)
233 struct wg_callback *cb;
240 pthread_mutex_lock (&cb->send_lock);
242 wg_flush_nolock (/* timeout = */ 0, cb);
252 pthread_mutex_destroy (&cb->send_lock);
257 static int wg_flush (cdtime_t timeout,
258 const char *identifier __attribute__((unused)),
259 user_data_t *user_data)
261 struct wg_callback *cb;
264 if (user_data == NULL)
267 cb = user_data->data;
269 pthread_mutex_lock (&cb->send_lock);
273 status = wg_callback_init (cb);
276 ERROR ("write_graphite plugin: wg_callback_init failed.");
277 pthread_mutex_unlock (&cb->send_lock);
282 status = wg_flush_nolock (timeout, cb);
283 pthread_mutex_unlock (&cb->send_lock);
288 static int wg_send_message (char const *message, struct wg_callback *cb)
293 message_len = strlen (message);
295 pthread_mutex_lock (&cb->send_lock);
299 status = wg_callback_init (cb);
302 ERROR ("write_graphite plugin: wg_callback_init failed.");
303 pthread_mutex_unlock (&cb->send_lock);
308 if (message_len >= cb->send_buf_free)
310 status = wg_flush_nolock (/* timeout = */ 0, cb);
313 pthread_mutex_unlock (&cb->send_lock);
318 /* Assert that we have enough space for this message. */
319 assert (message_len < cb->send_buf_free);
321 /* `message_len + 1' because `message_len' does not include the
322 * trailing null byte. Neither does `send_buffer_fill'. */
323 memcpy (cb->send_buf + cb->send_buf_fill,
324 message, message_len + 1);
325 cb->send_buf_fill += message_len;
326 cb->send_buf_free -= message_len;
328 DEBUG ("write_graphite plugin: [%s]:%s buf %zu/%zu (%.1f %%) \"%s\"",
331 cb->send_buf_fill, sizeof (cb->send_buf),
332 100.0 * ((double) cb->send_buf_fill) / ((double) sizeof (cb->send_buf)),
335 pthread_mutex_unlock (&cb->send_lock);
340 static int wg_write_messages (const data_set_t *ds, const value_list_t *vl,
341 struct wg_callback *cb)
343 char buffer[WG_SEND_BUF_SIZE];
346 if (0 != strcmp (ds->type, vl->type))
348 ERROR ("write_graphite plugin: DS type does not match "
353 memset (buffer, 0, sizeof (buffer));
354 status = format_graphite (buffer, sizeof (buffer), ds, vl,
355 cb->prefix, cb->postfix, cb->escape_char, cb->store_rates);
356 if (status != 0) /* error message has been printed already. */
359 wg_send_message (buffer, cb);
362 ERROR ("write_graphite plugin: wg_send_message failed "
363 "with status %i.", status);
368 } /* int wg_write_messages */
370 static int wg_write (const data_set_t *ds, const value_list_t *vl,
371 user_data_t *user_data)
373 struct wg_callback *cb;
376 if (user_data == NULL)
379 cb = user_data->data;
381 status = wg_write_messages (ds, vl, cb);
386 static int config_set_char (char *dest,
392 memset (buffer, 0, sizeof (buffer));
394 status = cf_util_get_string_buffer (ci, buffer, sizeof (buffer));
400 ERROR ("write_graphite plugin: Cannot use an empty string for the "
401 "\"EscapeCharacter\" option.");
407 WARNING ("write_graphite plugin: Only the first character of the "
408 "\"EscapeCharacter\" option ('%c') will be used.",
417 static int wg_config_carbon (oconfig_item_t *ci)
419 struct wg_callback *cb;
420 user_data_t user_data;
421 char callback_name[DATA_MAX_NAME_LEN];
424 cb = malloc (sizeof (*cb));
427 ERROR ("write_graphite plugin: malloc failed.");
430 memset (cb, 0, sizeof (*cb));
436 cb->escape_char = WG_DEFAULT_ESCAPE;
439 pthread_mutex_init (&cb->send_lock, /* attr = */ NULL);
441 for (i = 0; i < ci->children_num; i++)
443 oconfig_item_t *child = ci->children + i;
445 if (strcasecmp ("Host", child->key) == 0)
446 cf_util_get_string (child, &cb->node);
447 else if (strcasecmp ("Port", child->key) == 0)
448 cf_util_get_service (child, &cb->service);
449 else if (strcasecmp ("Prefix", child->key) == 0)
450 cf_util_get_string (child, &cb->prefix);
451 else if (strcasecmp ("Postfix", child->key) == 0)
452 cf_util_get_string (child, &cb->postfix);
453 else if (strcasecmp ("StoreRates", child->key) == 0)
454 cf_util_get_boolean (child, &cb->store_rates);
455 else if (strcasecmp ("SeparateInstances", child->key) == 0)
456 cf_util_get_boolean (child, &cb->separate_instances);
457 else if (strcasecmp ("AlwaysAppendDS", child->key) == 0)
458 cf_util_get_boolean (child, &cb->always_append_ds);
459 else if (strcasecmp ("EscapeCharacter", child->key) == 0)
460 config_set_char (&cb->escape_char, child);
463 ERROR ("write_graphite plugin: Invalid configuration "
464 "option: %s.", child->key);
468 ssnprintf (callback_name, sizeof (callback_name), "write_graphite/%s/%s",
469 cb->node != NULL ? cb->node : WG_DEFAULT_NODE,
470 cb->service != NULL ? cb->service : WG_DEFAULT_SERVICE);
472 memset (&user_data, 0, sizeof (user_data));
474 user_data.free_func = wg_callback_free;
475 plugin_register_write (callback_name, wg_write, &user_data);
477 user_data.free_func = NULL;
478 plugin_register_flush (callback_name, wg_flush, &user_data);
483 static int wg_config (oconfig_item_t *ci)
487 for (i = 0; i < ci->children_num; i++)
489 oconfig_item_t *child = ci->children + i;
491 if (strcasecmp ("Carbon", child->key) == 0)
492 wg_config_carbon (child);
495 ERROR ("write_graphite plugin: Invalid configuration "
496 "option: %s.", child->key);
503 void module_register (void)
505 plugin_register_complex_config ("write_graphite", wg_config);
508 /* vim: set sw=4 ts=4 sts=4 tw=78 et : */