1 /**
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
8 *
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.
12 *
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.
17 *
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
21 *
22 * Authors:
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>
28 *
29 * Based on the write_http plugin.
30 **/
32 /* write_graphite plugin configuation example
33 *
34 * <Plugin write_graphite>
35 * <Carbon>
36 * Host "localhost"
37 * Port "2003"
38 * Protocol "udp"
39 * LogSendErrors true
40 * Prefix "collectd"
41 * </Carbon>
42 * </Plugin>
43 */
45 #include "collectd.h"
46 #include "common.h"
47 #include "plugin.h"
48 #include "configfile.h"
50 #include "utils_complain.h"
51 #include "utils_format_graphite.h"
53 #include <netdb.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)
66 /*
67 * Private variables
68 */
69 struct wg_callback
70 {
71 int sock_fd;
73 char *name;
75 char *node;
76 char *service;
77 char *protocol;
78 _Bool log_send_errors;
79 char *prefix;
80 char *postfix;
81 char escape_char;
83 unsigned int format_flags;
85 char send_buf[WG_SEND_BUF_SIZE];
86 size_t send_buf_free;
87 size_t send_buf_fill;
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;
98 };
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)
103 {
104 cdtime_t now;
106 if (cb->reconnect_interval == 0)
107 return;
109 /* check if address changes if addr_timeout */
110 now = cdtime ();
111 if ((now - cb->last_reconnect_time) < cb->reconnect_interval)
112 return;
114 /* here we should close connection on next */
115 close (cb->sock_fd);
116 cb->sock_fd = -1;
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));
122 }
124 /*
125 * Functions
126 */
127 static void wg_reset_buffer (struct wg_callback *cb)
128 {
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 ();
133 }
135 static int wg_send_buffer (struct wg_callback *cb)
136 {
137 ssize_t status;
139 if (cb->sock_fd < 0)
140 return (-1);
142 status = swrite (cb->sock_fd, cb->send_buf, strlen (cb->send_buf));
143 if (status != 0)
144 {
145 if (cb->log_send_errors)
146 {
147 char errbuf[1024];
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)));
151 }
153 close (cb->sock_fd);
154 cb->sock_fd = -1;
156 return (-1);
157 }
159 return (0);
160 }
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)
164 {
165 int status;
167 DEBUG ("write_graphite plugin: wg_flush_nolock: timeout = %.3f; "
168 "send_buf_fill = %zu;",
169 (double)timeout,
170 cb->send_buf_fill);
172 /* timeout == 0 => flush unconditionally */
173 if (timeout > 0)
174 {
175 cdtime_t now;
177 now = cdtime ();
178 if ((cb->send_buf_init_time + timeout) > now)
179 return (0);
180 }
182 if (cb->send_buf_fill == 0)
183 {
184 cb->send_buf_init_time = cdtime ();
185 return (0);
186 }
188 status = wg_send_buffer (cb);
189 wg_reset_buffer (cb);
191 return (status);
192 }
194 static int wg_callback_init (struct wg_callback *cb)
195 {
196 struct addrinfo ai_hints = { 0 };
197 struct addrinfo *ai_list;
198 struct addrinfo *ai_ptr;
199 cdtime_t now;
200 int status;
202 char connerr[1024] = "";
204 if (cb->sock_fd > 0)
205 return (0);
207 /* Don't try to reconnect too often. By default, one reconnection attempt
208 * is made per second. */
209 now = cdtime ();
210 if ((now - cb->last_connect_time) < WG_MIN_RECONNECT_INTERVAL)
211 return (EAGAIN);
212 cb->last_connect_time = now;
214 #ifdef AI_ADDRCONFIG
215 ai_hints.ai_flags |= AI_ADDRCONFIG;
216 #endif
217 ai_hints.ai_family = AF_UNSPEC;
219 if (0 == strcasecmp ("tcp", cb->protocol))
220 ai_hints.ai_socktype = SOCK_STREAM;
221 else
222 ai_hints.ai_socktype = SOCK_DGRAM;
224 ai_list = NULL;
226 status = getaddrinfo (cb->node, cb->service, &ai_hints, &ai_list);
227 if (status != 0)
228 {
229 ERROR ("write_graphite plugin: getaddrinfo (%s, %s, %s) failed: %s",
230 cb->node, cb->service, cb->protocol, gai_strerror (status));
231 return (-1);
232 }
234 assert (ai_list != NULL);
235 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
236 {
237 cb->sock_fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype,
238 ai_ptr->ai_protocol);
239 if (cb->sock_fd < 0) {
240 char errbuf[1024];
241 snprintf (connerr, sizeof (connerr), "failed to open socket: %s",
242 sstrerror (errno, errbuf, sizeof (errbuf)));
243 continue;
244 }
246 status = connect (cb->sock_fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
247 if (status != 0)
248 {
249 char errbuf[1024];
250 snprintf (connerr, sizeof (connerr), "failed to connect to remote "
251 "host: %s", sstrerror (errno, errbuf, sizeof (errbuf)));
252 close (cb->sock_fd);
253 cb->sock_fd = -1;
254 continue;
255 }
257 break;
258 }
260 freeaddrinfo (ai_list);
262 if (cb->sock_fd < 0)
263 {
264 if (connerr[0] == '\0')
265 /* this should not happen but try to get a message anyway */
266 sstrerror (errno, connerr, sizeof (connerr));
267 c_complain (LOG_ERR, &cb->init_complaint,
268 "write_graphite plugin: Connecting to %s:%s via %s failed. "
269 "The last error was: %s", cb->node, cb->service, cb->protocol, connerr);
270 return (-1);
271 }
272 else
273 {
274 c_release (LOG_INFO, &cb->init_complaint,
275 "write_graphite plugin: Successfully connected to %s:%s via %s.",
276 cb->node, cb->service, cb->protocol);
277 }
279 /* wg_force_reconnect_check does not flush the buffer before closing a
280 * sending socket, so only call wg_reset_buffer() if the socket was closed
281 * for a different reason (tracked in cb->reconnect_interval_reached). */
282 if (!cb->reconnect_interval_reached || (cb->send_buf_free == 0))
283 wg_reset_buffer (cb);
284 else
285 cb->reconnect_interval_reached = 0;
287 return (0);
288 }
290 static void wg_callback_free (void *data)
291 {
292 struct wg_callback *cb;
294 if (data == NULL)
295 return;
297 cb = data;
299 pthread_mutex_lock (&cb->send_lock);
301 wg_flush_nolock (/* timeout = */ 0, cb);
303 if (cb->sock_fd >= 0)
304 {
305 close (cb->sock_fd);
306 cb->sock_fd = -1;
307 }
309 sfree(cb->name);
310 sfree(cb->node);
311 sfree(cb->protocol);
312 sfree(cb->service);
313 sfree(cb->prefix);
314 sfree(cb->postfix);
316 pthread_mutex_destroy (&cb->send_lock);
318 sfree(cb);
319 }
321 static int wg_flush (cdtime_t timeout,
322 const char *identifier __attribute__((unused)),
323 user_data_t *user_data)
324 {
325 struct wg_callback *cb;
326 int status;
328 if (user_data == NULL)
329 return (-EINVAL);
331 cb = user_data->data;
333 pthread_mutex_lock (&cb->send_lock);
335 if (cb->sock_fd < 0)
336 {
337 status = wg_callback_init (cb);
338 if (status != 0)
339 {
340 /* An error message has already been printed. */
341 pthread_mutex_unlock (&cb->send_lock);
342 return (-1);
343 }
344 }
346 status = wg_flush_nolock (timeout, cb);
347 pthread_mutex_unlock (&cb->send_lock);
349 return (status);
350 }
352 static int wg_send_message (char const *message, struct wg_callback *cb)
353 {
354 int status;
355 size_t message_len;
357 message_len = strlen (message);
359 pthread_mutex_lock (&cb->send_lock);
361 wg_force_reconnect_check (cb);
363 if (cb->sock_fd < 0)
364 {
365 status = wg_callback_init (cb);
366 if (status != 0)
367 {
368 /* An error message has already been printed. */
369 pthread_mutex_unlock (&cb->send_lock);
370 return (-1);
371 }
372 }
374 if (message_len >= cb->send_buf_free)
375 {
376 status = wg_flush_nolock (/* timeout = */ 0, cb);
377 if (status != 0)
378 {
379 pthread_mutex_unlock (&cb->send_lock);
380 return (status);
381 }
382 }
384 /* Assert that we have enough space for this message. */
385 assert (message_len < cb->send_buf_free);
387 /* `message_len + 1' because `message_len' does not include the
388 * trailing null byte. Neither does `send_buffer_fill'. */
389 memcpy (cb->send_buf + cb->send_buf_fill,
390 message, message_len + 1);
391 cb->send_buf_fill += message_len;
392 cb->send_buf_free -= message_len;
394 DEBUG ("write_graphite plugin: [%s]:%s (%s) buf %zu/%zu (%.1f %%) \"%s\"",
395 cb->node, cb->service, cb->protocol,
396 cb->send_buf_fill, sizeof (cb->send_buf),
397 100.0 * ((double) cb->send_buf_fill) / ((double) sizeof (cb->send_buf)),
398 message);
400 pthread_mutex_unlock (&cb->send_lock);
402 return (0);
403 }
405 static int wg_write_messages (const data_set_t *ds, const value_list_t *vl,
406 struct wg_callback *cb)
407 {
408 char buffer[WG_SEND_BUF_SIZE] = { 0 };
409 int status;
411 if (0 != strcmp (ds->type, vl->type))
412 {
413 ERROR ("write_graphite plugin: DS type does not match "
414 "value list type");
415 return -1;
416 }
418 status = format_graphite (buffer, sizeof (buffer), ds, vl,
419 cb->prefix, cb->postfix, cb->escape_char, cb->format_flags);
420 if (status != 0) /* error message has been printed already. */
421 return (status);
423 /* Send the message to graphite */
424 status = wg_send_message (buffer, cb);
425 if (status != 0) /* error message has been printed already. */
426 return (status);
428 return (0);
429 } /* int wg_write_messages */
431 static int wg_write (const data_set_t *ds, const value_list_t *vl,
432 user_data_t *user_data)
433 {
434 struct wg_callback *cb;
435 int status;
437 if (user_data == NULL)
438 return (EINVAL);
440 cb = user_data->data;
442 status = wg_write_messages (ds, vl, cb);
444 return (status);
445 }
447 static int config_set_char (char *dest,
448 oconfig_item_t *ci)
449 {
450 char buffer[4] = { 0 };
451 int status;
453 status = cf_util_get_string_buffer (ci, buffer, sizeof (buffer));
454 if (status != 0)
455 return (status);
457 if (buffer[0] == 0)
458 {
459 ERROR ("write_graphite plugin: Cannot use an empty string for the "
460 "\"EscapeCharacter\" option.");
461 return (-1);
462 }
464 if (buffer[1] != 0)
465 {
466 WARNING ("write_graphite plugin: Only the first character of the "
467 "\"EscapeCharacter\" option ('%c') will be used.",
468 (int) buffer[0]);
469 }
471 *dest = buffer[0];
473 return (0);
474 }
476 static int wg_config_node (oconfig_item_t *ci)
477 {
478 struct wg_callback *cb;
479 user_data_t user_data = { 0 };
480 char callback_name[DATA_MAX_NAME_LEN];
481 int i;
482 int status = 0;
484 cb = calloc (1, sizeof (*cb));
485 if (cb == NULL)
486 {
487 ERROR ("write_graphite plugin: calloc failed.");
488 return (-1);
489 }
490 cb->sock_fd = -1;
491 cb->name = NULL;
492 cb->node = strdup (WG_DEFAULT_NODE);
493 cb->service = strdup (WG_DEFAULT_SERVICE);
494 cb->protocol = strdup (WG_DEFAULT_PROTOCOL);
495 cb->last_reconnect_time = cdtime();
496 cb->reconnect_interval = 0;
497 cb->reconnect_interval_reached = 0;
498 cb->log_send_errors = WG_DEFAULT_LOG_SEND_ERRORS;
499 cb->prefix = NULL;
500 cb->postfix = NULL;
501 cb->escape_char = WG_DEFAULT_ESCAPE;
502 cb->format_flags = GRAPHITE_STORE_RATES;
504 /* FIXME: Legacy configuration syntax. */
505 if (strcasecmp ("Carbon", ci->key) != 0)
506 {
507 status = cf_util_get_string (ci, &cb->name);
508 if (status != 0)
509 {
510 wg_callback_free (cb);
511 return (status);
512 }
513 }
515 pthread_mutex_init (&cb->send_lock, /* attr = */ NULL);
516 C_COMPLAIN_INIT (&cb->init_complaint);
518 for (i = 0; i < ci->children_num; i++)
519 {
520 oconfig_item_t *child = ci->children + i;
522 if (strcasecmp ("Host", child->key) == 0)
523 cf_util_get_string (child, &cb->node);
524 else if (strcasecmp ("Port", child->key) == 0)
525 cf_util_get_service (child, &cb->service);
526 else if (strcasecmp ("Protocol", child->key) == 0)
527 {
528 cf_util_get_string (child, &cb->protocol);
530 if (strcasecmp ("UDP", cb->protocol) != 0 &&
531 strcasecmp ("TCP", cb->protocol) != 0)
532 {
533 ERROR ("write_graphite plugin: Unknown protocol (%s)",
534 cb->protocol);
535 status = -1;
536 }
537 }
538 else if (strcasecmp ("ReconnectInterval", child->key) == 0)
539 cf_util_get_cdtime (child, &cb->reconnect_interval);
540 else if (strcasecmp ("LogSendErrors", child->key) == 0)
541 cf_util_get_boolean (child, &cb->log_send_errors);
542 else if (strcasecmp ("Prefix", child->key) == 0)
543 cf_util_get_string (child, &cb->prefix);
544 else if (strcasecmp ("Postfix", child->key) == 0)
545 cf_util_get_string (child, &cb->postfix);
546 else if (strcasecmp ("StoreRates", child->key) == 0)
547 cf_util_get_flag (child, &cb->format_flags,
548 GRAPHITE_STORE_RATES);
549 else if (strcasecmp ("SeparateInstances", child->key) == 0)
550 cf_util_get_flag (child, &cb->format_flags,
551 GRAPHITE_SEPARATE_INSTANCES);
552 else if (strcasecmp ("AlwaysAppendDS", child->key) == 0)
553 cf_util_get_flag (child, &cb->format_flags,
554 GRAPHITE_ALWAYS_APPEND_DS);
555 else if (strcasecmp ("EscapeCharacter", child->key) == 0)
556 config_set_char (&cb->escape_char, child);
557 else
558 {
559 ERROR ("write_graphite plugin: Invalid configuration "
560 "option: %s.", child->key);
561 status = -1;
562 }
564 if (status != 0)
565 break;
566 }
568 if (status != 0)
569 {
570 wg_callback_free (cb);
571 return (status);
572 }
574 /* FIXME: Legacy configuration syntax. */
575 if (cb->name == NULL)
576 ssnprintf (callback_name, sizeof (callback_name), "write_graphite/%s/%s/%s",
577 cb->node, cb->service, cb->protocol);
578 else
579 ssnprintf (callback_name, sizeof (callback_name), "write_graphite/%s",
580 cb->name);
582 user_data.data = cb;
583 user_data.free_func = wg_callback_free;
584 plugin_register_write (callback_name, wg_write, &user_data);
586 user_data.free_func = NULL;
587 plugin_register_flush (callback_name, wg_flush, &user_data);
589 return (0);
590 }
592 static int wg_config (oconfig_item_t *ci)
593 {
594 int i;
596 for (i = 0; i < ci->children_num; i++)
597 {
598 oconfig_item_t *child = ci->children + i;
600 if (strcasecmp ("Node", child->key) == 0)
601 wg_config_node (child);
602 /* FIXME: Remove this legacy mode in version 6. */
603 else if (strcasecmp ("Carbon", child->key) == 0)
604 wg_config_node (child);
605 else
606 {
607 ERROR ("write_graphite plugin: Invalid configuration "
608 "option: %s.", child->key);
609 }
610 }
612 return (0);
613 }
615 void module_register (void)
616 {
617 plugin_register_complex_config ("write_graphite", wg_config);
618 }
620 /* vim: set sw=4 ts=4 sts=4 tw=78 et : */