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"
47 #include "common.h"
48 #include "plugin.h"
49 #include "configfile.h"
51 #include "utils_complain.h"
52 #include "utils_format_graphite.h"
54 #include <netdb.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)
67 /*
68 * Private variables
69 */
70 struct wg_callback
71 {
72 int sock_fd;
74 char *name;
76 char *node;
77 char *service;
78 char *protocol;
79 _Bool log_send_errors;
80 char *prefix;
81 char *postfix;
82 char escape_char;
84 unsigned int format_flags;
86 char send_buf[WG_SEND_BUF_SIZE];
87 size_t send_buf_free;
88 size_t send_buf_fill;
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;
99 };
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)
104 {
105 cdtime_t now;
107 if (cb->reconnect_interval == 0)
108 return;
110 /* check if address changes if addr_timeout */
111 now = cdtime ();
112 if ((now - cb->last_reconnect_time) < cb->reconnect_interval)
113 return;
115 /* here we should close connection on next */
116 close (cb->sock_fd);
117 cb->sock_fd = -1;
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));
123 }
125 /*
126 * Functions
127 */
128 static void wg_reset_buffer (struct wg_callback *cb)
129 {
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 ();
134 }
136 static int wg_send_buffer (struct wg_callback *cb)
137 {
138 ssize_t status;
140 if (cb->sock_fd < 0)
141 return (-1);
143 status = swrite (cb->sock_fd, cb->send_buf, strlen (cb->send_buf));
144 if (status != 0)
145 {
146 if (cb->log_send_errors)
147 {
148 char errbuf[1024];
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)));
152 }
154 close (cb->sock_fd);
155 cb->sock_fd = -1;
157 return (-1);
158 }
160 return (0);
161 }
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)
165 {
166 int status;
168 DEBUG ("write_graphite plugin: wg_flush_nolock: timeout = %.3f; "
169 "send_buf_fill = %zu;",
170 (double)timeout,
171 cb->send_buf_fill);
173 /* timeout == 0 => flush unconditionally */
174 if (timeout > 0)
175 {
176 cdtime_t now;
178 now = cdtime ();
179 if ((cb->send_buf_init_time + timeout) > now)
180 return (0);
181 }
183 if (cb->send_buf_fill == 0)
184 {
185 cb->send_buf_init_time = cdtime ();
186 return (0);
187 }
189 status = wg_send_buffer (cb);
190 wg_reset_buffer (cb);
192 return (status);
193 }
195 static int wg_callback_init (struct wg_callback *cb)
196 {
197 struct addrinfo ai_hints = { 0 };
198 struct addrinfo *ai_list;
199 struct addrinfo *ai_ptr;
200 cdtime_t now;
201 int status;
203 char connerr[1024] = "";
205 if (cb->sock_fd > 0)
206 return (0);
208 /* Don't try to reconnect too often. By default, one reconnection attempt
209 * is made per second. */
210 now = cdtime ();
211 if ((now - cb->last_connect_time) < WG_MIN_RECONNECT_INTERVAL)
212 return (EAGAIN);
213 cb->last_connect_time = now;
215 #ifdef AI_ADDRCONFIG
216 ai_hints.ai_flags |= AI_ADDRCONFIG;
217 #endif
218 ai_hints.ai_family = AF_UNSPEC;
220 if (0 == strcasecmp ("tcp", cb->protocol))
221 ai_hints.ai_socktype = SOCK_STREAM;
222 else
223 ai_hints.ai_socktype = SOCK_DGRAM;
225 ai_list = NULL;
227 status = getaddrinfo (cb->node, cb->service, &ai_hints, &ai_list);
228 if (status != 0)
229 {
230 ERROR ("write_graphite plugin: getaddrinfo (%s, %s, %s) failed: %s",
231 cb->node, cb->service, cb->protocol, gai_strerror (status));
232 return (-1);
233 }
235 assert (ai_list != NULL);
236 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
237 {
238 cb->sock_fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype,
239 ai_ptr->ai_protocol);
240 if (cb->sock_fd < 0) {
241 char errbuf[1024];
242 snprintf (connerr, sizeof (connerr), "failed to open socket: %s",
243 sstrerror (errno, errbuf, sizeof (errbuf)));
244 continue;
245 }
247 status = connect (cb->sock_fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
248 if (status != 0)
249 {
250 char errbuf[1024];
251 snprintf (connerr, sizeof (connerr), "failed to connect to remote "
252 "host: %s", sstrerror (errno, errbuf, sizeof (errbuf)));
253 close (cb->sock_fd);
254 cb->sock_fd = -1;
255 continue;
256 }
258 break;
259 }
261 freeaddrinfo (ai_list);
263 if (cb->sock_fd < 0)
264 {
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);
271 return (-1);
272 }
273 else
274 {
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);
278 }
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);
285 else
286 cb->reconnect_interval_reached = 0;
288 return (0);
289 }
291 static void wg_callback_free (void *data)
292 {
293 struct wg_callback *cb;
295 if (data == NULL)
296 return;
298 cb = data;
300 pthread_mutex_lock (&cb->send_lock);
302 wg_flush_nolock (/* timeout = */ 0, cb);
304 if (cb->sock_fd >= 0)
305 {
306 close (cb->sock_fd);
307 cb->sock_fd = -1;
308 }
310 sfree(cb->name);
311 sfree(cb->node);
312 sfree(cb->protocol);
313 sfree(cb->service);
314 sfree(cb->prefix);
315 sfree(cb->postfix);
317 pthread_mutex_destroy (&cb->send_lock);
319 sfree(cb);
320 }
322 static int wg_flush (cdtime_t timeout,
323 const char *identifier __attribute__((unused)),
324 user_data_t *user_data)
325 {
326 struct wg_callback *cb;
327 int status;
329 if (user_data == NULL)
330 return (-EINVAL);
332 cb = user_data->data;
334 pthread_mutex_lock (&cb->send_lock);
336 if (cb->sock_fd < 0)
337 {
338 status = wg_callback_init (cb);
339 if (status != 0)
340 {
341 /* An error message has already been printed. */
342 pthread_mutex_unlock (&cb->send_lock);
343 return (-1);
344 }
345 }
347 status = wg_flush_nolock (timeout, cb);
348 pthread_mutex_unlock (&cb->send_lock);
350 return (status);
351 }
353 static int wg_send_message (char const *message, struct wg_callback *cb)
354 {
355 int status;
356 size_t message_len;
358 message_len = strlen (message);
360 pthread_mutex_lock (&cb->send_lock);
362 wg_force_reconnect_check (cb);
364 if (cb->sock_fd < 0)
365 {
366 status = wg_callback_init (cb);
367 if (status != 0)
368 {
369 /* An error message has already been printed. */
370 pthread_mutex_unlock (&cb->send_lock);
371 return (-1);
372 }
373 }
375 if (message_len >= cb->send_buf_free)
376 {
377 status = wg_flush_nolock (/* timeout = */ 0, cb);
378 if (status != 0)
379 {
380 pthread_mutex_unlock (&cb->send_lock);
381 return (status);
382 }
383 }
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)),
399 message);
401 pthread_mutex_unlock (&cb->send_lock);
403 return (0);
404 }
406 static int wg_write_messages (const data_set_t *ds, const value_list_t *vl,
407 struct wg_callback *cb)
408 {
409 char buffer[WG_SEND_BUF_SIZE] = { 0 };
410 int status;
412 if (0 != strcmp (ds->type, vl->type))
413 {
414 ERROR ("write_graphite plugin: DS type does not match "
415 "value list type");
416 return -1;
417 }
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. */
422 return (status);
424 /* Send the message to graphite */
425 status = wg_send_message (buffer, cb);
426 if (status != 0) /* error message has been printed already. */
427 return (status);
429 return (0);
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)
434 {
435 struct wg_callback *cb;
436 int status;
438 if (user_data == NULL)
439 return (EINVAL);
441 cb = user_data->data;
443 status = wg_write_messages (ds, vl, cb);
445 return (status);
446 }
448 static int config_set_char (char *dest,
449 oconfig_item_t *ci)
450 {
451 char buffer[4] = { 0 };
452 int status;
454 status = cf_util_get_string_buffer (ci, buffer, sizeof (buffer));
455 if (status != 0)
456 return (status);
458 if (buffer[0] == 0)
459 {
460 ERROR ("write_graphite plugin: Cannot use an empty string for the "
461 "\"EscapeCharacter\" option.");
462 return (-1);
463 }
465 if (buffer[1] != 0)
466 {
467 WARNING ("write_graphite plugin: Only the first character of the "
468 "\"EscapeCharacter\" option ('%c') will be used.",
469 (int) buffer[0]);
470 }
472 *dest = buffer[0];
474 return (0);
475 }
477 static int wg_config_node (oconfig_item_t *ci)
478 {
479 struct wg_callback *cb;
480 user_data_t user_data = { 0 };
481 char callback_name[DATA_MAX_NAME_LEN];
482 int i;
483 int status = 0;
485 cb = calloc (1, sizeof (*cb));
486 if (cb == NULL)
487 {
488 ERROR ("write_graphite plugin: calloc failed.");
489 return (-1);
490 }
491 cb->sock_fd = -1;
492 cb->name = NULL;
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;
500 cb->prefix = NULL;
501 cb->postfix = NULL;
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)
507 {
508 status = cf_util_get_string (ci, &cb->name);
509 if (status != 0)
510 {
511 wg_callback_free (cb);
512 return (status);
513 }
514 }
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++)
520 {
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)
528 {
529 cf_util_get_string (child, &cb->protocol);
531 if (strcasecmp ("UDP", cb->protocol) != 0 &&
532 strcasecmp ("TCP", cb->protocol) != 0)
533 {
534 ERROR ("write_graphite plugin: Unknown protocol (%s)",
535 cb->protocol);
536 status = -1;
537 }
538 }
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);
558 else
559 {
560 ERROR ("write_graphite plugin: Invalid configuration "
561 "option: %s.", child->key);
562 status = -1;
563 }
565 if (status != 0)
566 break;
567 }
569 if (status != 0)
570 {
571 wg_callback_free (cb);
572 return (status);
573 }
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);
579 else
580 ssnprintf (callback_name, sizeof (callback_name), "write_graphite/%s",
581 cb->name);
583 user_data.data = cb;
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);
590 return (0);
591 }
593 static int wg_config (oconfig_item_t *ci)
594 {
595 int i;
597 for (i = 0; i < ci->children_num; i++)
598 {
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);
606 else
607 {
608 ERROR ("write_graphite plugin: Invalid configuration "
609 "option: %s.", child->key);
610 }
611 }
613 return (0);
614 }
616 void module_register (void)
617 {
618 plugin_register_complex_config ("write_graphite", wg_config);
619 }
621 /* vim: set sw=4 ts=4 sts=4 tw=78 et : */