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
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>
49 #include "configfile.h"
51 #include "utils_complain.h"
52 #include "utils_format_graphite.h"
56 #define WG_DEFAULT_NODE "localhost"
57 #define WG_DEFAULT_SERVICE "2003"
58 #define WG_DEFAULT_PROTOCOL "tcp"
59 #define WG_DEFAULT_LOG_SEND_ERRORS 1
60 #define WG_DEFAULT_ESCAPE '_'
62 /* Ethernet - (IPv6 + TCP) = 1500 - (40 + 32) = 1428 */
63 #define WG_SEND_BUF_SIZE 1428
65 #define WG_MIN_RECONNECT_INTERVAL TIME_T_TO_CDTIME_T (1)
79 _Bool log_send_errors;
84 unsigned int format_flags;
86 char send_buf[WG_SEND_BUF_SIZE];
89 cdtime_t send_buf_init_time;
91 pthread_mutex_t send_lock;
92 c_complain_t init_complaint;
93 cdtime_t last_connect_time;
95 /* Force reconnect useful for load balanced environments */
96 cdtime_t last_reconnect_time;
97 cdtime_t reconnect_interval;
98 _Bool reconnect_interval_reached;
101 /* wg_force_reconnect_check closes cb->sock_fd when it was open for longer
102 * than cb->reconnect_interval. Must hold cb->send_lock when calling. */
103 static void wg_force_reconnect_check (struct wg_callback *cb)
107 if (cb->reconnect_interval == 0)
110 /* check if address changes if addr_timeout */
112 if ((now - cb->last_reconnect_time) < cb->reconnect_interval)
115 /* here we should close connection on next */
118 cb->last_reconnect_time = now;
119 cb->reconnect_interval_reached = 1;
121 INFO ("write_graphite plugin: Connection closed after %.3f seconds.",
122 CDTIME_T_TO_DOUBLE (now - cb->last_reconnect_time));
128 static void wg_reset_buffer (struct wg_callback *cb)
130 memset (cb->send_buf, 0, sizeof (cb->send_buf));
131 cb->send_buf_free = sizeof (cb->send_buf);
132 cb->send_buf_fill = 0;
133 cb->send_buf_init_time = cdtime ();
136 static int wg_send_buffer (struct wg_callback *cb)
143 status = swrite (cb->sock_fd, cb->send_buf, strlen (cb->send_buf));
146 if (cb->log_send_errors)
149 ERROR ("write_graphite plugin: send to %s:%s (%s) failed with status %zi (%s)",
150 cb->node, cb->service, cb->protocol,
151 status, sstrerror (errno, errbuf, sizeof (errbuf)));
163 /* NOTE: You must hold cb->send_lock when calling this function! */
164 static int wg_flush_nolock (cdtime_t timeout, struct wg_callback *cb)
168 DEBUG ("write_graphite plugin: wg_flush_nolock: timeout = %.3f; "
169 "send_buf_fill = %zu;",
173 /* timeout == 0 => flush unconditionally */
179 if ((cb->send_buf_init_time + timeout) > now)
183 if (cb->send_buf_fill == 0)
185 cb->send_buf_init_time = cdtime ();
189 status = wg_send_buffer (cb);
190 wg_reset_buffer (cb);
195 static int wg_callback_init (struct wg_callback *cb)
197 struct addrinfo ai_hints = { 0 };
198 struct addrinfo *ai_list;
199 struct addrinfo *ai_ptr;
203 char connerr[1024] = "";
208 /* Don't try to reconnect too often. By default, one reconnection attempt
209 * is made per second. */
211 if ((now - cb->last_connect_time) < WG_MIN_RECONNECT_INTERVAL)
213 cb->last_connect_time = now;
216 ai_hints.ai_flags |= AI_ADDRCONFIG;
218 ai_hints.ai_family = AF_UNSPEC;
220 if (0 == strcasecmp ("tcp", cb->protocol))
221 ai_hints.ai_socktype = SOCK_STREAM;
223 ai_hints.ai_socktype = SOCK_DGRAM;
227 status = getaddrinfo (cb->node, cb->service, &ai_hints, &ai_list);
230 ERROR ("write_graphite plugin: getaddrinfo (%s, %s, %s) failed: %s",
231 cb->node, cb->service, cb->protocol, gai_strerror (status));
235 assert (ai_list != NULL);
236 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
238 cb->sock_fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype,
239 ai_ptr->ai_protocol);
240 if (cb->sock_fd < 0) {
242 snprintf (connerr, sizeof (connerr), "failed to open socket: %s",
243 sstrerror (errno, errbuf, sizeof (errbuf)));
247 status = connect (cb->sock_fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
251 snprintf (connerr, sizeof (connerr), "failed to connect to remote "
252 "host: %s", sstrerror (errno, errbuf, sizeof (errbuf)));
261 freeaddrinfo (ai_list);
265 if (connerr[0] == '\0')
266 /* this should not happen but try to get a message anyway */
267 sstrerror (errno, connerr, sizeof (connerr));
268 c_complain (LOG_ERR, &cb->init_complaint,
269 "write_graphite plugin: Connecting to %s:%s via %s failed. "
270 "The last error was: %s", cb->node, cb->service, cb->protocol, connerr);
275 c_release (LOG_INFO, &cb->init_complaint,
276 "write_graphite plugin: Successfully connected to %s:%s via %s.",
277 cb->node, cb->service, cb->protocol);
280 /* wg_force_reconnect_check does not flush the buffer before closing a
281 * sending socket, so only call wg_reset_buffer() if the socket was closed
282 * for a different reason (tracked in cb->reconnect_interval_reached). */
283 if (!cb->reconnect_interval_reached || (cb->send_buf_free == 0))
284 wg_reset_buffer (cb);
286 cb->reconnect_interval_reached = 0;
291 static void wg_callback_free (void *data)
293 struct wg_callback *cb;
300 pthread_mutex_lock (&cb->send_lock);
302 wg_flush_nolock (/* timeout = */ 0, cb);
304 if (cb->sock_fd >= 0)
317 pthread_mutex_destroy (&cb->send_lock);
322 static int wg_flush (cdtime_t timeout,
323 const char *identifier __attribute__((unused)),
324 user_data_t *user_data)
326 struct wg_callback *cb;
329 if (user_data == NULL)
332 cb = user_data->data;
334 pthread_mutex_lock (&cb->send_lock);
338 status = wg_callback_init (cb);
341 /* An error message has already been printed. */
342 pthread_mutex_unlock (&cb->send_lock);
347 status = wg_flush_nolock (timeout, cb);
348 pthread_mutex_unlock (&cb->send_lock);
353 static int wg_send_message (char const *message, struct wg_callback *cb)
358 message_len = strlen (message);
360 pthread_mutex_lock (&cb->send_lock);
362 wg_force_reconnect_check (cb);
366 status = wg_callback_init (cb);
369 /* An error message has already been printed. */
370 pthread_mutex_unlock (&cb->send_lock);
375 if (message_len >= cb->send_buf_free)
377 status = wg_flush_nolock (/* timeout = */ 0, cb);
380 pthread_mutex_unlock (&cb->send_lock);
385 /* Assert that we have enough space for this message. */
386 assert (message_len < cb->send_buf_free);
388 /* `message_len + 1' because `message_len' does not include the
389 * trailing null byte. Neither does `send_buffer_fill'. */
390 memcpy (cb->send_buf + cb->send_buf_fill,
391 message, message_len + 1);
392 cb->send_buf_fill += message_len;
393 cb->send_buf_free -= message_len;
395 DEBUG ("write_graphite plugin: [%s]:%s (%s) buf %zu/%zu (%.1f %%) \"%s\"",
396 cb->node, cb->service, cb->protocol,
397 cb->send_buf_fill, sizeof (cb->send_buf),
398 100.0 * ((double) cb->send_buf_fill) / ((double) sizeof (cb->send_buf)),
401 pthread_mutex_unlock (&cb->send_lock);
406 static int wg_write_messages (const data_set_t *ds, const value_list_t *vl,
407 struct wg_callback *cb)
409 char buffer[WG_SEND_BUF_SIZE] = { 0 };
412 if (0 != strcmp (ds->type, vl->type))
414 ERROR ("write_graphite plugin: DS type does not match "
419 status = format_graphite (buffer, sizeof (buffer), ds, vl,
420 cb->prefix, cb->postfix, cb->escape_char, cb->format_flags);
421 if (status != 0) /* error message has been printed already. */
424 /* Send the message to graphite */
425 status = wg_send_message (buffer, cb);
426 if (status != 0) /* error message has been printed already. */
430 } /* int wg_write_messages */
432 static int wg_write (const data_set_t *ds, const value_list_t *vl,
433 user_data_t *user_data)
435 struct wg_callback *cb;
438 if (user_data == NULL)
441 cb = user_data->data;
443 status = wg_write_messages (ds, vl, cb);
448 static int config_set_char (char *dest,
451 char buffer[4] = { 0 };
454 status = cf_util_get_string_buffer (ci, buffer, sizeof (buffer));
460 ERROR ("write_graphite plugin: Cannot use an empty string for the "
461 "\"EscapeCharacter\" option.");
467 WARNING ("write_graphite plugin: Only the first character of the "
468 "\"EscapeCharacter\" option ('%c') will be used.",
477 static int wg_config_node (oconfig_item_t *ci)
479 struct wg_callback *cb;
480 user_data_t user_data = { 0 };
481 char callback_name[DATA_MAX_NAME_LEN];
485 cb = calloc (1, sizeof (*cb));
488 ERROR ("write_graphite plugin: calloc failed.");
493 cb->node = strdup (WG_DEFAULT_NODE);
494 cb->service = strdup (WG_DEFAULT_SERVICE);
495 cb->protocol = strdup (WG_DEFAULT_PROTOCOL);
496 cb->last_reconnect_time = cdtime();
497 cb->reconnect_interval = 0;
498 cb->reconnect_interval_reached = 0;
499 cb->log_send_errors = WG_DEFAULT_LOG_SEND_ERRORS;
502 cb->escape_char = WG_DEFAULT_ESCAPE;
503 cb->format_flags = GRAPHITE_STORE_RATES;
505 /* FIXME: Legacy configuration syntax. */
506 if (strcasecmp ("Carbon", ci->key) != 0)
508 status = cf_util_get_string (ci, &cb->name);
511 wg_callback_free (cb);
516 pthread_mutex_init (&cb->send_lock, /* attr = */ NULL);
517 C_COMPLAIN_INIT (&cb->init_complaint);
519 for (i = 0; i < ci->children_num; i++)
521 oconfig_item_t *child = ci->children + i;
523 if (strcasecmp ("Host", child->key) == 0)
524 cf_util_get_string (child, &cb->node);
525 else if (strcasecmp ("Port", child->key) == 0)
526 cf_util_get_service (child, &cb->service);
527 else if (strcasecmp ("Protocol", child->key) == 0)
529 cf_util_get_string (child, &cb->protocol);
531 if (strcasecmp ("UDP", cb->protocol) != 0 &&
532 strcasecmp ("TCP", cb->protocol) != 0)
534 ERROR ("write_graphite plugin: Unknown protocol (%s)",
539 else if (strcasecmp ("ReconnectInterval", child->key) == 0)
540 cf_util_get_cdtime (child, &cb->reconnect_interval);
541 else if (strcasecmp ("LogSendErrors", child->key) == 0)
542 cf_util_get_boolean (child, &cb->log_send_errors);
543 else if (strcasecmp ("Prefix", child->key) == 0)
544 cf_util_get_string (child, &cb->prefix);
545 else if (strcasecmp ("Postfix", child->key) == 0)
546 cf_util_get_string (child, &cb->postfix);
547 else if (strcasecmp ("StoreRates", child->key) == 0)
548 cf_util_get_flag (child, &cb->format_flags,
549 GRAPHITE_STORE_RATES);
550 else if (strcasecmp ("SeparateInstances", child->key) == 0)
551 cf_util_get_flag (child, &cb->format_flags,
552 GRAPHITE_SEPARATE_INSTANCES);
553 else if (strcasecmp ("AlwaysAppendDS", child->key) == 0)
554 cf_util_get_flag (child, &cb->format_flags,
555 GRAPHITE_ALWAYS_APPEND_DS);
556 else if (strcasecmp ("EscapeCharacter", child->key) == 0)
557 config_set_char (&cb->escape_char, child);
560 ERROR ("write_graphite plugin: Invalid configuration "
561 "option: %s.", child->key);
571 wg_callback_free (cb);
575 /* FIXME: Legacy configuration syntax. */
576 if (cb->name == NULL)
577 ssnprintf (callback_name, sizeof (callback_name), "write_graphite/%s/%s/%s",
578 cb->node, cb->service, cb->protocol);
580 ssnprintf (callback_name, sizeof (callback_name), "write_graphite/%s",
584 user_data.free_func = wg_callback_free;
585 plugin_register_write (callback_name, wg_write, &user_data);
587 user_data.free_func = NULL;
588 plugin_register_flush (callback_name, wg_flush, &user_data);
593 static int wg_config (oconfig_item_t *ci)
597 for (i = 0; i < ci->children_num; i++)
599 oconfig_item_t *child = ci->children + i;
601 if (strcasecmp ("Node", child->key) == 0)
602 wg_config_node (child);
603 /* FIXME: Remove this legacy mode in version 6. */
604 else if (strcasecmp ("Carbon", child->key) == 0)
605 wg_config_node (child);
608 ERROR ("write_graphite plugin: Invalid configuration "
609 "option: %s.", child->key);
616 void module_register (void)
618 plugin_register_complex_config ("write_graphite", wg_config);
621 /* vim: set sw=4 ts=4 sts=4 tw=78 et : */