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_cache.h"
51 #include "utils_complain.h"
52 #include "utils_format_graphite.h"
54 /* Folks without pthread will need to disable this plugin. */
55 #include <pthread.h>
57 #include <sys/socket.h>
58 #include <netdb.h>
60 #define WG_DEFAULT_NODE "localhost"
61 #define WG_DEFAULT_SERVICE "2003"
62 #define WG_DEFAULT_PROTOCOL "tcp"
63 #define WG_DEFAULT_LOG_SEND_ERRORS 1
64 #define WG_DEFAULT_ESCAPE '_'
66 /* Ethernet - (IPv6 + TCP) = 1500 - (40 + 32) = 1428 */
67 #define WG_SEND_BUF_SIZE 1428
69 #define WG_MIN_RECONNECT_INTERVAL TIME_T_TO_CDTIME_T (1)
71 /*
72 * Private variables
73 */
74 struct wg_callback
75 {
76 int sock_fd;
78 char *name;
80 char *node;
81 char *service;
82 char *protocol;
83 _Bool log_send_errors;
84 char *prefix;
85 char *postfix;
86 char escape_char;
88 unsigned int format_flags;
90 char send_buf[WG_SEND_BUF_SIZE];
91 size_t send_buf_free;
92 size_t send_buf_fill;
93 cdtime_t send_buf_init_time;
95 pthread_mutex_t send_lock;
96 c_complain_t init_complaint;
97 cdtime_t last_connect_time;
98 };
101 /*
102 * Functions
103 */
104 static void wg_reset_buffer (struct wg_callback *cb)
105 {
106 memset (cb->send_buf, 0, sizeof (cb->send_buf));
107 cb->send_buf_free = sizeof (cb->send_buf);
108 cb->send_buf_fill = 0;
109 cb->send_buf_init_time = cdtime ();
110 }
112 static int wg_send_buffer (struct wg_callback *cb)
113 {
114 ssize_t status = 0;
116 status = swrite (cb->sock_fd, cb->send_buf, strlen (cb->send_buf));
117 if (status < 0)
118 {
119 const char *protocol = cb->protocol ? cb->protocol : WG_DEFAULT_PROTOCOL;
121 if (cb->log_send_errors)
122 {
123 char errbuf[1024];
124 ERROR ("write_graphite plugin: send to %s:%s (%s) failed with status %zi (%s)",
125 cb->node, cb->service, protocol,
126 status, sstrerror (errno, errbuf, sizeof (errbuf)));
127 }
129 close (cb->sock_fd);
130 cb->sock_fd = -1;
132 return (-1);
133 }
135 return (0);
136 }
138 /* NOTE: You must hold cb->send_lock when calling this function! */
139 static int wg_flush_nolock (cdtime_t timeout, struct wg_callback *cb)
140 {
141 int status;
143 DEBUG ("write_graphite plugin: wg_flush_nolock: timeout = %.3f; "
144 "send_buf_fill = %zu;",
145 (double)timeout,
146 cb->send_buf_fill);
148 /* timeout == 0 => flush unconditionally */
149 if (timeout > 0)
150 {
151 cdtime_t now;
153 now = cdtime ();
154 if ((cb->send_buf_init_time + timeout) > now)
155 return (0);
156 }
158 if (cb->send_buf_fill <= 0)
159 {
160 cb->send_buf_init_time = cdtime ();
161 return (0);
162 }
164 status = wg_send_buffer (cb);
165 wg_reset_buffer (cb);
167 return (status);
168 }
170 static int wg_callback_init (struct wg_callback *cb)
171 {
172 struct addrinfo ai_hints;
173 struct addrinfo *ai_list;
174 struct addrinfo *ai_ptr;
175 cdtime_t now;
176 int status;
178 const char *node = cb->node ? cb->node : WG_DEFAULT_NODE;
179 const char *service = cb->service ? cb->service : WG_DEFAULT_SERVICE;
180 const char *protocol = cb->protocol ? cb->protocol : WG_DEFAULT_PROTOCOL;
182 char connerr[1024] = "";
184 if (cb->sock_fd > 0)
185 return (0);
187 /* Don't try to reconnect too often. By default, one reconnection attempt
188 * is made per second. */
189 now = cdtime ();
190 if ((now - cb->last_connect_time) < WG_MIN_RECONNECT_INTERVAL)
191 return (EAGAIN);
192 cb->last_connect_time = now;
194 memset (&ai_hints, 0, sizeof (ai_hints));
195 #ifdef AI_ADDRCONFIG
196 ai_hints.ai_flags |= AI_ADDRCONFIG;
197 #endif
198 ai_hints.ai_family = AF_UNSPEC;
200 if (0 == strcasecmp ("tcp", protocol))
201 ai_hints.ai_socktype = SOCK_STREAM;
202 else
203 ai_hints.ai_socktype = SOCK_DGRAM;
205 ai_list = NULL;
207 status = getaddrinfo (node, service, &ai_hints, &ai_list);
208 if (status != 0)
209 {
210 ERROR ("write_graphite plugin: getaddrinfo (%s, %s, %s) failed: %s",
211 node, service, protocol, gai_strerror (status));
212 return (-1);
213 }
215 assert (ai_list != NULL);
216 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
217 {
218 cb->sock_fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype,
219 ai_ptr->ai_protocol);
220 if (cb->sock_fd < 0) {
221 char errbuf[1024];
222 snprintf (connerr, sizeof (connerr), "failed to open socket: %s",
223 sstrerror (errno, errbuf, sizeof (errbuf)));
224 continue;
225 }
227 status = connect (cb->sock_fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
228 if (status != 0)
229 {
230 char errbuf[1024];
231 snprintf (connerr, sizeof (connerr), "failed to connect to remote "
232 "host: %s", sstrerror (errno, errbuf, sizeof (errbuf)));
233 close (cb->sock_fd);
234 cb->sock_fd = -1;
235 continue;
236 }
238 break;
239 }
241 freeaddrinfo (ai_list);
243 if (cb->sock_fd < 0)
244 {
245 if (connerr[0] == '\0')
246 /* this should not happen but try to get a message anyway */
247 sstrerror (errno, connerr, sizeof (connerr));
248 c_complain (LOG_ERR, &cb->init_complaint,
249 "write_graphite plugin: Connecting to %s:%s via %s failed. "
250 "The last error was: %s", node, service, protocol, connerr);
251 return (-1);
252 }
253 else
254 {
255 c_release (LOG_INFO, &cb->init_complaint,
256 "write_graphite plugin: Successfully connected to %s:%s via %s.",
257 node, service, protocol);
258 }
260 wg_reset_buffer (cb);
262 return (0);
263 }
265 static void wg_callback_free (void *data)
266 {
267 struct wg_callback *cb;
269 if (data == NULL)
270 return;
272 cb = data;
274 pthread_mutex_lock (&cb->send_lock);
276 wg_flush_nolock (/* timeout = */ 0, cb);
278 if (cb->sock_fd >= 0)
279 {
280 close (cb->sock_fd);
281 cb->sock_fd = -1;
282 }
284 sfree(cb->name);
285 sfree(cb->node);
286 sfree(cb->protocol);
287 sfree(cb->service);
288 sfree(cb->prefix);
289 sfree(cb->postfix);
291 pthread_mutex_destroy (&cb->send_lock);
293 sfree(cb);
294 }
296 static int wg_flush (cdtime_t timeout,
297 const char *identifier __attribute__((unused)),
298 user_data_t *user_data)
299 {
300 struct wg_callback *cb;
301 int status;
303 if (user_data == NULL)
304 return (-EINVAL);
306 cb = user_data->data;
308 pthread_mutex_lock (&cb->send_lock);
310 if (cb->sock_fd < 0)
311 {
312 status = wg_callback_init (cb);
313 if (status != 0)
314 {
315 /* An error message has already been printed. */
316 pthread_mutex_unlock (&cb->send_lock);
317 return (-1);
318 }
319 }
321 status = wg_flush_nolock (timeout, cb);
322 pthread_mutex_unlock (&cb->send_lock);
324 return (status);
325 }
327 static int wg_send_message (char const *message, struct wg_callback *cb)
328 {
329 int status;
330 size_t message_len;
332 message_len = strlen (message);
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 if (message_len >= cb->send_buf_free)
348 {
349 status = wg_flush_nolock (/* timeout = */ 0, cb);
350 if (status != 0)
351 {
352 pthread_mutex_unlock (&cb->send_lock);
353 return (status);
354 }
355 }
357 /* Assert that we have enough space for this message. */
358 assert (message_len < cb->send_buf_free);
360 /* `message_len + 1' because `message_len' does not include the
361 * trailing null byte. Neither does `send_buffer_fill'. */
362 memcpy (cb->send_buf + cb->send_buf_fill,
363 message, message_len + 1);
364 cb->send_buf_fill += message_len;
365 cb->send_buf_free -= message_len;
367 DEBUG ("write_graphite plugin: [%s]:%s (%s) buf %zu/%zu (%.1f %%) \"%s\"",
368 cb->node,
369 cb->service,
370 cb->protocol,
371 cb->send_buf_fill, sizeof (cb->send_buf),
372 100.0 * ((double) cb->send_buf_fill) / ((double) sizeof (cb->send_buf)),
373 message);
375 pthread_mutex_unlock (&cb->send_lock);
377 return (0);
378 }
380 static int wg_write_messages (const data_set_t *ds, const value_list_t *vl,
381 struct wg_callback *cb)
382 {
383 char buffer[WG_SEND_BUF_SIZE];
384 int status;
386 if (0 != strcmp (ds->type, vl->type))
387 {
388 ERROR ("write_graphite plugin: DS type does not match "
389 "value list type");
390 return -1;
391 }
393 memset (buffer, 0, sizeof (buffer));
394 status = format_graphite (buffer, sizeof (buffer), ds, vl,
395 cb->prefix, cb->postfix, cb->escape_char, cb->format_flags);
396 if (status != 0) /* error message has been printed already. */
397 return (status);
399 /* Send the message to graphite */
400 status = wg_send_message (buffer, cb);
401 if (status != 0) /* error message has been printed already. */
402 return (status);
404 return (0);
405 } /* int wg_write_messages */
407 static int wg_write (const data_set_t *ds, const value_list_t *vl,
408 user_data_t *user_data)
409 {
410 struct wg_callback *cb;
411 int status;
413 if (user_data == NULL)
414 return (EINVAL);
416 cb = user_data->data;
418 status = wg_write_messages (ds, vl, cb);
420 return (status);
421 }
423 static int config_set_char (char *dest,
424 oconfig_item_t *ci)
425 {
426 char buffer[4];
427 int status;
429 memset (buffer, 0, sizeof (buffer));
431 status = cf_util_get_string_buffer (ci, buffer, sizeof (buffer));
432 if (status != 0)
433 return (status);
435 if (buffer[0] == 0)
436 {
437 ERROR ("write_graphite plugin: Cannot use an empty string for the "
438 "\"EscapeCharacter\" option.");
439 return (-1);
440 }
442 if (buffer[1] != 0)
443 {
444 WARNING ("write_graphite plugin: Only the first character of the "
445 "\"EscapeCharacter\" option ('%c') will be used.",
446 (int) buffer[0]);
447 }
449 *dest = buffer[0];
451 return (0);
452 }
454 static int wg_config_node (oconfig_item_t *ci)
455 {
456 struct wg_callback *cb;
457 user_data_t user_data;
458 char callback_name[DATA_MAX_NAME_LEN];
459 int i;
460 int status = 0;
462 cb = malloc (sizeof (*cb));
463 if (cb == NULL)
464 {
465 ERROR ("write_graphite plugin: malloc failed.");
466 return (-1);
467 }
468 memset (cb, 0, sizeof (*cb));
469 cb->sock_fd = -1;
470 cb->name = NULL;
471 cb->node = NULL;
472 cb->service = NULL;
473 cb->protocol = NULL;
474 cb->log_send_errors = WG_DEFAULT_LOG_SEND_ERRORS;
475 cb->prefix = NULL;
476 cb->postfix = NULL;
477 cb->escape_char = WG_DEFAULT_ESCAPE;
478 cb->format_flags = GRAPHITE_STORE_RATES;
480 /* FIXME: Legacy configuration syntax. */
481 if (strcasecmp ("Carbon", ci->key) != 0)
482 {
483 status = cf_util_get_string (ci, &cb->name);
484 if (status != 0)
485 {
486 wg_callback_free (cb);
487 return (status);
488 }
489 }
491 pthread_mutex_init (&cb->send_lock, /* attr = */ NULL);
492 C_COMPLAIN_INIT (&cb->init_complaint);
494 for (i = 0; i < ci->children_num; i++)
495 {
496 oconfig_item_t *child = ci->children + i;
498 if (strcasecmp ("Host", child->key) == 0)
499 cf_util_get_string (child, &cb->node);
500 else if (strcasecmp ("Port", child->key) == 0)
501 cf_util_get_service (child, &cb->service);
502 else if (strcasecmp ("Protocol", child->key) == 0)
503 {
504 cf_util_get_string (child, &cb->protocol);
506 if (strcasecmp ("UDP", cb->protocol) != 0 &&
507 strcasecmp ("TCP", cb->protocol) != 0)
508 {
509 ERROR ("write_graphite plugin: Unknown protocol (%s)",
510 cb->protocol);
511 status = -1;
512 }
513 }
514 else if (strcasecmp ("LogSendErrors", child->key) == 0)
515 cf_util_get_boolean (child, &cb->log_send_errors);
516 else if (strcasecmp ("Prefix", child->key) == 0)
517 cf_util_get_string (child, &cb->prefix);
518 else if (strcasecmp ("Postfix", child->key) == 0)
519 cf_util_get_string (child, &cb->postfix);
520 else if (strcasecmp ("StoreRates", child->key) == 0)
521 cf_util_get_flag (child, &cb->format_flags,
522 GRAPHITE_STORE_RATES);
523 else if (strcasecmp ("SeparateInstances", child->key) == 0)
524 cf_util_get_flag (child, &cb->format_flags,
525 GRAPHITE_SEPARATE_INSTANCES);
526 else if (strcasecmp ("AlwaysAppendDS", child->key) == 0)
527 cf_util_get_flag (child, &cb->format_flags,
528 GRAPHITE_ALWAYS_APPEND_DS);
529 else if (strcasecmp ("EscapeCharacter", child->key) == 0)
530 config_set_char (&cb->escape_char, child);
531 else
532 {
533 ERROR ("write_graphite plugin: Invalid configuration "
534 "option: %s.", child->key);
535 status = -1;
536 }
538 if (status != 0)
539 break;
540 }
542 if (status != 0)
543 {
544 wg_callback_free (cb);
545 return (status);
546 }
548 /* FIXME: Legacy configuration syntax. */
549 if (cb->name == NULL)
550 ssnprintf (callback_name, sizeof (callback_name), "write_graphite/%s/%s/%s",
551 cb->node != NULL ? cb->node : WG_DEFAULT_NODE,
552 cb->service != NULL ? cb->service : WG_DEFAULT_SERVICE,
553 cb->protocol != NULL ? cb->protocol : WG_DEFAULT_PROTOCOL);
554 else
555 ssnprintf (callback_name, sizeof (callback_name), "write_graphite/%s",
556 cb->name);
558 memset (&user_data, 0, sizeof (user_data));
559 user_data.data = cb;
560 user_data.free_func = wg_callback_free;
561 plugin_register_write (callback_name, wg_write, &user_data);
563 user_data.free_func = NULL;
564 plugin_register_flush (callback_name, wg_flush, &user_data);
566 return (0);
567 }
569 static int wg_config (oconfig_item_t *ci)
570 {
571 int i;
573 for (i = 0; i < ci->children_num; i++)
574 {
575 oconfig_item_t *child = ci->children + i;
577 if (strcasecmp ("Node", child->key) == 0)
578 wg_config_node (child);
579 /* FIXME: Remove this legacy mode in version 6. */
580 else if (strcasecmp ("Carbon", child->key) == 0)
581 wg_config_node (child);
582 else
583 {
584 ERROR ("write_graphite plugin: Invalid configuration "
585 "option: %s.", child->key);
586 }
587 }
589 return (0);
590 }
592 void module_register (void)
593 {
594 plugin_register_complex_config ("write_graphite", wg_config);
595 }
597 /* vim: set sw=4 ts=4 sts=4 tw=78 et : */