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_list;
198 cdtime_t now;
199 int status;
201 char connerr[1024] = "";
203 if (cb->sock_fd > 0)
204 return (0);
206 /* Don't try to reconnect too often. By default, one reconnection attempt
207 * is made per second. */
208 now = cdtime ();
209 if ((now - cb->last_connect_time) < WG_MIN_RECONNECT_INTERVAL)
210 return (EAGAIN);
211 cb->last_connect_time = now;
213 struct addrinfo ai_hints = {
214 .ai_family = AF_UNSPEC,
215 .ai_flags = AI_ADDRCONFIG
216 };
218 if (0 == strcasecmp ("tcp", cb->protocol))
219 ai_hints.ai_socktype = SOCK_STREAM;
220 else
221 ai_hints.ai_socktype = SOCK_DGRAM;
223 status = getaddrinfo (cb->node, cb->service, &ai_hints, &ai_list);
224 if (status != 0)
225 {
226 ERROR ("write_graphite plugin: getaddrinfo (%s, %s, %s) failed: %s",
227 cb->node, cb->service, cb->protocol, gai_strerror (status));
228 return (-1);
229 }
231 assert (ai_list != NULL);
232 for (struct addrinfo *ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
233 {
234 cb->sock_fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype,
235 ai_ptr->ai_protocol);
236 if (cb->sock_fd < 0) {
237 char errbuf[1024];
238 snprintf (connerr, sizeof (connerr), "failed to open socket: %s",
239 sstrerror (errno, errbuf, sizeof (errbuf)));
240 continue;
241 }
243 set_sock_opts (cb->sock_fd);
245 status = connect (cb->sock_fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
246 if (status != 0)
247 {
248 char errbuf[1024];
249 snprintf (connerr, sizeof (connerr), "failed to connect to remote "
250 "host: %s", sstrerror (errno, errbuf, sizeof (errbuf)));
251 close (cb->sock_fd);
252 cb->sock_fd = -1;
253 continue;
254 }
256 break;
257 }
259 freeaddrinfo (ai_list);
261 if (cb->sock_fd < 0)
262 {
263 if (connerr[0] == '\0')
264 /* this should not happen but try to get a message anyway */
265 sstrerror (errno, connerr, sizeof (connerr));
266 c_complain (LOG_ERR, &cb->init_complaint,
267 "write_graphite plugin: Connecting to %s:%s via %s failed. "
268 "The last error was: %s", cb->node, cb->service, cb->protocol, connerr);
269 return (-1);
270 }
271 else
272 {
273 c_release (LOG_INFO, &cb->init_complaint,
274 "write_graphite plugin: Successfully connected to %s:%s via %s.",
275 cb->node, cb->service, cb->protocol);
276 }
278 /* wg_force_reconnect_check does not flush the buffer before closing a
279 * sending socket, so only call wg_reset_buffer() if the socket was closed
280 * for a different reason (tracked in cb->reconnect_interval_reached). */
281 if (!cb->reconnect_interval_reached || (cb->send_buf_free == 0))
282 wg_reset_buffer (cb);
283 else
284 cb->reconnect_interval_reached = 0;
286 return (0);
287 }
289 static void wg_callback_free (void *data)
290 {
291 struct wg_callback *cb;
293 if (data == NULL)
294 return;
296 cb = data;
298 pthread_mutex_lock (&cb->send_lock);
300 wg_flush_nolock (/* timeout = */ 0, cb);
302 if (cb->sock_fd >= 0)
303 {
304 close (cb->sock_fd);
305 cb->sock_fd = -1;
306 }
308 sfree(cb->name);
309 sfree(cb->node);
310 sfree(cb->protocol);
311 sfree(cb->service);
312 sfree(cb->prefix);
313 sfree(cb->postfix);
315 pthread_mutex_destroy (&cb->send_lock);
317 sfree(cb);
318 }
320 static int wg_flush (cdtime_t timeout,
321 const char *identifier __attribute__((unused)),
322 user_data_t *user_data)
323 {
324 struct wg_callback *cb;
325 int status;
327 if (user_data == NULL)
328 return (-EINVAL);
330 cb = user_data->data;
332 pthread_mutex_lock (&cb->send_lock);
334 if (cb->sock_fd < 0)
335 {
336 status = wg_callback_init (cb);
337 if (status != 0)
338 {
339 /* An error message has already been printed. */
340 pthread_mutex_unlock (&cb->send_lock);
341 return (-1);
342 }
343 }
345 status = wg_flush_nolock (timeout, cb);
346 pthread_mutex_unlock (&cb->send_lock);
348 return (status);
349 }
351 static int wg_send_message (char const *message, struct wg_callback *cb)
352 {
353 int status;
354 size_t message_len;
356 message_len = strlen (message);
358 pthread_mutex_lock (&cb->send_lock);
360 wg_force_reconnect_check (cb);
362 if (cb->sock_fd < 0)
363 {
364 status = wg_callback_init (cb);
365 if (status != 0)
366 {
367 /* An error message has already been printed. */
368 pthread_mutex_unlock (&cb->send_lock);
369 return (-1);
370 }
371 }
373 if (message_len >= cb->send_buf_free)
374 {
375 status = wg_flush_nolock (/* timeout = */ 0, cb);
376 if (status != 0)
377 {
378 pthread_mutex_unlock (&cb->send_lock);
379 return (status);
380 }
381 }
383 /* Assert that we have enough space for this message. */
384 assert (message_len < cb->send_buf_free);
386 /* `message_len + 1' because `message_len' does not include the
387 * trailing null byte. Neither does `send_buffer_fill'. */
388 memcpy (cb->send_buf + cb->send_buf_fill,
389 message, message_len + 1);
390 cb->send_buf_fill += message_len;
391 cb->send_buf_free -= message_len;
393 DEBUG ("write_graphite plugin: [%s]:%s (%s) buf %zu/%zu (%.1f %%) \"%s\"",
394 cb->node, cb->service, cb->protocol,
395 cb->send_buf_fill, sizeof (cb->send_buf),
396 100.0 * ((double) cb->send_buf_fill) / ((double) sizeof (cb->send_buf)),
397 message);
399 pthread_mutex_unlock (&cb->send_lock);
401 return (0);
402 }
404 static int wg_write_messages (const data_set_t *ds, const value_list_t *vl,
405 struct wg_callback *cb)
406 {
407 char buffer[WG_SEND_BUF_SIZE] = { 0 };
408 int status;
410 if (0 != strcmp (ds->type, vl->type))
411 {
412 ERROR ("write_graphite plugin: DS type does not match "
413 "value list type");
414 return -1;
415 }
417 status = format_graphite (buffer, sizeof (buffer), ds, vl,
418 cb->prefix, cb->postfix, cb->escape_char, cb->format_flags);
419 if (status != 0) /* error message has been printed already. */
420 return (status);
422 /* Send the message to graphite */
423 status = wg_send_message (buffer, cb);
424 if (status != 0) /* error message has been printed already. */
425 return (status);
427 return (0);
428 } /* int wg_write_messages */
430 static int wg_write (const data_set_t *ds, const value_list_t *vl,
431 user_data_t *user_data)
432 {
433 struct wg_callback *cb;
434 int status;
436 if (user_data == NULL)
437 return (EINVAL);
439 cb = user_data->data;
441 status = wg_write_messages (ds, vl, cb);
443 return (status);
444 }
446 static int config_set_char (char *dest,
447 oconfig_item_t *ci)
448 {
449 char buffer[4] = { 0 };
450 int status;
452 status = cf_util_get_string_buffer (ci, buffer, sizeof (buffer));
453 if (status != 0)
454 return (status);
456 if (buffer[0] == 0)
457 {
458 ERROR ("write_graphite plugin: Cannot use an empty string for the "
459 "\"EscapeCharacter\" option.");
460 return (-1);
461 }
463 if (buffer[1] != 0)
464 {
465 WARNING ("write_graphite plugin: Only the first character of the "
466 "\"EscapeCharacter\" option ('%c') will be used.",
467 (int) buffer[0]);
468 }
470 *dest = buffer[0];
472 return (0);
473 }
475 static int wg_config_node (oconfig_item_t *ci)
476 {
477 struct wg_callback *cb;
478 user_data_t user_data = { 0 };
479 char callback_name[DATA_MAX_NAME_LEN];
480 int status = 0;
482 cb = calloc (1, sizeof (*cb));
483 if (cb == NULL)
484 {
485 ERROR ("write_graphite plugin: calloc failed.");
486 return (-1);
487 }
488 cb->sock_fd = -1;
489 cb->name = NULL;
490 cb->node = strdup (WG_DEFAULT_NODE);
491 cb->service = strdup (WG_DEFAULT_SERVICE);
492 cb->protocol = strdup (WG_DEFAULT_PROTOCOL);
493 cb->last_reconnect_time = cdtime();
494 cb->reconnect_interval = 0;
495 cb->reconnect_interval_reached = 0;
496 cb->log_send_errors = WG_DEFAULT_LOG_SEND_ERRORS;
497 cb->prefix = NULL;
498 cb->postfix = NULL;
499 cb->escape_char = WG_DEFAULT_ESCAPE;
500 cb->format_flags = GRAPHITE_STORE_RATES;
502 /* FIXME: Legacy configuration syntax. */
503 if (strcasecmp ("Carbon", ci->key) != 0)
504 {
505 status = cf_util_get_string (ci, &cb->name);
506 if (status != 0)
507 {
508 wg_callback_free (cb);
509 return (status);
510 }
511 }
513 pthread_mutex_init (&cb->send_lock, /* attr = */ NULL);
514 C_COMPLAIN_INIT (&cb->init_complaint);
516 for (int i = 0; i < ci->children_num; i++)
517 {
518 oconfig_item_t *child = ci->children + i;
520 if (strcasecmp ("Host", child->key) == 0)
521 cf_util_get_string (child, &cb->node);
522 else if (strcasecmp ("Port", child->key) == 0)
523 cf_util_get_service (child, &cb->service);
524 else if (strcasecmp ("Protocol", child->key) == 0)
525 {
526 cf_util_get_string (child, &cb->protocol);
528 if (strcasecmp ("UDP", cb->protocol) != 0 &&
529 strcasecmp ("TCP", cb->protocol) != 0)
530 {
531 ERROR ("write_graphite plugin: Unknown protocol (%s)",
532 cb->protocol);
533 status = -1;
534 }
535 }
536 else if (strcasecmp ("ReconnectInterval", child->key) == 0)
537 cf_util_get_cdtime (child, &cb->reconnect_interval);
538 else if (strcasecmp ("LogSendErrors", child->key) == 0)
539 cf_util_get_boolean (child, &cb->log_send_errors);
540 else if (strcasecmp ("Prefix", child->key) == 0)
541 cf_util_get_string (child, &cb->prefix);
542 else if (strcasecmp ("Postfix", child->key) == 0)
543 cf_util_get_string (child, &cb->postfix);
544 else if (strcasecmp ("StoreRates", child->key) == 0)
545 cf_util_get_flag (child, &cb->format_flags,
546 GRAPHITE_STORE_RATES);
547 else if (strcasecmp ("SeparateInstances", child->key) == 0)
548 cf_util_get_flag (child, &cb->format_flags,
549 GRAPHITE_SEPARATE_INSTANCES);
550 else if (strcasecmp ("AlwaysAppendDS", child->key) == 0)
551 cf_util_get_flag (child, &cb->format_flags,
552 GRAPHITE_ALWAYS_APPEND_DS);
553 else if (strcasecmp ("EscapeCharacter", child->key) == 0)
554 config_set_char (&cb->escape_char, child);
555 else
556 {
557 ERROR ("write_graphite plugin: Invalid configuration "
558 "option: %s.", child->key);
559 status = -1;
560 }
562 if (status != 0)
563 break;
564 }
566 if (status != 0)
567 {
568 wg_callback_free (cb);
569 return (status);
570 }
572 /* FIXME: Legacy configuration syntax. */
573 if (cb->name == NULL)
574 ssnprintf (callback_name, sizeof (callback_name), "write_graphite/%s/%s/%s",
575 cb->node, cb->service, cb->protocol);
576 else
577 ssnprintf (callback_name, sizeof (callback_name), "write_graphite/%s",
578 cb->name);
580 user_data.data = cb;
581 user_data.free_func = wg_callback_free;
582 plugin_register_write (callback_name, wg_write, &user_data);
584 user_data.free_func = NULL;
585 plugin_register_flush (callback_name, wg_flush, &user_data);
587 return (0);
588 }
590 static int wg_config (oconfig_item_t *ci)
591 {
592 for (int i = 0; i < ci->children_num; i++)
593 {
594 oconfig_item_t *child = ci->children + i;
596 if (strcasecmp ("Node", child->key) == 0)
597 wg_config_node (child);
598 /* FIXME: Remove this legacy mode in version 6. */
599 else if (strcasecmp ("Carbon", child->key) == 0)
600 wg_config_node (child);
601 else
602 {
603 ERROR ("write_graphite plugin: Invalid configuration "
604 "option: %s.", child->key);
605 }
606 }
608 return (0);
609 }
611 void module_register (void)
612 {
613 plugin_register_complex_config ("write_graphite", wg_config);
614 }
616 /* vim: set sw=4 ts=4 sts=4 tw=78 et : */