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_force_reconnect_time;
100 int force_reconnect_timeout;
101 int conn_forced_closed;
105 * Force Reconnect functions
108 static void wg_force_reconnect_check(struct wg_callback *cb)
111 if(!cb->force_reconnect_timeout) return;
112 //check if address changes if addr_timeout
114 DEBUG("wg_force_reconnect_check: now %ld last: %ld ",CDTIME_T_TO_TIME_T(now),CDTIME_T_TO_TIME_T(cb->last_force_reconnect_time));
115 if ((now - cb->last_force_reconnect_time) < TIME_T_TO_CDTIME_T(cb->force_reconnect_timeout)){
118 //here we should close connection on next
121 INFO("Connection Forced closed after %ld seconds ",CDTIME_T_TO_TIME_T(now - cb->last_force_reconnect_time));
122 cb->last_force_reconnect_time = now;
123 cb->conn_forced_closed=1;
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);
280 if(!cb->conn_forced_closed || cb->send_buf_free== 0)
282 /*when not forced connection*/
283 /*or buffer not initialized -- happens if forceReconnect happens before first connection*/
284 wg_reset_buffer (cb);
287 /*if forced connection don't reset buffer with valid metrics when reconnect*/
288 cb->conn_forced_closed=0;
293 static void wg_callback_free (void *data)
295 struct wg_callback *cb;
302 pthread_mutex_lock (&cb->send_lock);
304 wg_flush_nolock (/* timeout = */ 0, cb);
306 if (cb->sock_fd >= 0)
319 pthread_mutex_destroy (&cb->send_lock);
324 static int wg_flush (cdtime_t timeout,
325 const char *identifier __attribute__((unused)),
326 user_data_t *user_data)
328 struct wg_callback *cb;
331 if (user_data == NULL)
334 cb = user_data->data;
336 pthread_mutex_lock (&cb->send_lock);
340 status = wg_callback_init (cb);
343 /* An error message has already been printed. */
344 pthread_mutex_unlock (&cb->send_lock);
349 status = wg_flush_nolock (timeout, cb);
350 pthread_mutex_unlock (&cb->send_lock);
355 static int wg_send_message (char const *message, struct wg_callback *cb)
360 message_len = strlen (message);
362 pthread_mutex_lock (&cb->send_lock);
364 wg_force_reconnect_check(cb);
368 status = wg_callback_init (cb);
371 /* An error message has already been printed. */
372 pthread_mutex_unlock (&cb->send_lock);
377 if (message_len >= cb->send_buf_free)
379 status = wg_flush_nolock (/* timeout = */ 0, cb);
382 pthread_mutex_unlock (&cb->send_lock);
387 /* Assert that we have enough space for this message. */
388 assert (message_len < cb->send_buf_free);
390 /* `message_len + 1' because `message_len' does not include the
391 * trailing null byte. Neither does `send_buffer_fill'. */
392 memcpy (cb->send_buf + cb->send_buf_fill,
393 message, message_len + 1);
394 cb->send_buf_fill += message_len;
395 cb->send_buf_free -= message_len;
397 DEBUG ("write_graphite plugin: [%s]:%s (%s) buf %zu/%zu (%.1f %%) \"%s\"",
398 cb->node, cb->service, cb->protocol,
399 cb->send_buf_fill, sizeof (cb->send_buf),
400 100.0 * ((double) cb->send_buf_fill) / ((double) sizeof (cb->send_buf)),
403 pthread_mutex_unlock (&cb->send_lock);
408 static int wg_write_messages (const data_set_t *ds, const value_list_t *vl,
409 struct wg_callback *cb)
411 char buffer[WG_SEND_BUF_SIZE];
414 if (0 != strcmp (ds->type, vl->type))
416 ERROR ("write_graphite plugin: DS type does not match "
421 memset (buffer, 0, sizeof (buffer));
422 status = format_graphite (buffer, sizeof (buffer), ds, vl,
423 cb->prefix, cb->postfix, cb->escape_char, cb->format_flags);
424 if (status != 0) /* error message has been printed already. */
427 /* Send the message to graphite */
428 status = wg_send_message (buffer, cb);
429 if (status != 0) /* error message has been printed already. */
433 } /* int wg_write_messages */
435 static int wg_write (const data_set_t *ds, const value_list_t *vl,
436 user_data_t *user_data)
438 struct wg_callback *cb;
441 if (user_data == NULL)
444 cb = user_data->data;
446 status = wg_write_messages (ds, vl, cb);
451 static int config_set_char (char *dest,
457 memset (buffer, 0, sizeof (buffer));
459 status = cf_util_get_string_buffer (ci, buffer, sizeof (buffer));
465 ERROR ("write_graphite plugin: Cannot use an empty string for the "
466 "\"EscapeCharacter\" option.");
472 WARNING ("write_graphite plugin: Only the first character of the "
473 "\"EscapeCharacter\" option ('%c') will be used.",
482 static int wg_config_node (oconfig_item_t *ci)
484 struct wg_callback *cb;
485 user_data_t user_data;
486 char callback_name[DATA_MAX_NAME_LEN];
490 cb = malloc (sizeof (*cb));
493 ERROR ("write_graphite plugin: malloc failed.");
496 memset (cb, 0, sizeof (*cb));
499 cb->node = strdup (WG_DEFAULT_NODE);
500 cb->service = strdup (WG_DEFAULT_SERVICE);
501 cb->protocol = strdup (WG_DEFAULT_PROTOCOL);
502 cb->last_force_reconnect_time=cdtime();
503 cb->force_reconnect_timeout=0;
504 cb->conn_forced_closed=0;
505 cb->log_send_errors = WG_DEFAULT_LOG_SEND_ERRORS;
508 cb->escape_char = WG_DEFAULT_ESCAPE;
509 cb->format_flags = GRAPHITE_STORE_RATES;
511 /* FIXME: Legacy configuration syntax. */
512 if (strcasecmp ("Carbon", ci->key) != 0)
514 status = cf_util_get_string (ci, &cb->name);
517 wg_callback_free (cb);
522 pthread_mutex_init (&cb->send_lock, /* attr = */ NULL);
523 C_COMPLAIN_INIT (&cb->init_complaint);
525 for (i = 0; i < ci->children_num; i++)
527 oconfig_item_t *child = ci->children + i;
529 if (strcasecmp ("Host", child->key) == 0)
530 cf_util_get_string (child, &cb->node);
531 else if (strcasecmp ("Port", child->key) == 0)
532 cf_util_get_service (child, &cb->service);
533 else if (strcasecmp ("Protocol", child->key) == 0)
535 cf_util_get_string (child, &cb->protocol);
537 if (strcasecmp ("UDP", cb->protocol) != 0 &&
538 strcasecmp ("TCP", cb->protocol) != 0)
540 ERROR ("write_graphite plugin: Unknown protocol (%s)",
545 else if (strcasecmp ("ForceReconnectTimeout", child->key) == 0)
546 cf_util_get_int (child,&cb->force_reconnect_timeout);
547 else if (strcasecmp ("LogSendErrors", child->key) == 0)
548 cf_util_get_boolean (child, &cb->log_send_errors);
549 else if (strcasecmp ("Prefix", child->key) == 0)
550 cf_util_get_string (child, &cb->prefix);
551 else if (strcasecmp ("Postfix", child->key) == 0)
552 cf_util_get_string (child, &cb->postfix);
553 else if (strcasecmp ("StoreRates", child->key) == 0)
554 cf_util_get_flag (child, &cb->format_flags,
555 GRAPHITE_STORE_RATES);
556 else if (strcasecmp ("SeparateInstances", child->key) == 0)
557 cf_util_get_flag (child, &cb->format_flags,
558 GRAPHITE_SEPARATE_INSTANCES);
559 else if (strcasecmp ("AlwaysAppendDS", child->key) == 0)
560 cf_util_get_flag (child, &cb->format_flags,
561 GRAPHITE_ALWAYS_APPEND_DS);
562 else if (strcasecmp ("EscapeCharacter", child->key) == 0)
563 config_set_char (&cb->escape_char, child);
566 ERROR ("write_graphite plugin: Invalid configuration "
567 "option: %s.", child->key);
577 wg_callback_free (cb);
581 /* FIXME: Legacy configuration syntax. */
582 if (cb->name == NULL)
583 ssnprintf (callback_name, sizeof (callback_name), "write_graphite/%s/%s/%s",
584 cb->node, cb->service, cb->protocol);
586 ssnprintf (callback_name, sizeof (callback_name), "write_graphite/%s",
589 memset (&user_data, 0, sizeof (user_data));
591 user_data.free_func = wg_callback_free;
592 plugin_register_write (callback_name, wg_write, &user_data);
594 user_data.free_func = NULL;
595 plugin_register_flush (callback_name, wg_flush, &user_data);
600 static int wg_config (oconfig_item_t *ci)
604 for (i = 0; i < ci->children_num; i++)
606 oconfig_item_t *child = ci->children + i;
608 if (strcasecmp ("Node", child->key) == 0)
609 wg_config_node (child);
610 /* FIXME: Remove this legacy mode in version 6. */
611 else if (strcasecmp ("Carbon", child->key) == 0)
612 wg_config_node (child);
615 ERROR ("write_graphite plugin: Invalid configuration "
616 "option: %s.", child->key);
623 void module_register (void)
625 plugin_register_complex_config ("write_graphite", wg_config);
628 /* vim: set sw=4 ts=4 sts=4 tw=78 et : */