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>
48 #include "configfile.h"
50 #include "utils_cache.h"
51 #include "utils_complain.h"
52 #include "utils_format_graphite.h"
54 /* Folks without pthread will need to disable this plugin. */
59 #define WG_DEFAULT_NODE "localhost"
60 #define WG_DEFAULT_SERVICE "2003"
61 #define WG_DEFAULT_PROTOCOL "tcp"
62 #define WG_DEFAULT_LOG_SEND_ERRORS 1
63 #define WG_DEFAULT_ESCAPE '_'
65 /* Ethernet - (IPv6 + TCP) = 1500 - (40 + 32) = 1428 */
66 #define WG_SEND_BUF_SIZE 1428
68 #define WG_MIN_RECONNECT_INTERVAL TIME_T_TO_CDTIME_T (1)
82 _Bool log_send_errors;
87 unsigned int format_flags;
89 char send_buf[WG_SEND_BUF_SIZE];
92 cdtime_t send_buf_init_time;
94 pthread_mutex_t send_lock;
95 c_complain_t init_complaint;
96 cdtime_t last_connect_time;
98 /* Force reconnect useful for load balanced environments */
99 cdtime_t last_reconnect_time;
100 cdtime_t reconnect_interval;
101 _Bool reconnect_interval_reached;
104 /* wg_force_reconnect_check closes cb->sock_fd when it was open for longer
105 * than cb->reconnect_interval. Must hold cb->send_lock when calling. */
106 static void wg_force_reconnect_check (struct wg_callback *cb)
110 if (cb->reconnect_interval == 0)
113 /* check if address changes if addr_timeout */
115 if ((now - cb->last_reconnect_time) < cb->reconnect_interval)
118 /* here we should close connection on next */
121 cb->last_reconnect_time = now;
122 cb->reconnect_interval_reached = 1;
124 INFO ("write_graphite plugin: Connection closed after %.3f seconds.",
125 CDTIME_T_TO_DOUBLE (now - cb->last_reconnect_time));
131 static void wg_reset_buffer (struct wg_callback *cb)
133 memset (cb->send_buf, 0, sizeof (cb->send_buf));
134 cb->send_buf_free = sizeof (cb->send_buf);
135 cb->send_buf_fill = 0;
136 cb->send_buf_init_time = cdtime ();
139 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;
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;
215 memset (&ai_hints, 0, sizeof (ai_hints));
217 ai_hints.ai_flags |= AI_ADDRCONFIG;
219 ai_hints.ai_family = AF_UNSPEC;
221 if (0 == strcasecmp ("tcp", cb->protocol))
222 ai_hints.ai_socktype = SOCK_STREAM;
224 ai_hints.ai_socktype = SOCK_DGRAM;
228 status = getaddrinfo (cb->node, cb->service, &ai_hints, &ai_list);
231 ERROR ("write_graphite plugin: getaddrinfo (%s, %s, %s) failed: %s",
232 cb->node, cb->service, cb->protocol, gai_strerror (status));
236 assert (ai_list != NULL);
237 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
239 cb->sock_fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype,
240 ai_ptr->ai_protocol);
241 if (cb->sock_fd < 0) {
243 snprintf (connerr, sizeof (connerr), "failed to open socket: %s",
244 sstrerror (errno, errbuf, sizeof (errbuf)));
248 status = connect (cb->sock_fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
252 snprintf (connerr, sizeof (connerr), "failed to connect to remote "
253 "host: %s", sstrerror (errno, errbuf, sizeof (errbuf)));
262 freeaddrinfo (ai_list);
266 if (connerr[0] == '\0')
267 /* this should not happen but try to get a message anyway */
268 sstrerror (errno, connerr, sizeof (connerr));
269 c_complain (LOG_ERR, &cb->init_complaint,
270 "write_graphite plugin: Connecting to %s:%s via %s failed. "
271 "The last error was: %s", cb->node, cb->service, cb->protocol, connerr);
276 c_release (LOG_INFO, &cb->init_complaint,
277 "write_graphite plugin: Successfully connected to %s:%s via %s.",
278 cb->node, cb->service, cb->protocol);
281 /* wg_force_reconnect_check does not flush the buffer before closing a
282 * sending socket, so only call wg_reset_buffer() if the socket was closed
283 * for a different reason (tracked in cb->reconnect_interval_reached). */
284 if (!cb->reconnect_interval_reached || (cb->send_buf_free == 0))
285 wg_reset_buffer (cb);
287 cb->reconnect_interval_reached = 0;
292 static void wg_callback_free (void *data)
294 struct wg_callback *cb;
301 pthread_mutex_lock (&cb->send_lock);
303 wg_flush_nolock (/* timeout = */ 0, cb);
305 if (cb->sock_fd >= 0)
318 pthread_mutex_destroy (&cb->send_lock);
323 static int wg_flush (cdtime_t timeout,
324 const char *identifier __attribute__((unused)),
325 user_data_t *user_data)
327 struct wg_callback *cb;
330 if (user_data == NULL)
333 cb = user_data->data;
335 pthread_mutex_lock (&cb->send_lock);
339 status = wg_callback_init (cb);
342 /* An error message has already been printed. */
343 pthread_mutex_unlock (&cb->send_lock);
348 status = wg_flush_nolock (timeout, cb);
349 pthread_mutex_unlock (&cb->send_lock);
354 static int wg_send_message (char const *message, struct wg_callback *cb)
359 message_len = strlen (message);
361 pthread_mutex_lock (&cb->send_lock);
363 wg_force_reconnect_check (cb);
367 status = wg_callback_init (cb);
370 /* An error message has already been printed. */
371 pthread_mutex_unlock (&cb->send_lock);
376 if (message_len >= cb->send_buf_free)
378 status = wg_flush_nolock (/* timeout = */ 0, cb);
381 pthread_mutex_unlock (&cb->send_lock);
386 /* Assert that we have enough space for this message. */
387 assert (message_len < cb->send_buf_free);
389 /* `message_len + 1' because `message_len' does not include the
390 * trailing null byte. Neither does `send_buffer_fill'. */
391 memcpy (cb->send_buf + cb->send_buf_fill,
392 message, message_len + 1);
393 cb->send_buf_fill += message_len;
394 cb->send_buf_free -= message_len;
396 DEBUG ("write_graphite plugin: [%s]:%s (%s) buf %zu/%zu (%.1f %%) \"%s\"",
397 cb->node, cb->service, cb->protocol,
398 cb->send_buf_fill, sizeof (cb->send_buf),
399 100.0 * ((double) cb->send_buf_fill) / ((double) sizeof (cb->send_buf)),
402 pthread_mutex_unlock (&cb->send_lock);
407 static int wg_write_messages (const data_set_t *ds, const value_list_t *vl,
408 struct wg_callback *cb)
410 char buffer[WG_SEND_BUF_SIZE];
413 if (0 != strcmp (ds->type, vl->type))
415 ERROR ("write_graphite plugin: DS type does not match "
420 memset (buffer, 0, sizeof (buffer));
421 status = format_graphite (buffer, sizeof (buffer), ds, vl,
422 cb->prefix, cb->postfix, cb->escape_char, cb->format_flags);
423 if (status != 0) /* error message has been printed already. */
426 /* Send the message to graphite */
427 status = wg_send_message (buffer, cb);
428 if (status != 0) /* error message has been printed already. */
432 } /* int wg_write_messages */
434 static int wg_write (const data_set_t *ds, const value_list_t *vl,
435 user_data_t *user_data)
437 struct wg_callback *cb;
440 if (user_data == NULL)
443 cb = user_data->data;
445 status = wg_write_messages (ds, vl, cb);
450 static int config_set_char (char *dest,
456 memset (buffer, 0, sizeof (buffer));
458 status = cf_util_get_string_buffer (ci, buffer, sizeof (buffer));
464 ERROR ("write_graphite plugin: Cannot use an empty string for the "
465 "\"EscapeCharacter\" option.");
471 WARNING ("write_graphite plugin: Only the first character of the "
472 "\"EscapeCharacter\" option ('%c') will be used.",
481 static int wg_config_node (oconfig_item_t *ci)
483 struct wg_callback *cb;
484 user_data_t user_data;
485 char callback_name[DATA_MAX_NAME_LEN];
489 cb = calloc (1, sizeof (*cb));
492 ERROR ("write_graphite plugin: calloc failed.");
497 cb->node = strdup (WG_DEFAULT_NODE);
498 cb->service = strdup (WG_DEFAULT_SERVICE);
499 cb->protocol = strdup (WG_DEFAULT_PROTOCOL);
500 cb->last_reconnect_time = cdtime();
501 cb->reconnect_interval = 0;
502 cb->reconnect_interval_reached = 0;
503 cb->log_send_errors = WG_DEFAULT_LOG_SEND_ERRORS;
506 cb->escape_char = WG_DEFAULT_ESCAPE;
507 cb->format_flags = GRAPHITE_STORE_RATES;
509 /* FIXME: Legacy configuration syntax. */
510 if (strcasecmp ("Carbon", ci->key) != 0)
512 status = cf_util_get_string (ci, &cb->name);
515 wg_callback_free (cb);
520 pthread_mutex_init (&cb->send_lock, /* attr = */ NULL);
521 C_COMPLAIN_INIT (&cb->init_complaint);
523 for (i = 0; i < ci->children_num; i++)
525 oconfig_item_t *child = ci->children + i;
527 if (strcasecmp ("Host", child->key) == 0)
528 cf_util_get_string (child, &cb->node);
529 else if (strcasecmp ("Port", child->key) == 0)
530 cf_util_get_service (child, &cb->service);
531 else if (strcasecmp ("Protocol", child->key) == 0)
533 cf_util_get_string (child, &cb->protocol);
535 if (strcasecmp ("UDP", cb->protocol) != 0 &&
536 strcasecmp ("TCP", cb->protocol) != 0)
538 ERROR ("write_graphite plugin: Unknown protocol (%s)",
543 else if (strcasecmp ("ReconnectInterval", child->key) == 0)
544 cf_util_get_cdtime (child, &cb->reconnect_interval);
545 else if (strcasecmp ("LogSendErrors", child->key) == 0)
546 cf_util_get_boolean (child, &cb->log_send_errors);
547 else if (strcasecmp ("Prefix", child->key) == 0)
548 cf_util_get_string (child, &cb->prefix);
549 else if (strcasecmp ("Postfix", child->key) == 0)
550 cf_util_get_string (child, &cb->postfix);
551 else if (strcasecmp ("StoreRates", child->key) == 0)
552 cf_util_get_flag (child, &cb->format_flags,
553 GRAPHITE_STORE_RATES);
554 else if (strcasecmp ("SeparateInstances", child->key) == 0)
555 cf_util_get_flag (child, &cb->format_flags,
556 GRAPHITE_SEPARATE_INSTANCES);
557 else if (strcasecmp ("AlwaysAppendDS", child->key) == 0)
558 cf_util_get_flag (child, &cb->format_flags,
559 GRAPHITE_ALWAYS_APPEND_DS);
560 else if (strcasecmp ("EscapeCharacter", child->key) == 0)
561 config_set_char (&cb->escape_char, child);
564 ERROR ("write_graphite plugin: Invalid configuration "
565 "option: %s.", child->key);
575 wg_callback_free (cb);
579 /* FIXME: Legacy configuration syntax. */
580 if (cb->name == NULL)
581 ssnprintf (callback_name, sizeof (callback_name), "write_graphite/%s/%s/%s",
582 cb->node, cb->service, cb->protocol);
584 ssnprintf (callback_name, sizeof (callback_name), "write_graphite/%s",
587 memset (&user_data, 0, sizeof (user_data));
589 user_data.free_func = wg_callback_free;
590 plugin_register_write (callback_name, wg_write, &user_data);
592 user_data.free_func = NULL;
593 plugin_register_flush (callback_name, wg_flush, &user_data);
598 static int wg_config (oconfig_item_t *ci)
602 for (i = 0; i < ci->children_num; i++)
604 oconfig_item_t *child = ci->children + i;
606 if (strcasecmp ("Node", child->key) == 0)
607 wg_config_node (child);
608 /* FIXME: Remove this legacy mode in version 6. */
609 else if (strcasecmp ("Carbon", child->key) == 0)
610 wg_config_node (child);
613 ERROR ("write_graphite plugin: Invalid configuration "
614 "option: %s.", child->key);
621 void module_register (void)
623 plugin_register_complex_config ("write_graphite", wg_config);
626 /* vim: set sw=4 ts=4 sts=4 tw=78 et : */