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_parse_option.h"
53 #include "utils_format_graphite.h"
55 /* Folks without pthread will need to disable this plugin. */
56 #include <pthread.h>
58 #include <sys/socket.h>
59 #include <netdb.h>
61 #ifndef WG_DEFAULT_NODE
62 # define WG_DEFAULT_NODE "localhost"
63 #endif
65 #ifndef WG_DEFAULT_SERVICE
66 # define WG_DEFAULT_SERVICE "2003"
67 #endif
69 #ifndef WG_DEFAULT_PROTOCOL
70 # define WG_DEFAULT_PROTOCOL "udp"
71 #endif
73 #ifndef WG_DEFAULT_LOG_SEND_ERRORS
74 # define WG_DEFAULT_LOG_SEND_ERRORS 1
75 #endif
77 #ifndef WG_DEFAULT_ESCAPE
78 # define WG_DEFAULT_ESCAPE '_'
79 #endif
81 /* Ethernet - (IPv6 + TCP) = 1500 - (40 + 32) = 1428 */
82 #ifndef WG_SEND_BUF_SIZE
83 # define WG_SEND_BUF_SIZE 1428
84 #endif
86 /*
87 * Private variables
88 */
89 struct wg_callback
90 {
91 int sock_fd;
93 char *name;
95 char *node;
96 char *service;
97 char *protocol;
98 _Bool log_send_errors;
99 char *prefix;
100 char *postfix;
101 char escape_char;
103 unsigned int format_flags;
105 char send_buf[WG_SEND_BUF_SIZE];
106 size_t send_buf_free;
107 size_t send_buf_fill;
108 cdtime_t send_buf_init_time;
110 pthread_mutex_t send_lock;
111 c_complain_t init_complaint;
112 };
115 /*
116 * Functions
117 */
118 static void wg_reset_buffer (struct wg_callback *cb)
119 {
120 memset (cb->send_buf, 0, sizeof (cb->send_buf));
121 cb->send_buf_free = sizeof (cb->send_buf);
122 cb->send_buf_fill = 0;
123 cb->send_buf_init_time = cdtime ();
124 }
126 static int wg_send_buffer (struct wg_callback *cb)
127 {
128 ssize_t status = 0;
130 status = swrite (cb->sock_fd, cb->send_buf, strlen (cb->send_buf));
131 if (cb->log_send_errors && status < 0)
132 {
133 char errbuf[1024];
134 ERROR ("write_graphite plugin: send to %s:%s (%s) failed with status %zi (%s)",
135 cb->node, cb->service, cb->protocol,
136 status, sstrerror (errno, errbuf, sizeof (errbuf)));
139 close (cb->sock_fd);
140 cb->sock_fd = -1;
142 return (-1);
143 }
145 return (0);
146 }
148 /* NOTE: You must hold cb->send_lock when calling this function! */
149 static int wg_flush_nolock (cdtime_t timeout, struct wg_callback *cb)
150 {
151 int status;
153 DEBUG ("write_graphite plugin: wg_flush_nolock: timeout = %.3f; "
154 "send_buf_fill = %zu;",
155 (double)timeout,
156 cb->send_buf_fill);
158 /* timeout == 0 => flush unconditionally */
159 if (timeout > 0)
160 {
161 cdtime_t now;
163 now = cdtime ();
164 if ((cb->send_buf_init_time + timeout) > now)
165 return (0);
166 }
168 if (cb->send_buf_fill <= 0)
169 {
170 cb->send_buf_init_time = cdtime ();
171 return (0);
172 }
174 status = wg_send_buffer (cb);
175 wg_reset_buffer (cb);
177 return (status);
178 }
180 static int wg_callback_init (struct wg_callback *cb)
181 {
182 struct addrinfo ai_hints;
183 struct addrinfo *ai_list;
184 struct addrinfo *ai_ptr;
185 int status;
187 const char *node = cb->node ? cb->node : WG_DEFAULT_NODE;
188 const char *service = cb->service ? cb->service : WG_DEFAULT_SERVICE;
189 const char *protocol = cb->protocol ? cb->protocol : WG_DEFAULT_PROTOCOL;
191 if (cb->sock_fd > 0)
192 return (0);
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 continue;
223 status = connect (cb->sock_fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
224 if (status != 0)
225 {
226 close (cb->sock_fd);
227 cb->sock_fd = -1;
228 continue;
229 }
231 break;
232 }
234 freeaddrinfo (ai_list);
236 if (cb->sock_fd < 0)
237 {
238 char errbuf[1024];
239 c_complain (LOG_ERR, &cb->init_complaint,
240 "write_graphite plugin: Connecting to %s:%s via %s failed. "
241 "The last error was: %s", node, service, protocol,
242 sstrerror (errno, errbuf, sizeof (errbuf)));
243 close (cb->sock_fd);
244 return (-1);
245 }
246 else
247 {
248 c_release (LOG_INFO, &cb->init_complaint,
249 "write_graphite plugin: Successfully connected to %s:%s via %s.",
250 node, service, protocol);
251 }
253 wg_reset_buffer (cb);
255 return (0);
256 }
258 static void wg_callback_free (void *data)
259 {
260 struct wg_callback *cb;
262 if (data == NULL)
263 return;
265 cb = data;
267 pthread_mutex_lock (&cb->send_lock);
269 wg_flush_nolock (/* timeout = */ 0, cb);
271 close(cb->sock_fd);
272 cb->sock_fd = -1;
274 sfree(cb->name);
275 sfree(cb->node);
276 sfree(cb->protocol);
277 sfree(cb->service);
278 sfree(cb->prefix);
279 sfree(cb->postfix);
281 pthread_mutex_destroy (&cb->send_lock);
283 sfree(cb);
284 }
286 static int wg_flush (cdtime_t timeout,
287 const char *identifier __attribute__((unused)),
288 user_data_t *user_data)
289 {
290 struct wg_callback *cb;
291 int status;
293 if (user_data == NULL)
294 return (-EINVAL);
296 cb = user_data->data;
298 pthread_mutex_lock (&cb->send_lock);
300 if (cb->sock_fd < 0)
301 {
302 status = wg_callback_init (cb);
303 if (status != 0)
304 {
305 /* An error message has already been printed. */
306 pthread_mutex_unlock (&cb->send_lock);
307 return (-1);
308 }
309 }
311 status = wg_flush_nolock (timeout, cb);
312 pthread_mutex_unlock (&cb->send_lock);
314 return (status);
315 }
317 static int wg_send_message (char const *message, struct wg_callback *cb)
318 {
319 int status;
320 size_t message_len;
322 message_len = strlen (message);
324 pthread_mutex_lock (&cb->send_lock);
326 if (cb->sock_fd < 0)
327 {
328 status = wg_callback_init (cb);
329 if (status != 0)
330 {
331 /* An error message has already been printed. */
332 pthread_mutex_unlock (&cb->send_lock);
333 return (-1);
334 }
335 }
337 if (message_len >= cb->send_buf_free)
338 {
339 status = wg_flush_nolock (/* timeout = */ 0, cb);
340 if (status != 0)
341 {
342 pthread_mutex_unlock (&cb->send_lock);
343 return (status);
344 }
345 }
347 /* Assert that we have enough space for this message. */
348 assert (message_len < cb->send_buf_free);
350 /* `message_len + 1' because `message_len' does not include the
351 * trailing null byte. Neither does `send_buffer_fill'. */
352 memcpy (cb->send_buf + cb->send_buf_fill,
353 message, message_len + 1);
354 cb->send_buf_fill += message_len;
355 cb->send_buf_free -= message_len;
357 DEBUG ("write_graphite plugin: [%s]:%s (%s) buf %zu/%zu (%.1f %%) \"%s\"",
358 cb->node,
359 cb->service,
360 cb->protocol,
361 cb->send_buf_fill, sizeof (cb->send_buf),
362 100.0 * ((double) cb->send_buf_fill) / ((double) sizeof (cb->send_buf)),
363 message);
365 pthread_mutex_unlock (&cb->send_lock);
367 return (0);
368 }
370 static int wg_write_messages (const data_set_t *ds, const value_list_t *vl,
371 struct wg_callback *cb)
372 {
373 char buffer[WG_SEND_BUF_SIZE];
374 int status;
376 if (0 != strcmp (ds->type, vl->type))
377 {
378 ERROR ("write_graphite plugin: DS type does not match "
379 "value list type");
380 return -1;
381 }
383 memset (buffer, 0, sizeof (buffer));
384 status = format_graphite (buffer, sizeof (buffer), ds, vl,
385 cb->prefix, cb->postfix, cb->escape_char, cb->format_flags);
386 if (status != 0) /* error message has been printed already. */
387 return (status);
389 /* Send the message to graphite */
390 wg_send_message (buffer, cb);
391 if (status != 0)
392 {
393 /* An error message has already been printed. */
394 return (status);
395 }
397 return (0);
398 } /* int wg_write_messages */
400 static int wg_write (const data_set_t *ds, const value_list_t *vl,
401 user_data_t *user_data)
402 {
403 struct wg_callback *cb;
404 int status;
406 if (user_data == NULL)
407 return (EINVAL);
409 cb = user_data->data;
411 status = wg_write_messages (ds, vl, cb);
413 return (status);
414 }
416 static int config_set_char (char *dest,
417 oconfig_item_t *ci)
418 {
419 char buffer[4];
420 int status;
422 memset (buffer, 0, sizeof (buffer));
424 status = cf_util_get_string_buffer (ci, buffer, sizeof (buffer));
425 if (status != 0)
426 return (status);
428 if (buffer[0] == 0)
429 {
430 ERROR ("write_graphite plugin: Cannot use an empty string for the "
431 "\"EscapeCharacter\" option.");
432 return (-1);
433 }
435 if (buffer[1] != 0)
436 {
437 WARNING ("write_graphite plugin: Only the first character of the "
438 "\"EscapeCharacter\" option ('%c') will be used.",
439 (int) buffer[0]);
440 }
442 *dest = buffer[0];
444 return (0);
445 }
447 static int wg_config_node (oconfig_item_t *ci)
448 {
449 struct wg_callback *cb;
450 user_data_t user_data;
451 char callback_name[DATA_MAX_NAME_LEN];
452 int i;
453 int status = 0;
455 cb = malloc (sizeof (*cb));
456 if (cb == NULL)
457 {
458 ERROR ("write_graphite plugin: malloc failed.");
459 return (-1);
460 }
461 memset (cb, 0, sizeof (*cb));
462 cb->sock_fd = -1;
463 cb->name = NULL;
464 cb->node = NULL;
465 cb->service = NULL;
466 cb->protocol = NULL;
467 cb->log_send_errors = WG_DEFAULT_LOG_SEND_ERRORS;
468 cb->prefix = NULL;
469 cb->postfix = NULL;
470 cb->escape_char = WG_DEFAULT_ESCAPE;
471 cb->format_flags = GRAPHITE_STORE_RATES;
473 /* FIXME: Legacy configuration syntax. */
474 if (strcasecmp ("Carbon", ci->key) != 0)
475 {
476 status = cf_util_get_string (ci, &cb->name);
477 if (status != 0)
478 {
479 wg_callback_free (cb);
480 return (status);
481 }
482 }
484 pthread_mutex_init (&cb->send_lock, /* attr = */ NULL);
485 C_COMPLAIN_INIT (&cb->init_complaint);
487 for (i = 0; i < ci->children_num; i++)
488 {
489 oconfig_item_t *child = ci->children + i;
491 if (strcasecmp ("Host", child->key) == 0)
492 cf_util_get_string (child, &cb->node);
493 else if (strcasecmp ("Port", child->key) == 0)
494 cf_util_get_service (child, &cb->service);
495 else if (strcasecmp ("Protocol", child->key) == 0)
496 {
497 cf_util_get_string (child, &cb->protocol);
499 if (strcasecmp ("UDP", cb->protocol) != 0 &&
500 strcasecmp ("TCP", cb->protocol) != 0)
501 {
502 ERROR ("write_graphite plugin: Unknown protocol (%s)",
503 cb->protocol);
504 status = -1;
505 }
506 }
507 else if (strcasecmp ("LogSendErrors", child->key) == 0)
508 cf_util_get_boolean (child, &cb->log_send_errors);
509 else if (strcasecmp ("Prefix", child->key) == 0)
510 cf_util_get_string (child, &cb->prefix);
511 else if (strcasecmp ("Postfix", child->key) == 0)
512 cf_util_get_string (child, &cb->postfix);
513 else if (strcasecmp ("StoreRates", child->key) == 0)
514 cf_util_get_flag (child, &cb->format_flags,
515 GRAPHITE_STORE_RATES);
516 else if (strcasecmp ("SeparateInstances", child->key) == 0)
517 cf_util_get_flag (child, &cb->format_flags,
518 GRAPHITE_SEPARATE_INSTANCES);
519 else if (strcasecmp ("AlwaysAppendDS", child->key) == 0)
520 cf_util_get_flag (child, &cb->format_flags,
521 GRAPHITE_ALWAYS_APPEND_DS);
522 else if (strcasecmp ("EscapeCharacter", child->key) == 0)
523 config_set_char (&cb->escape_char, child);
524 else
525 {
526 ERROR ("write_graphite plugin: Invalid configuration "
527 "option: %s.", child->key);
528 status = -1;
529 }
531 if (status != 0)
532 break;
533 }
535 if (status != 0)
536 {
537 wg_callback_free (cb);
538 return (status);
539 }
541 /* FIXME: Legacy configuration syntax. */
542 if (cb->name == NULL)
543 ssnprintf (callback_name, sizeof (callback_name), "write_graphite/%s/%s/%s",
544 cb->node != NULL ? cb->node : WG_DEFAULT_NODE,
545 cb->service != NULL ? cb->service : WG_DEFAULT_SERVICE,
546 cb->protocol != NULL ? cb->protocol : WG_DEFAULT_PROTOCOL);
547 else
548 ssnprintf (callback_name, sizeof (callback_name), "write_graphite/%s",
549 cb->name);
551 memset (&user_data, 0, sizeof (user_data));
552 user_data.data = cb;
553 user_data.free_func = wg_callback_free;
554 plugin_register_write (callback_name, wg_write, &user_data);
556 user_data.free_func = NULL;
557 plugin_register_flush (callback_name, wg_flush, &user_data);
559 return (0);
560 }
562 static int wg_config (oconfig_item_t *ci)
563 {
564 int i;
566 for (i = 0; i < ci->children_num; i++)
567 {
568 oconfig_item_t *child = ci->children + i;
570 if (strcasecmp ("Node", child->key) == 0)
571 wg_config_node (child);
572 /* FIXME: Remove this legacy mode in version 6. */
573 else if (strcasecmp ("Carbon", child->key) == 0)
574 wg_config_node (child);
575 else
576 {
577 ERROR ("write_graphite plugin: Invalid configuration "
578 "option: %s.", child->key);
579 }
580 }
582 return (0);
583 }
585 void module_register (void)
586 {
587 plugin_register_complex_config ("write_graphite", wg_config);
588 }
590 /* vim: set sw=4 ts=4 sts=4 tw=78 et : */