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>
50 #include "utils_complain.h"
51 #include "utils_format_graphite.h"
55 #define WG_DEFAULT_NODE "localhost"
56 #define WG_DEFAULT_SERVICE "2003"
57 #define WG_DEFAULT_PROTOCOL "tcp"
58 #define WG_DEFAULT_LOG_SEND_ERRORS 1
59 #define WG_DEFAULT_ESCAPE '_'
61 /* Ethernet - (IPv6 + TCP) = 1500 - (40 + 32) = 1428 */
62 #define WG_SEND_BUF_SIZE 1428
64 #define WG_MIN_RECONNECT_INTERVAL TIME_T_TO_CDTIME_T (1)
78 _Bool log_send_errors;
83 unsigned int format_flags;
85 char send_buf[WG_SEND_BUF_SIZE];
88 cdtime_t send_buf_init_time;
90 pthread_mutex_t send_lock;
91 c_complain_t init_complaint;
92 cdtime_t last_connect_time;
94 /* Force reconnect useful for load balanced environments */
95 cdtime_t last_reconnect_time;
96 cdtime_t reconnect_interval;
97 _Bool reconnect_interval_reached;
100 /* wg_force_reconnect_check closes cb->sock_fd when it was open for longer
101 * than cb->reconnect_interval. Must hold cb->send_lock when calling. */
102 static void wg_force_reconnect_check (struct wg_callback *cb)
106 if (cb->reconnect_interval == 0)
109 /* check if address changes if addr_timeout */
111 if ((now - cb->last_reconnect_time) < cb->reconnect_interval)
114 /* here we should close connection on next */
117 cb->last_reconnect_time = now;
118 cb->reconnect_interval_reached = 1;
120 INFO ("write_graphite plugin: Connection closed after %.3f seconds.",
121 CDTIME_T_TO_DOUBLE (now - cb->last_reconnect_time));
127 static void wg_reset_buffer (struct wg_callback *cb)
129 memset (cb->send_buf, 0, sizeof (cb->send_buf));
130 cb->send_buf_free = sizeof (cb->send_buf);
131 cb->send_buf_fill = 0;
132 cb->send_buf_init_time = cdtime ();
135 static int wg_send_buffer (struct wg_callback *cb)
142 status = swrite (cb->sock_fd, cb->send_buf, strlen (cb->send_buf));
145 if (cb->log_send_errors)
148 ERROR ("write_graphite plugin: send to %s:%s (%s) failed with status %zi (%s)",
149 cb->node, cb->service, cb->protocol,
150 status, sstrerror (errno, errbuf, sizeof (errbuf)));
162 /* NOTE: You must hold cb->send_lock when calling this function! */
163 static int wg_flush_nolock (cdtime_t timeout, struct wg_callback *cb)
167 DEBUG ("write_graphite plugin: wg_flush_nolock: timeout = %.3f; "
168 "send_buf_fill = %zu;",
172 /* timeout == 0 => flush unconditionally */
178 if ((cb->send_buf_init_time + timeout) > now)
182 if (cb->send_buf_fill == 0)
184 cb->send_buf_init_time = cdtime ();
188 status = wg_send_buffer (cb);
189 wg_reset_buffer (cb);
194 static int wg_callback_init (struct wg_callback *cb)
196 struct addrinfo *ai_list;
200 char connerr[1024] = "";
205 /* Don't try to reconnect too often. By default, one reconnection attempt
206 * is made per second. */
208 if ((now - cb->last_connect_time) < WG_MIN_RECONNECT_INTERVAL)
210 cb->last_connect_time = now;
212 struct addrinfo ai_hints = {
213 .ai_family = AF_UNSPEC,
214 .ai_flags = AI_ADDRCONFIG
217 if (0 == strcasecmp ("tcp", cb->protocol))
218 ai_hints.ai_socktype = SOCK_STREAM;
220 ai_hints.ai_socktype = SOCK_DGRAM;
222 status = getaddrinfo (cb->node, cb->service, &ai_hints, &ai_list);
225 ERROR ("write_graphite plugin: getaddrinfo (%s, %s, %s) failed: %s",
226 cb->node, cb->service, cb->protocol, gai_strerror (status));
230 assert (ai_list != NULL);
231 for (struct addrinfo *ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
233 cb->sock_fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype,
234 ai_ptr->ai_protocol);
235 if (cb->sock_fd < 0) {
237 snprintf (connerr, sizeof (connerr), "failed to open socket: %s",
238 sstrerror (errno, errbuf, sizeof (errbuf)));
242 set_sock_opts (cb->sock_fd);
244 status = connect (cb->sock_fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
248 snprintf (connerr, sizeof (connerr), "failed to connect to remote "
249 "host: %s", sstrerror (errno, errbuf, sizeof (errbuf)));
258 freeaddrinfo (ai_list);
262 if (connerr[0] == '\0')
263 /* this should not happen but try to get a message anyway */
264 sstrerror (errno, connerr, sizeof (connerr));
265 c_complain (LOG_ERR, &cb->init_complaint,
266 "write_graphite plugin: Connecting to %s:%s via %s failed. "
267 "The last error was: %s", cb->node, cb->service, cb->protocol, connerr);
272 c_release (LOG_INFO, &cb->init_complaint,
273 "write_graphite plugin: Successfully connected to %s:%s via %s.",
274 cb->node, cb->service, cb->protocol);
277 /* wg_force_reconnect_check does not flush the buffer before closing a
278 * sending socket, so only call wg_reset_buffer() if the socket was closed
279 * for a different reason (tracked in cb->reconnect_interval_reached). */
280 if (!cb->reconnect_interval_reached || (cb->send_buf_free == 0))
281 wg_reset_buffer (cb);
283 cb->reconnect_interval_reached = 0;
288 static void wg_callback_free (void *data)
290 struct wg_callback *cb;
297 pthread_mutex_lock (&cb->send_lock);
299 wg_flush_nolock (/* timeout = */ 0, cb);
301 if (cb->sock_fd >= 0)
314 pthread_mutex_destroy (&cb->send_lock);
319 static int wg_flush (cdtime_t timeout,
320 const char *identifier __attribute__((unused)),
321 user_data_t *user_data)
323 struct wg_callback *cb;
326 if (user_data == NULL)
329 cb = user_data->data;
331 pthread_mutex_lock (&cb->send_lock);
335 status = wg_callback_init (cb);
338 /* An error message has already been printed. */
339 pthread_mutex_unlock (&cb->send_lock);
344 status = wg_flush_nolock (timeout, cb);
345 pthread_mutex_unlock (&cb->send_lock);
350 static int wg_send_message (char const *message, struct wg_callback *cb)
355 message_len = strlen (message);
357 pthread_mutex_lock (&cb->send_lock);
359 wg_force_reconnect_check (cb);
363 status = wg_callback_init (cb);
366 /* An error message has already been printed. */
367 pthread_mutex_unlock (&cb->send_lock);
372 if (message_len >= cb->send_buf_free)
374 status = wg_flush_nolock (/* timeout = */ 0, cb);
377 pthread_mutex_unlock (&cb->send_lock);
382 /* Assert that we have enough space for this message. */
383 assert (message_len < cb->send_buf_free);
385 /* `message_len + 1' because `message_len' does not include the
386 * trailing null byte. Neither does `send_buffer_fill'. */
387 memcpy (cb->send_buf + cb->send_buf_fill,
388 message, message_len + 1);
389 cb->send_buf_fill += message_len;
390 cb->send_buf_free -= message_len;
392 DEBUG ("write_graphite plugin: [%s]:%s (%s) buf %zu/%zu (%.1f %%) \"%s\"",
393 cb->node, cb->service, cb->protocol,
394 cb->send_buf_fill, sizeof (cb->send_buf),
395 100.0 * ((double) cb->send_buf_fill) / ((double) sizeof (cb->send_buf)),
398 pthread_mutex_unlock (&cb->send_lock);
403 static int wg_write_messages (const data_set_t *ds, const value_list_t *vl,
404 struct wg_callback *cb)
406 char buffer[WG_SEND_BUF_SIZE] = { 0 };
409 if (0 != strcmp (ds->type, vl->type))
411 ERROR ("write_graphite plugin: DS type does not match "
416 status = format_graphite (buffer, sizeof (buffer), ds, vl,
417 cb->prefix, cb->postfix, cb->escape_char, cb->format_flags);
418 if (status != 0) /* error message has been printed already. */
421 /* Send the message to graphite */
422 status = wg_send_message (buffer, cb);
423 if (status != 0) /* error message has been printed already. */
427 } /* int wg_write_messages */
429 static int wg_write (const data_set_t *ds, const value_list_t *vl,
430 user_data_t *user_data)
432 struct wg_callback *cb;
435 if (user_data == NULL)
438 cb = user_data->data;
440 status = wg_write_messages (ds, vl, cb);
445 static int config_set_char (char *dest,
448 char buffer[4] = { 0 };
451 status = cf_util_get_string_buffer (ci, buffer, sizeof (buffer));
457 ERROR ("write_graphite plugin: Cannot use an empty string for the "
458 "\"EscapeCharacter\" option.");
464 WARNING ("write_graphite plugin: Only the first character of the "
465 "\"EscapeCharacter\" option ('%c') will be used.",
474 static int wg_config_node (oconfig_item_t *ci)
476 struct wg_callback *cb;
477 char callback_name[DATA_MAX_NAME_LEN];
480 cb = calloc (1, sizeof (*cb));
483 ERROR ("write_graphite plugin: calloc failed.");
488 cb->node = strdup (WG_DEFAULT_NODE);
489 cb->service = strdup (WG_DEFAULT_SERVICE);
490 cb->protocol = strdup (WG_DEFAULT_PROTOCOL);
491 cb->last_reconnect_time = cdtime();
492 cb->reconnect_interval = 0;
493 cb->reconnect_interval_reached = 0;
494 cb->log_send_errors = WG_DEFAULT_LOG_SEND_ERRORS;
497 cb->escape_char = WG_DEFAULT_ESCAPE;
498 cb->format_flags = GRAPHITE_STORE_RATES;
500 /* FIXME: Legacy configuration syntax. */
501 if (strcasecmp ("Carbon", ci->key) != 0)
503 status = cf_util_get_string (ci, &cb->name);
506 wg_callback_free (cb);
511 pthread_mutex_init (&cb->send_lock, /* attr = */ NULL);
512 C_COMPLAIN_INIT (&cb->init_complaint);
514 for (int i = 0; i < ci->children_num; i++)
516 oconfig_item_t *child = ci->children + i;
518 if (strcasecmp ("Host", child->key) == 0)
519 cf_util_get_string (child, &cb->node);
520 else if (strcasecmp ("Port", child->key) == 0)
521 cf_util_get_service (child, &cb->service);
522 else if (strcasecmp ("Protocol", child->key) == 0)
524 cf_util_get_string (child, &cb->protocol);
526 if (strcasecmp ("UDP", cb->protocol) != 0 &&
527 strcasecmp ("TCP", cb->protocol) != 0)
529 ERROR ("write_graphite plugin: Unknown protocol (%s)",
534 else if (strcasecmp ("ReconnectInterval", child->key) == 0)
535 cf_util_get_cdtime (child, &cb->reconnect_interval);
536 else if (strcasecmp ("LogSendErrors", child->key) == 0)
537 cf_util_get_boolean (child, &cb->log_send_errors);
538 else if (strcasecmp ("Prefix", child->key) == 0)
539 cf_util_get_string (child, &cb->prefix);
540 else if (strcasecmp ("Postfix", child->key) == 0)
541 cf_util_get_string (child, &cb->postfix);
542 else if (strcasecmp ("StoreRates", child->key) == 0)
543 cf_util_get_flag (child, &cb->format_flags,
544 GRAPHITE_STORE_RATES);
545 else if (strcasecmp ("SeparateInstances", child->key) == 0)
546 cf_util_get_flag (child, &cb->format_flags,
547 GRAPHITE_SEPARATE_INSTANCES);
548 else if (strcasecmp ("AlwaysAppendDS", child->key) == 0)
549 cf_util_get_flag (child, &cb->format_flags,
550 GRAPHITE_ALWAYS_APPEND_DS);
551 else if (strcasecmp ("DropDuplicateFields", child->key) == 0)
552 cf_util_get_flag (child, &cb->format_flags,
553 GRAPHITE_DROP_DUPE_FIELDS);
554 else if (strcasecmp ("EscapeCharacter", child->key) == 0)
555 config_set_char (&cb->escape_char, child);
558 ERROR ("write_graphite plugin: Invalid configuration "
559 "option: %s.", child->key);
569 wg_callback_free (cb);
573 /* FIXME: Legacy configuration syntax. */
574 if (cb->name == NULL)
575 ssnprintf (callback_name, sizeof (callback_name), "write_graphite/%s/%s/%s",
576 cb->node, cb->service, cb->protocol);
578 ssnprintf (callback_name, sizeof (callback_name), "write_graphite/%s",
581 plugin_register_write (callback_name, wg_write,
584 .free_func = wg_callback_free,
587 plugin_register_flush (callback_name, wg_flush, &(user_data_t) { .data = cb });
592 static int wg_config (oconfig_item_t *ci)
594 for (int i = 0; i < ci->children_num; i++)
596 oconfig_item_t *child = ci->children + i;
598 if (strcasecmp ("Node", child->key) == 0)
599 wg_config_node (child);
600 /* FIXME: Remove this legacy mode in version 6. */
601 else if (strcasecmp ("Carbon", child->key) == 0)
602 wg_config_node (child);
605 ERROR ("write_graphite plugin: Invalid configuration "
606 "option: %s.", child->key);
613 void module_register (void)
615 plugin_register_complex_config ("write_graphite", wg_config);
618 /* vim: set sw=4 ts=4 sts=4 tw=78 et : */