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 if (0 == strcasecmp ("udp", protocol))
203 ai_hints.ai_socktype = SOCK_DGRAM;
204 else
205 {
206 ERROR ("write_graphite plugin: unknown protocol (%s)",
207 protocol);
208 return (-1);
209 }
211 ai_list = NULL;
213 status = getaddrinfo (node, service, &ai_hints, &ai_list);
214 if (status != 0)
215 {
216 ERROR ("write_graphite plugin: getaddrinfo (%s, %s, %s) failed: %s",
217 node, service, protocol, gai_strerror (status));
218 return (-1);
219 }
221 assert (ai_list != NULL);
222 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
223 {
224 cb->sock_fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype,
225 ai_ptr->ai_protocol);
226 if (cb->sock_fd < 0)
227 continue;
229 status = connect (cb->sock_fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
230 if (status != 0)
231 {
232 close (cb->sock_fd);
233 cb->sock_fd = -1;
234 continue;
235 }
237 break;
238 }
240 freeaddrinfo (ai_list);
242 if (cb->sock_fd < 0)
243 {
244 char errbuf[1024];
245 c_complain (LOG_ERR, &cb->init_complaint,
246 "write_graphite plugin: Connecting to %s:%s via %s failed. "
247 "The last error was: %s", node, service, protocol,
248 sstrerror (errno, errbuf, sizeof (errbuf)));
249 close (cb->sock_fd);
250 return (-1);
251 }
252 else
253 {
254 c_release (LOG_INFO, &cb->init_complaint,
255 "write_graphite plugin: Successfully connected to %s:%s via %s.",
256 node, service, protocol);
257 }
259 wg_reset_buffer (cb);
261 return (0);
262 }
264 static void wg_callback_free (void *data)
265 {
266 struct wg_callback *cb;
268 if (data == NULL)
269 return;
271 cb = data;
273 pthread_mutex_lock (&cb->send_lock);
275 wg_flush_nolock (/* timeout = */ 0, cb);
277 close(cb->sock_fd);
278 cb->sock_fd = -1;
280 sfree(cb->name);
281 sfree(cb->node);
282 sfree(cb->protocol);
283 sfree(cb->service);
284 sfree(cb->prefix);
285 sfree(cb->postfix);
287 pthread_mutex_destroy (&cb->send_lock);
289 sfree(cb);
290 }
292 static int wg_flush (cdtime_t timeout,
293 const char *identifier __attribute__((unused)),
294 user_data_t *user_data)
295 {
296 struct wg_callback *cb;
297 int status;
299 if (user_data == NULL)
300 return (-EINVAL);
302 cb = user_data->data;
304 pthread_mutex_lock (&cb->send_lock);
306 if (cb->sock_fd < 0)
307 {
308 status = wg_callback_init (cb);
309 if (status != 0)
310 {
311 /* An error message has already been printed. */
312 pthread_mutex_unlock (&cb->send_lock);
313 return (-1);
314 }
315 }
317 status = wg_flush_nolock (timeout, cb);
318 pthread_mutex_unlock (&cb->send_lock);
320 return (status);
321 }
323 static int wg_send_message (char const *message, struct wg_callback *cb)
324 {
325 int status;
326 size_t message_len;
328 message_len = strlen (message);
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 if (message_len >= cb->send_buf_free)
344 {
345 status = wg_flush_nolock (/* timeout = */ 0, cb);
346 if (status != 0)
347 {
348 pthread_mutex_unlock (&cb->send_lock);
349 return (status);
350 }
351 }
353 /* Assert that we have enough space for this message. */
354 assert (message_len < cb->send_buf_free);
356 /* `message_len + 1' because `message_len' does not include the
357 * trailing null byte. Neither does `send_buffer_fill'. */
358 memcpy (cb->send_buf + cb->send_buf_fill,
359 message, message_len + 1);
360 cb->send_buf_fill += message_len;
361 cb->send_buf_free -= message_len;
363 DEBUG ("write_graphite plugin: [%s]:%s (%s) buf %zu/%zu (%.1f %%) \"%s\"",
364 cb->node,
365 cb->service,
366 cb->protocol,
367 cb->send_buf_fill, sizeof (cb->send_buf),
368 100.0 * ((double) cb->send_buf_fill) / ((double) sizeof (cb->send_buf)),
369 message);
371 pthread_mutex_unlock (&cb->send_lock);
373 return (0);
374 }
376 static int wg_write_messages (const data_set_t *ds, const value_list_t *vl,
377 struct wg_callback *cb)
378 {
379 char buffer[WG_SEND_BUF_SIZE];
380 int status;
382 if (0 != strcmp (ds->type, vl->type))
383 {
384 ERROR ("write_graphite plugin: DS type does not match "
385 "value list type");
386 return -1;
387 }
389 memset (buffer, 0, sizeof (buffer));
390 status = format_graphite (buffer, sizeof (buffer), ds, vl,
391 cb->prefix, cb->postfix, cb->escape_char, cb->format_flags);
392 if (status != 0) /* error message has been printed already. */
393 return (status);
395 /* Send the message to graphite */
396 wg_send_message (buffer, cb);
397 if (status != 0)
398 {
399 /* An error message has already been printed. */
400 return (status);
401 }
403 return (0);
404 } /* int wg_write_messages */
406 static int wg_write (const data_set_t *ds, const value_list_t *vl,
407 user_data_t *user_data)
408 {
409 struct wg_callback *cb;
410 int status;
412 if (user_data == NULL)
413 return (EINVAL);
415 cb = user_data->data;
417 status = wg_write_messages (ds, vl, cb);
419 return (status);
420 }
422 static int config_set_char (char *dest,
423 oconfig_item_t *ci)
424 {
425 char buffer[4];
426 int status;
428 memset (buffer, 0, sizeof (buffer));
430 status = cf_util_get_string_buffer (ci, buffer, sizeof (buffer));
431 if (status != 0)
432 return (status);
434 if (buffer[0] == 0)
435 {
436 ERROR ("write_graphite plugin: Cannot use an empty string for the "
437 "\"EscapeCharacter\" option.");
438 return (-1);
439 }
441 if (buffer[1] != 0)
442 {
443 WARNING ("write_graphite plugin: Only the first character of the "
444 "\"EscapeCharacter\" option ('%c') will be used.",
445 (int) buffer[0]);
446 }
448 *dest = buffer[0];
450 return (0);
451 }
453 static int wg_config_node (oconfig_item_t *ci)
454 {
455 struct wg_callback *cb;
456 user_data_t user_data;
457 char callback_name[DATA_MAX_NAME_LEN];
458 int i;
459 int status = 0;
461 cb = malloc (sizeof (*cb));
462 if (cb == NULL)
463 {
464 ERROR ("write_graphite plugin: malloc failed.");
465 return (-1);
466 }
467 memset (cb, 0, sizeof (*cb));
468 cb->sock_fd = -1;
469 cb->name = NULL;
470 cb->node = NULL;
471 cb->service = NULL;
472 cb->protocol = NULL;
473 cb->log_send_errors = WG_DEFAULT_LOG_SEND_ERRORS;
474 cb->prefix = NULL;
475 cb->postfix = NULL;
476 cb->escape_char = WG_DEFAULT_ESCAPE;
477 cb->format_flags = GRAPHITE_STORE_RATES;
479 /* FIXME: Legacy configuration syntax. */
480 if (strcasecmp ("Carbon", ci->key) != 0)
481 {
482 status = cf_util_get_string (ci, &cb->name);
483 if (status != 0)
484 {
485 wg_callback_free (cb);
486 return (status);
487 }
488 }
490 pthread_mutex_init (&cb->send_lock, /* attr = */ NULL);
491 C_COMPLAIN_INIT (&cb->init_complaint);
493 for (i = 0; i < ci->children_num; i++)
494 {
495 oconfig_item_t *child = ci->children + i;
497 if (strcasecmp ("Host", child->key) == 0)
498 cf_util_get_string (child, &cb->node);
499 else if (strcasecmp ("Port", child->key) == 0)
500 cf_util_get_service (child, &cb->service);
501 else if (strcasecmp ("Protocol", child->key) == 0)
502 cf_util_get_string (child, &cb->protocol);
503 else if (strcasecmp ("LogSendErrors", child->key) == 0)
504 cf_util_get_boolean (child, &cb->log_send_errors);
505 else if (strcasecmp ("Prefix", child->key) == 0)
506 cf_util_get_string (child, &cb->prefix);
507 else if (strcasecmp ("Postfix", child->key) == 0)
508 cf_util_get_string (child, &cb->postfix);
509 else if (strcasecmp ("StoreRates", child->key) == 0)
510 cf_util_get_flag (child, &cb->format_flags,
511 GRAPHITE_STORE_RATES);
512 else if (strcasecmp ("SeparateInstances", child->key) == 0)
513 cf_util_get_flag (child, &cb->format_flags,
514 GRAPHITE_SEPARATE_INSTANCES);
515 else if (strcasecmp ("AlwaysAppendDS", child->key) == 0)
516 cf_util_get_flag (child, &cb->format_flags,
517 GRAPHITE_ALWAYS_APPEND_DS);
518 else if (strcasecmp ("EscapeCharacter", child->key) == 0)
519 config_set_char (&cb->escape_char, child);
520 else
521 {
522 ERROR ("write_graphite plugin: Invalid configuration "
523 "option: %s.", child->key);
524 status = -1;
525 }
527 if (status != 0)
528 break;
529 }
531 if (status != 0)
532 {
533 wg_callback_free (cb);
534 return (status);
535 }
537 /* FIXME: Legacy configuration syntax. */
538 if (cb->name == NULL)
539 ssnprintf (callback_name, sizeof (callback_name), "write_graphite/%s/%s/%s",
540 cb->node != NULL ? cb->node : WG_DEFAULT_NODE,
541 cb->service != NULL ? cb->service : WG_DEFAULT_SERVICE,
542 cb->protocol != NULL ? cb->protocol : WG_DEFAULT_PROTOCOL);
543 else
544 ssnprintf (callback_name, sizeof (callback_name), "write_graphite/%s",
545 cb->name);
547 memset (&user_data, 0, sizeof (user_data));
548 user_data.data = cb;
549 user_data.free_func = wg_callback_free;
550 plugin_register_write (callback_name, wg_write, &user_data);
552 user_data.free_func = NULL;
553 plugin_register_flush (callback_name, wg_flush, &user_data);
555 return (0);
556 }
558 static int wg_config (oconfig_item_t *ci)
559 {
560 int i;
562 for (i = 0; i < ci->children_num; i++)
563 {
564 oconfig_item_t *child = ci->children + i;
566 if (strcasecmp ("Node", child->key) == 0)
567 wg_config_node (child);
568 /* FIXME: Remove this legacy mode in version 6. */
569 else if (strcasecmp ("Carbon", child->key) == 0)
570 wg_config_node (child);
571 else
572 {
573 ERROR ("write_graphite plugin: Invalid configuration "
574 "option: %s.", child->key);
575 }
576 }
578 return (0);
579 }
581 void module_register (void)
582 {
583 plugin_register_complex_config ("write_graphite", wg_config);
584 }
586 /* vim: set sw=4 ts=4 sts=4 tw=78 et : */