2 * collectd - src/write_graphite.c
3 * Copyright (C) 2011 Scott Sanders
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.
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.
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
19 * Scott Sanders <scott@jssjr.com>
21 * based on the excellent write_http plugin
24 /* write_graphite plugin configuation example
26 * <Plugin write_graphite>
38 #include "configfile.h"
40 #include "utils_cache.h"
41 #include "utils_parse_option.h"
43 /* Folks without pthread will need to disable this plugin. */
46 #include <sys/socket.h>
49 #ifndef WG_FORMAT_NAME
50 #define WG_FORMAT_NAME(ret, ret_len, vl, cb, name) \
51 wg_format_name (ret, ret_len, (vl)->host, (vl)->plugin, \
52 (vl)->plugin_instance, (vl)->type, \
53 (vl)->type_instance, (cb)->prefix, (cb)->postfix, \
57 #ifndef WG_DEFAULT_NODE
58 # define WG_DEFAULT_NODE "localhost"
61 #ifndef WG_DEFAULT_SERVICE
62 # define WG_DEFAULT_SERVICE "2003"
65 #ifndef WG_SEND_BUF_SIZE
66 # define WG_SEND_BUF_SIZE 4096
75 struct hostent *server;
83 char send_buf[WG_SEND_BUF_SIZE];
86 cdtime_t send_buf_init_time;
88 pthread_mutex_t send_lock;
95 static void wg_reset_buffer (struct wg_callback *cb)
97 memset (cb->send_buf, 0, sizeof (cb->send_buf));
98 cb->send_buf_free = sizeof (cb->send_buf);
99 cb->send_buf_fill = 0;
100 cb->send_buf_init_time = cdtime ();
103 static int wg_send_buffer (struct wg_callback *cb)
107 status = write (cb->sock_fd, cb->send_buf, strlen (cb->send_buf));
110 ERROR ("write_graphite plugin: send failed with "
115 pthread_mutex_trylock (&cb->send_lock);
117 DEBUG ("write_graphite plugin: closing socket and restting fd "
118 "so reinit will occur");
122 pthread_mutex_unlock (&cb->send_lock);
129 static int wg_flush_nolock (cdtime_t timeout, struct wg_callback *cb)
133 DEBUG ("write_graphite plugin: wg_flush_nolock: timeout = %.3f; "
134 "send_buf_fill = %zu;",
138 /* timeout == 0 => flush unconditionally */
144 if ((cb->send_buf_init_time + timeout) > now)
148 if (cb->send_buf_fill <= 0)
150 cb->send_buf_init_time = cdtime ();
154 status = wg_send_buffer (cb);
155 wg_reset_buffer (cb);
160 static int wg_callback_init (struct wg_callback *cb)
162 struct addrinfo ai_hints;
163 struct addrinfo *ai_list;
164 struct addrinfo *ai_ptr;
167 const char *node = cb->node ? cb->node : WG_DEFAULT_NODE;
168 const char *service = cb->service ? cb->service : WG_DEFAULT_SERVICE;
173 memset (&ai_hints, 0, sizeof (ai_hints));
175 ai_hints.ai_flags |= AI_ADDRCONFIG;
177 ai_hints.ai_family = AF_UNSPEC;
178 ai_hints.ai_socktype = SOCK_STREAM;
182 status = getaddrinfo (node, service, &ai_hints, &ai_list);
185 ERROR ("write_graphite plugin: getaddrinfo (%s, %s) failed: %s",
186 node, service, gai_strerror (status));
190 assert (ai_list != NULL);
191 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
193 cb->sock_fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype,
194 ai_ptr->ai_protocol);
198 status = connect (cb->sock_fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
209 freeaddrinfo (ai_list);
214 ERROR ("write_graphite plugin: Connecting to %s:%s failed. "
215 "The last error was: %s", node, service,
216 sstrerror (errno, errbuf, sizeof (errbuf)));
221 wg_reset_buffer (cb);
226 static void wg_callback_free (void *data)
228 struct wg_callback *cb;
235 wg_flush_nolock (/* timeout = */ 0, cb);
246 static int wg_flush (cdtime_t timeout,
247 const char *identifier __attribute__((unused)),
248 user_data_t *user_data)
250 struct wg_callback *cb;
253 if (user_data == NULL)
256 cb = user_data->data;
258 pthread_mutex_lock (&cb->send_lock);
262 status = wg_callback_init (cb);
265 ERROR ("write_graphite plugin: wg_callback_init failed.");
266 pthread_mutex_unlock (&cb->send_lock);
271 status = wg_flush_nolock (timeout, cb);
272 pthread_mutex_unlock (&cb->send_lock);
277 static int wg_format_values (char *ret, size_t ret_len,
278 int ds_num, const data_set_t *ds, const value_list_t *vl,
283 gauge_t *rates = NULL;
285 assert (0 == strcmp (ds->type, vl->type));
287 memset (ret, 0, ret_len);
289 #define BUFFER_ADD(...) do { \
290 status = ssnprintf (ret + offset, ret_len - offset, \
297 else if (((size_t) status) >= (ret_len - offset)) \
303 offset += ((size_t) status); \
306 if (ds->ds[ds_num].type == DS_TYPE_GAUGE)
307 BUFFER_ADD ("%f", vl->values[ds_num].gauge);
308 else if (store_rates)
311 rates = uc_get_rate (ds, vl);
314 WARNING ("format_values: "
315 "uc_get_rate failed.");
318 BUFFER_ADD ("%g", rates[ds_num]);
320 else if (ds->ds[ds_num].type == DS_TYPE_COUNTER)
321 BUFFER_ADD ("%llu", vl->values[ds_num].counter);
322 else if (ds->ds[ds_num].type == DS_TYPE_DERIVE)
323 BUFFER_ADD ("%"PRIi64, vl->values[ds_num].derive);
324 else if (ds->ds[ds_num].type == DS_TYPE_ABSOLUTE)
325 BUFFER_ADD ("%"PRIu64, vl->values[ds_num].absolute);
328 ERROR ("format_values plugin: Unknown data source type: %i",
329 ds->ds[ds_num].type);
340 static int swap_chars (char *dst, const char *src,
341 const char from, const char to)
347 for (i = 0; i < strlen(src) ; i++)
362 static int wg_format_name (char *ret, int ret_len,
363 const char *hostname,
364 const char *plugin, const char *plugin_instance,
365 const char *type, const char *type_instance,
366 const char *prefix, const char *postfix,
367 const char *ds_name, const char dotchar)
370 char *n_hostname = 0;
371 char *n_type_instance = 0;
373 assert (plugin != NULL);
374 assert (type != NULL);
382 if ((n_hostname = malloc(strlen(hostname)+1)) == NULL)
384 ERROR ("Unable to allocate memory for normalized hostname buffer");
388 if (swap_chars(n_hostname, hostname, '.', dotchar) == -1)
390 ERROR ("Unable to normalize hostname");
394 if (type_instance && type_instance[0] != '\0') {
395 if ((n_type_instance = malloc(strlen(type_instance)+1)) == NULL)
397 ERROR ("Unable to allocate memory for normalized datasource name buffer");
400 if (swap_chars(n_type_instance, type_instance, '.', dotchar) == -1)
402 ERROR ("Unable to normalize datasource name");
407 if ((plugin_instance == NULL) || (plugin_instance[0] == '\0'))
409 if ((n_type_instance == NULL) || (n_type_instance[0] == '\0'))
411 if ((ds_name == NULL) || (ds_name[0] == '\0'))
412 status = ssnprintf (ret, ret_len, "%s%s%s.%s.%s",
413 prefix, n_hostname, postfix, plugin, type);
415 status = ssnprintf (ret, ret_len, "%s%s%s.%s.%s.%s",
416 prefix, n_hostname, postfix, plugin, type, ds_name);
420 if ((ds_name == NULL) || (ds_name[0] == '\0'))
421 status = ssnprintf (ret, ret_len, "%s%s%s.%s.%s-%s",
422 prefix, n_hostname, postfix, plugin, type,
425 status = ssnprintf (ret, ret_len, "%s%s%s.%s.%s-%s.%s",
426 prefix, n_hostname, postfix, plugin, type,
427 n_type_instance, ds_name);
432 if ((n_type_instance == NULL) || (n_type_instance[0] == '\0'))
434 if ((ds_name == NULL) || (ds_name[0] == '\0'))
435 status = ssnprintf (ret, ret_len, "%s%s%s.%s.%s.%s",
436 prefix, n_hostname, postfix, plugin,
437 plugin_instance, type);
439 status = ssnprintf (ret, ret_len, "%s%s%s.%s.%s.%s.%s",
440 prefix, n_hostname, postfix, plugin,
441 plugin_instance, type, ds_name);
445 if ((ds_name == NULL) || (ds_name[0] == '\0'))
446 status = ssnprintf (ret, ret_len, "%s%s%s.%s.%s.%s-%s",
447 prefix, n_hostname, postfix, plugin,
448 plugin_instance, type, n_type_instance);
450 status = ssnprintf (ret, ret_len, "%s%s%s.%s.%s.%s-%s.%s",
451 prefix, n_hostname, postfix, plugin,
452 plugin_instance, type, n_type_instance, ds_name);
457 sfree(n_type_instance);
459 if ((status < 1) || (status >= ret_len))
464 static int wg_send_message (const char* key, const char* value,
465 cdtime_t time, struct wg_callback *cb)
471 message_len = (size_t) ssnprintf (message, sizeof (message),
475 CDTIME_T_TO_DOUBLE(time));
476 if (message_len >= sizeof (message)) {
477 ERROR ("write_graphite plugin: message buffer too small: "
478 "Need %zu bytes.", message_len + 1);
483 pthread_mutex_lock (&cb->send_lock);
487 status = wg_callback_init (cb);
490 ERROR ("write_graphite plugin: wg_callback_init failed.");
491 pthread_mutex_unlock (&cb->send_lock);
496 if (message_len >= cb->send_buf_free)
498 status = wg_flush_nolock (/* timeout = */ 0, cb);
501 pthread_mutex_unlock (&cb->send_lock);
505 assert (message_len < cb->send_buf_free);
507 /* `message_len + 1' because `message_len' does not include the
508 * trailing null byte. Neither does `send_buffer_fill'. */
509 memcpy (cb->send_buf + cb->send_buf_fill,
510 message, message_len + 1);
511 cb->send_buf_fill += message_len;
512 cb->send_buf_free -= message_len;
514 DEBUG ("write_graphite plugin: <%s:%s> buf %zu/%zu (%g%%) \"%s\"",
517 cb->send_buf_fill, sizeof (cb->send_buf),
518 100.0 * ((double) cb->send_buf_fill) / ((double) sizeof (cb->send_buf)),
521 /* Check if we have enough space for this message. */
522 pthread_mutex_unlock (&cb->send_lock);
527 static int wg_write_messages (const data_set_t *ds, const value_list_t *vl,
528 struct wg_callback *cb)
530 char key[10*DATA_MAX_NAME_LEN];
535 if (0 != strcmp (ds->type, vl->type))
537 ERROR ("write_graphite plugin: DS type does not match "
544 for (i = 0; i < ds->ds_num; i++)
546 /* Copy the identifier to `key' and escape it. */
547 status = WG_FORMAT_NAME (key, sizeof (key), vl, cb, ds->ds[i].name);
550 ERROR ("write_graphite plugin: error with format_name");
554 escape_string (key, sizeof (key));
555 /* Convert the values to an ASCII representation and put that
557 status = wg_format_values (values, sizeof (values), i, ds, vl, 0);
560 ERROR ("write_graphite plugin: error with "
565 /* Send the message to graphite */
566 status = wg_send_message (key, values, vl->time, cb);
569 ERROR ("write_graphite plugin: error with "
577 /* Copy the identifier to `key' and escape it. */
578 status = WG_FORMAT_NAME (key, sizeof (key), vl, cb, NULL);
581 ERROR ("write_graphite plugin: error with format_name");
585 escape_string (key, sizeof (key));
586 /* Convert the values to an ASCII representation and put that into
588 status = wg_format_values (values, sizeof (values), 0, ds, vl, 0);
591 ERROR ("write_graphite plugin: error with "
596 /* Send the message to graphite */
597 status = wg_send_message (key, values, vl->time, cb);
600 ERROR ("write_graphite plugin: error with "
609 static int wg_write (const data_set_t *ds, const value_list_t *vl,
610 user_data_t *user_data)
612 struct wg_callback *cb;
615 if (user_data == NULL)
618 cb = user_data->data;
620 status = wg_write_messages (ds, vl, cb);
625 static int config_set_char (char *dest,
628 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
630 WARNING ("write_graphite plugin: The `%s' config option "
631 "needs exactly one string argument.", ci->key);
635 *dest = ci->values[0].value.string[0];
640 static int wg_config_carbon (oconfig_item_t *ci)
642 struct wg_callback *cb;
643 user_data_t user_data;
646 cb = malloc (sizeof (*cb));
649 ERROR ("write_graphite plugin: malloc failed.");
652 memset (cb, 0, sizeof (*cb));
661 pthread_mutex_init (&cb->send_lock, /* attr = */ NULL);
663 for (i = 0; i < ci->children_num; i++)
665 oconfig_item_t *child = ci->children + i;
667 if (strcasecmp ("Host", child->key) == 0)
668 cf_util_get_string (child, &cb->node);
669 else if (strcasecmp ("Port", child->key) == 0)
670 cf_util_get_string (child, &cb->service);
671 else if (strcasecmp ("Prefix", child->key) == 0)
672 cf_util_get_string (child, &cb->prefix);
673 else if (strcasecmp ("Postfix", child->key) == 0)
674 cf_util_get_string (child, &cb->postfix);
675 else if (strcasecmp ("DotCharacter", child->key) == 0)
676 config_set_char (&cb->dotchar, child);
679 ERROR ("write_graphite plugin: Invalid configuration "
680 "option: %s.", child->key);
684 DEBUG ("write_graphite: Registering write callback to carbon agent %s:%s",
685 cb->node ? cb->node : WG_DEFAULT_NODE,
686 cb->service ? cb->service : WG_DEFAULT_SERVICE);
688 memset (&user_data, 0, sizeof (user_data));
690 user_data.free_func = NULL;
691 plugin_register_flush ("write_graphite", wg_flush, &user_data);
693 user_data.free_func = wg_callback_free;
694 plugin_register_write ("write_graphite", wg_write, &user_data);
699 static int wg_config (oconfig_item_t *ci)
703 for (i = 0; i < ci->children_num; i++)
705 oconfig_item_t *child = ci->children + i;
707 if (strcasecmp ("Carbon", child->key) == 0)
708 wg_config_carbon (child);
711 ERROR ("write_graphite plugin: Invalid configuration "
712 "option: %s.", child->key);
719 void module_register (void)
721 plugin_register_complex_config ("write_graphite", wg_config);
724 /* vim: set sw=4 ts=4 sts=4 tw=78 et : */