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 status = connect (cb->sock_fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
244 if (status != 0)
245 {
246 char errbuf[1024];
247 snprintf (connerr, sizeof (connerr), "failed to connect to remote "
248 "host: %s", sstrerror (errno, errbuf, sizeof (errbuf)));
249 close (cb->sock_fd);
250 cb->sock_fd = -1;
251 continue;
252 }
254 break;
255 }
257 freeaddrinfo (ai_list);
259 if (cb->sock_fd < 0)
260 {
261 if (connerr[0] == '\0')
262 /* this should not happen but try to get a message anyway */
263 sstrerror (errno, connerr, sizeof (connerr));
264 c_complain (LOG_ERR, &cb->init_complaint,
265 "write_graphite plugin: Connecting to %s:%s via %s failed. "
266 "The last error was: %s", cb->node, cb->service, cb->protocol, connerr);
267 return (-1);
268 }
269 else
270 {
271 c_release (LOG_INFO, &cb->init_complaint,
272 "write_graphite plugin: Successfully connected to %s:%s via %s.",
273 cb->node, cb->service, cb->protocol);
274 }
276 /* wg_force_reconnect_check does not flush the buffer before closing a
277 * sending socket, so only call wg_reset_buffer() if the socket was closed
278 * for a different reason (tracked in cb->reconnect_interval_reached). */
279 if (!cb->reconnect_interval_reached || (cb->send_buf_free == 0))
280 wg_reset_buffer (cb);
281 else
282 cb->reconnect_interval_reached = 0;
284 return (0);
285 }
287 static void wg_callback_free (void *data)
288 {
289 struct wg_callback *cb;
291 if (data == NULL)
292 return;
294 cb = data;
296 pthread_mutex_lock (&cb->send_lock);
298 wg_flush_nolock (/* timeout = */ 0, cb);
300 if (cb->sock_fd >= 0)
301 {
302 close (cb->sock_fd);
303 cb->sock_fd = -1;
304 }
306 sfree(cb->name);
307 sfree(cb->node);
308 sfree(cb->protocol);
309 sfree(cb->service);
310 sfree(cb->prefix);
311 sfree(cb->postfix);
313 pthread_mutex_destroy (&cb->send_lock);
315 sfree(cb);
316 }
318 static int wg_flush (cdtime_t timeout,
319 const char *identifier __attribute__((unused)),
320 user_data_t *user_data)
321 {
322 struct wg_callback *cb;
323 int status;
325 if (user_data == NULL)
326 return (-EINVAL);
328 cb = user_data->data;
330 pthread_mutex_lock (&cb->send_lock);
332 if (cb->sock_fd < 0)
333 {
334 status = wg_callback_init (cb);
335 if (status != 0)
336 {
337 /* An error message has already been printed. */
338 pthread_mutex_unlock (&cb->send_lock);
339 return (-1);
340 }
341 }
343 status = wg_flush_nolock (timeout, cb);
344 pthread_mutex_unlock (&cb->send_lock);
346 return (status);
347 }
349 static int wg_send_message (char const *message, struct wg_callback *cb)
350 {
351 int status;
352 size_t message_len;
354 message_len = strlen (message);
356 pthread_mutex_lock (&cb->send_lock);
358 wg_force_reconnect_check (cb);
360 if (cb->sock_fd < 0)
361 {
362 status = wg_callback_init (cb);
363 if (status != 0)
364 {
365 /* An error message has already been printed. */
366 pthread_mutex_unlock (&cb->send_lock);
367 return (-1);
368 }
369 }
371 if (message_len >= cb->send_buf_free)
372 {
373 status = wg_flush_nolock (/* timeout = */ 0, cb);
374 if (status != 0)
375 {
376 pthread_mutex_unlock (&cb->send_lock);
377 return (status);
378 }
379 }
381 /* Assert that we have enough space for this message. */
382 assert (message_len < cb->send_buf_free);
384 /* `message_len + 1' because `message_len' does not include the
385 * trailing null byte. Neither does `send_buffer_fill'. */
386 memcpy (cb->send_buf + cb->send_buf_fill,
387 message, message_len + 1);
388 cb->send_buf_fill += message_len;
389 cb->send_buf_free -= message_len;
391 DEBUG ("write_graphite plugin: [%s]:%s (%s) buf %zu/%zu (%.1f %%) \"%s\"",
392 cb->node, cb->service, cb->protocol,
393 cb->send_buf_fill, sizeof (cb->send_buf),
394 100.0 * ((double) cb->send_buf_fill) / ((double) sizeof (cb->send_buf)),
395 message);
397 pthread_mutex_unlock (&cb->send_lock);
399 return (0);
400 }
402 static int wg_write_messages (const data_set_t *ds, const value_list_t *vl,
403 struct wg_callback *cb)
404 {
405 char buffer[WG_SEND_BUF_SIZE] = { 0 };
406 int status;
408 if (0 != strcmp (ds->type, vl->type))
409 {
410 ERROR ("write_graphite plugin: DS type does not match "
411 "value list type");
412 return -1;
413 }
415 status = format_graphite (buffer, sizeof (buffer), ds, vl,
416 cb->prefix, cb->postfix, cb->escape_char, cb->format_flags);
417 if (status != 0) /* error message has been printed already. */
418 return (status);
420 /* Send the message to graphite */
421 status = wg_send_message (buffer, cb);
422 if (status != 0) /* error message has been printed already. */
423 return (status);
425 return (0);
426 } /* int wg_write_messages */
428 static int wg_write (const data_set_t *ds, const value_list_t *vl,
429 user_data_t *user_data)
430 {
431 struct wg_callback *cb;
432 int status;
434 if (user_data == NULL)
435 return (EINVAL);
437 cb = user_data->data;
439 status = wg_write_messages (ds, vl, cb);
441 return (status);
442 }
444 static int config_set_char (char *dest,
445 oconfig_item_t *ci)
446 {
447 char buffer[4] = { 0 };
448 int status;
450 status = cf_util_get_string_buffer (ci, buffer, sizeof (buffer));
451 if (status != 0)
452 return (status);
454 if (buffer[0] == 0)
455 {
456 ERROR ("write_graphite plugin: Cannot use an empty string for the "
457 "\"EscapeCharacter\" option.");
458 return (-1);
459 }
461 if (buffer[1] != 0)
462 {
463 WARNING ("write_graphite plugin: Only the first character of the "
464 "\"EscapeCharacter\" option ('%c') will be used.",
465 (int) buffer[0]);
466 }
468 *dest = buffer[0];
470 return (0);
471 }
473 static int wg_config_node (oconfig_item_t *ci)
474 {
475 struct wg_callback *cb;
476 user_data_t user_data = { 0 };
477 char callback_name[DATA_MAX_NAME_LEN];
478 int status = 0;
480 cb = calloc (1, sizeof (*cb));
481 if (cb == NULL)
482 {
483 ERROR ("write_graphite plugin: calloc failed.");
484 return (-1);
485 }
486 cb->sock_fd = -1;
487 cb->name = NULL;
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;
495 cb->prefix = NULL;
496 cb->postfix = NULL;
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)
502 {
503 status = cf_util_get_string (ci, &cb->name);
504 if (status != 0)
505 {
506 wg_callback_free (cb);
507 return (status);
508 }
509 }
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++)
515 {
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)
523 {
524 cf_util_get_string (child, &cb->protocol);
526 if (strcasecmp ("UDP", cb->protocol) != 0 &&
527 strcasecmp ("TCP", cb->protocol) != 0)
528 {
529 ERROR ("write_graphite plugin: Unknown protocol (%s)",
530 cb->protocol);
531 status = -1;
532 }
533 }
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 ("EscapeCharacter", child->key) == 0)
552 config_set_char (&cb->escape_char, child);
553 else
554 {
555 ERROR ("write_graphite plugin: Invalid configuration "
556 "option: %s.", child->key);
557 status = -1;
558 }
560 if (status != 0)
561 break;
562 }
564 if (status != 0)
565 {
566 wg_callback_free (cb);
567 return (status);
568 }
570 /* FIXME: Legacy configuration syntax. */
571 if (cb->name == NULL)
572 ssnprintf (callback_name, sizeof (callback_name), "write_graphite/%s/%s/%s",
573 cb->node, cb->service, cb->protocol);
574 else
575 ssnprintf (callback_name, sizeof (callback_name), "write_graphite/%s",
576 cb->name);
578 user_data.data = cb;
579 user_data.free_func = wg_callback_free;
580 plugin_register_write (callback_name, wg_write, &user_data);
582 user_data.free_func = NULL;
583 plugin_register_flush (callback_name, wg_flush, &user_data);
585 return (0);
586 }
588 static int wg_config (oconfig_item_t *ci)
589 {
590 for (int i = 0; i < ci->children_num; i++)
591 {
592 oconfig_item_t *child = ci->children + i;
594 if (strcasecmp ("Node", child->key) == 0)
595 wg_config_node (child);
596 /* FIXME: Remove this legacy mode in version 6. */
597 else if (strcasecmp ("Carbon", child->key) == 0)
598 wg_config_node (child);
599 else
600 {
601 ERROR ("write_graphite plugin: Invalid configuration "
602 "option: %s.", child->key);
603 }
604 }
606 return (0);
607 }
609 void module_register (void)
610 {
611 plugin_register_complex_config ("write_graphite", wg_config);
612 }
614 /* vim: set sw=4 ts=4 sts=4 tw=78 et : */