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 #ifndef WG_DEFAULT_NODE
61 # define WG_DEFAULT_NODE "localhost"
62 #endif
64 #ifndef WG_DEFAULT_SERVICE
65 # define WG_DEFAULT_SERVICE "2003"
66 #endif
68 #ifndef WG_DEFAULT_PROTOCOL
69 # define WG_DEFAULT_PROTOCOL "tcp"
70 #endif
72 #ifndef WG_DEFAULT_LOG_SEND_ERRORS
73 # define WG_DEFAULT_LOG_SEND_ERRORS 1
74 #endif
76 #ifndef WG_DEFAULT_ESCAPE
77 # define WG_DEFAULT_ESCAPE '_'
78 #endif
80 /* Ethernet - (IPv6 + TCP) = 1500 - (40 + 32) = 1428 */
81 #ifndef WG_SEND_BUF_SIZE
82 # define WG_SEND_BUF_SIZE 1428
83 #endif
85 #ifndef WG_MIN_RECONNECT_INTERVAL
86 # define WG_MIN_RECONNECT_INTERVAL TIME_T_TO_CDTIME_T (1)
87 #endif
89 /*
90 * Private variables
91 */
92 struct wg_callback
93 {
94 int sock_fd;
96 char *name;
98 char *node;
99 char *service;
100 char *protocol;
101 _Bool log_send_errors;
102 char *prefix;
103 char *postfix;
104 char escape_char;
106 unsigned int format_flags;
108 char send_buf[WG_SEND_BUF_SIZE];
109 size_t send_buf_free;
110 size_t send_buf_fill;
111 cdtime_t send_buf_init_time;
113 pthread_mutex_t send_lock;
114 c_complain_t init_complaint;
115 cdtime_t last_connect_time;
116 };
119 /*
120 * Functions
121 */
122 static void wg_reset_buffer (struct wg_callback *cb)
123 {
124 memset (cb->send_buf, 0, sizeof (cb->send_buf));
125 cb->send_buf_free = sizeof (cb->send_buf);
126 cb->send_buf_fill = 0;
127 cb->send_buf_init_time = cdtime ();
128 }
130 static int wg_send_buffer (struct wg_callback *cb)
131 {
132 ssize_t status = 0;
134 status = swrite (cb->sock_fd, cb->send_buf, strlen (cb->send_buf));
135 if (status < 0)
136 {
137 const char *protocol = cb->protocol ? cb->protocol : WG_DEFAULT_PROTOCOL;
139 if (cb->log_send_errors)
140 {
141 char errbuf[1024];
142 ERROR ("write_graphite plugin: send to %s:%s (%s) failed with status %zi (%s)",
143 cb->node, cb->service, protocol,
144 status, sstrerror (errno, errbuf, sizeof (errbuf)));
145 }
147 close (cb->sock_fd);
148 cb->sock_fd = -1;
150 return (-1);
151 }
153 return (0);
154 }
156 /* NOTE: You must hold cb->send_lock when calling this function! */
157 static int wg_flush_nolock (cdtime_t timeout, struct wg_callback *cb)
158 {
159 int status;
161 DEBUG ("write_graphite plugin: wg_flush_nolock: timeout = %.3f; "
162 "send_buf_fill = %zu;",
163 (double)timeout,
164 cb->send_buf_fill);
166 /* timeout == 0 => flush unconditionally */
167 if (timeout > 0)
168 {
169 cdtime_t now;
171 now = cdtime ();
172 if ((cb->send_buf_init_time + timeout) > now)
173 return (0);
174 }
176 if (cb->send_buf_fill <= 0)
177 {
178 cb->send_buf_init_time = cdtime ();
179 return (0);
180 }
182 status = wg_send_buffer (cb);
183 wg_reset_buffer (cb);
185 return (status);
186 }
188 static int wg_callback_init (struct wg_callback *cb)
189 {
190 struct addrinfo ai_hints;
191 struct addrinfo *ai_list;
192 struct addrinfo *ai_ptr;
193 cdtime_t now;
194 int status;
196 const char *node = cb->node ? cb->node : WG_DEFAULT_NODE;
197 const char *service = cb->service ? cb->service : WG_DEFAULT_SERVICE;
198 const char *protocol = cb->protocol ? cb->protocol : WG_DEFAULT_PROTOCOL;
200 if (cb->sock_fd > 0)
201 return (0);
203 /* Don't try to reconnect too often. By default, one reconnection attempt
204 * is made per second. */
205 now = cdtime ();
206 if ((now - cb->last_connect_time) < WG_MIN_RECONNECT_INTERVAL)
207 return (EAGAIN);
208 cb->last_connect_time = now;
210 memset (&ai_hints, 0, sizeof (ai_hints));
211 #ifdef AI_ADDRCONFIG
212 ai_hints.ai_flags |= AI_ADDRCONFIG;
213 #endif
214 ai_hints.ai_family = AF_UNSPEC;
216 if (0 == strcasecmp ("tcp", protocol))
217 ai_hints.ai_socktype = SOCK_STREAM;
218 else
219 ai_hints.ai_socktype = SOCK_DGRAM;
221 ai_list = NULL;
223 status = getaddrinfo (node, service, &ai_hints, &ai_list);
224 if (status != 0)
225 {
226 ERROR ("write_graphite plugin: getaddrinfo (%s, %s, %s) failed: %s",
227 node, service, protocol, gai_strerror (status));
228 return (-1);
229 }
231 assert (ai_list != NULL);
232 for (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 continue;
239 status = connect (cb->sock_fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
240 if (status != 0)
241 {
242 close (cb->sock_fd);
243 cb->sock_fd = -1;
244 continue;
245 }
247 break;
248 }
250 freeaddrinfo (ai_list);
252 if (cb->sock_fd < 0)
253 {
254 char errbuf[1024];
255 c_complain (LOG_ERR, &cb->init_complaint,
256 "write_graphite plugin: Connecting to %s:%s via %s failed. "
257 "The last error was: %s", node, service, protocol,
258 sstrerror (errno, errbuf, sizeof (errbuf)));
259 return (-1);
260 }
261 else
262 {
263 c_release (LOG_INFO, &cb->init_complaint,
264 "write_graphite plugin: Successfully connected to %s:%s via %s.",
265 node, service, protocol);
266 }
268 wg_reset_buffer (cb);
270 return (0);
271 }
273 static void wg_callback_free (void *data)
274 {
275 struct wg_callback *cb;
277 if (data == NULL)
278 return;
280 cb = data;
282 pthread_mutex_lock (&cb->send_lock);
284 wg_flush_nolock (/* timeout = */ 0, cb);
286 if (cb->sock_fd >= 0)
287 {
288 close (cb->sock_fd);
289 cb->sock_fd = -1;
290 }
292 sfree(cb->name);
293 sfree(cb->node);
294 sfree(cb->protocol);
295 sfree(cb->service);
296 sfree(cb->prefix);
297 sfree(cb->postfix);
299 pthread_mutex_destroy (&cb->send_lock);
301 sfree(cb);
302 }
304 static int wg_flush (cdtime_t timeout,
305 const char *identifier __attribute__((unused)),
306 user_data_t *user_data)
307 {
308 struct wg_callback *cb;
309 int status;
311 if (user_data == NULL)
312 return (-EINVAL);
314 cb = user_data->data;
316 pthread_mutex_lock (&cb->send_lock);
318 if (cb->sock_fd < 0)
319 {
320 status = wg_callback_init (cb);
321 if (status != 0)
322 {
323 /* An error message has already been printed. */
324 pthread_mutex_unlock (&cb->send_lock);
325 return (-1);
326 }
327 }
329 status = wg_flush_nolock (timeout, cb);
330 pthread_mutex_unlock (&cb->send_lock);
332 return (status);
333 }
335 static int wg_send_message (char const *message, struct wg_callback *cb)
336 {
337 int status;
338 size_t message_len;
340 message_len = strlen (message);
342 pthread_mutex_lock (&cb->send_lock);
344 if (cb->sock_fd < 0)
345 {
346 status = wg_callback_init (cb);
347 if (status != 0)
348 {
349 /* An error message has already been printed. */
350 pthread_mutex_unlock (&cb->send_lock);
351 return (-1);
352 }
353 }
355 if (message_len >= cb->send_buf_free)
356 {
357 status = wg_flush_nolock (/* timeout = */ 0, cb);
358 if (status != 0)
359 {
360 pthread_mutex_unlock (&cb->send_lock);
361 return (status);
362 }
363 }
365 /* Assert that we have enough space for this message. */
366 assert (message_len < cb->send_buf_free);
368 /* `message_len + 1' because `message_len' does not include the
369 * trailing null byte. Neither does `send_buffer_fill'. */
370 memcpy (cb->send_buf + cb->send_buf_fill,
371 message, message_len + 1);
372 cb->send_buf_fill += message_len;
373 cb->send_buf_free -= message_len;
375 DEBUG ("write_graphite plugin: [%s]:%s (%s) buf %zu/%zu (%.1f %%) \"%s\"",
376 cb->node,
377 cb->service,
378 cb->protocol,
379 cb->send_buf_fill, sizeof (cb->send_buf),
380 100.0 * ((double) cb->send_buf_fill) / ((double) sizeof (cb->send_buf)),
381 message);
383 pthread_mutex_unlock (&cb->send_lock);
385 return (0);
386 }
388 static int wg_write_messages (const data_set_t *ds, const value_list_t *vl,
389 struct wg_callback *cb)
390 {
391 char buffer[WG_SEND_BUF_SIZE];
392 int status;
394 if (0 != strcmp (ds->type, vl->type))
395 {
396 ERROR ("write_graphite plugin: DS type does not match "
397 "value list type");
398 return -1;
399 }
401 memset (buffer, 0, sizeof (buffer));
402 status = format_graphite (buffer, sizeof (buffer), ds, vl,
403 cb->prefix, cb->postfix, cb->escape_char, cb->format_flags);
404 if (status != 0) /* error message has been printed already. */
405 return (status);
407 /* Send the message to graphite */
408 status = wg_send_message (buffer, cb);
409 if (status != 0) /* error message has been printed already. */
410 return (status);
412 return (0);
413 } /* int wg_write_messages */
415 static int wg_write (const data_set_t *ds, const value_list_t *vl,
416 user_data_t *user_data)
417 {
418 struct wg_callback *cb;
419 int status;
421 if (user_data == NULL)
422 return (EINVAL);
424 cb = user_data->data;
426 status = wg_write_messages (ds, vl, cb);
428 return (status);
429 }
431 static int config_set_char (char *dest,
432 oconfig_item_t *ci)
433 {
434 char buffer[4];
435 int status;
437 memset (buffer, 0, sizeof (buffer));
439 status = cf_util_get_string_buffer (ci, buffer, sizeof (buffer));
440 if (status != 0)
441 return (status);
443 if (buffer[0] == 0)
444 {
445 ERROR ("write_graphite plugin: Cannot use an empty string for the "
446 "\"EscapeCharacter\" option.");
447 return (-1);
448 }
450 if (buffer[1] != 0)
451 {
452 WARNING ("write_graphite plugin: Only the first character of the "
453 "\"EscapeCharacter\" option ('%c') will be used.",
454 (int) buffer[0]);
455 }
457 *dest = buffer[0];
459 return (0);
460 }
462 static int wg_config_node (oconfig_item_t *ci)
463 {
464 struct wg_callback *cb;
465 user_data_t user_data;
466 char callback_name[DATA_MAX_NAME_LEN];
467 int i;
468 int status = 0;
470 cb = malloc (sizeof (*cb));
471 if (cb == NULL)
472 {
473 ERROR ("write_graphite plugin: malloc failed.");
474 return (-1);
475 }
476 memset (cb, 0, sizeof (*cb));
477 cb->sock_fd = -1;
478 cb->name = NULL;
479 cb->node = NULL;
480 cb->service = NULL;
481 cb->protocol = NULL;
482 cb->log_send_errors = WG_DEFAULT_LOG_SEND_ERRORS;
483 cb->prefix = NULL;
484 cb->postfix = NULL;
485 cb->escape_char = WG_DEFAULT_ESCAPE;
486 cb->format_flags = GRAPHITE_STORE_RATES;
488 /* FIXME: Legacy configuration syntax. */
489 if (strcasecmp ("Carbon", ci->key) != 0)
490 {
491 status = cf_util_get_string (ci, &cb->name);
492 if (status != 0)
493 {
494 wg_callback_free (cb);
495 return (status);
496 }
497 }
499 pthread_mutex_init (&cb->send_lock, /* attr = */ NULL);
500 C_COMPLAIN_INIT (&cb->init_complaint);
502 for (i = 0; i < ci->children_num; i++)
503 {
504 oconfig_item_t *child = ci->children + i;
506 if (strcasecmp ("Host", child->key) == 0)
507 cf_util_get_string (child, &cb->node);
508 else if (strcasecmp ("Port", child->key) == 0)
509 cf_util_get_service (child, &cb->service);
510 else if (strcasecmp ("Protocol", child->key) == 0)
511 {
512 cf_util_get_string (child, &cb->protocol);
514 if (strcasecmp ("UDP", cb->protocol) != 0 &&
515 strcasecmp ("TCP", cb->protocol) != 0)
516 {
517 ERROR ("write_graphite plugin: Unknown protocol (%s)",
518 cb->protocol);
519 status = -1;
520 }
521 }
522 else if (strcasecmp ("LogSendErrors", child->key) == 0)
523 cf_util_get_boolean (child, &cb->log_send_errors);
524 else if (strcasecmp ("Prefix", child->key) == 0)
525 cf_util_get_string (child, &cb->prefix);
526 else if (strcasecmp ("Postfix", child->key) == 0)
527 cf_util_get_string (child, &cb->postfix);
528 else if (strcasecmp ("StoreRates", child->key) == 0)
529 cf_util_get_flag (child, &cb->format_flags,
530 GRAPHITE_STORE_RATES);
531 else if (strcasecmp ("SeparateInstances", child->key) == 0)
532 cf_util_get_flag (child, &cb->format_flags,
533 GRAPHITE_SEPARATE_INSTANCES);
534 else if (strcasecmp ("AlwaysAppendDS", child->key) == 0)
535 cf_util_get_flag (child, &cb->format_flags,
536 GRAPHITE_ALWAYS_APPEND_DS);
537 else if (strcasecmp ("EscapeCharacter", child->key) == 0)
538 config_set_char (&cb->escape_char, child);
539 else
540 {
541 ERROR ("write_graphite plugin: Invalid configuration "
542 "option: %s.", child->key);
543 status = -1;
544 }
546 if (status != 0)
547 break;
548 }
550 if (status != 0)
551 {
552 wg_callback_free (cb);
553 return (status);
554 }
556 /* FIXME: Legacy configuration syntax. */
557 if (cb->name == NULL)
558 ssnprintf (callback_name, sizeof (callback_name), "write_graphite/%s/%s/%s",
559 cb->node != NULL ? cb->node : WG_DEFAULT_NODE,
560 cb->service != NULL ? cb->service : WG_DEFAULT_SERVICE,
561 cb->protocol != NULL ? cb->protocol : WG_DEFAULT_PROTOCOL);
562 else
563 ssnprintf (callback_name, sizeof (callback_name), "write_graphite/%s",
564 cb->name);
566 memset (&user_data, 0, sizeof (user_data));
567 user_data.data = cb;
568 user_data.free_func = wg_callback_free;
569 plugin_register_write (callback_name, wg_write, &user_data);
571 user_data.free_func = NULL;
572 plugin_register_flush (callback_name, wg_flush, &user_data);
574 return (0);
575 }
577 static int wg_config (oconfig_item_t *ci)
578 {
579 int i;
581 for (i = 0; i < ci->children_num; i++)
582 {
583 oconfig_item_t *child = ci->children + i;
585 if (strcasecmp ("Node", child->key) == 0)
586 wg_config_node (child);
587 /* FIXME: Remove this legacy mode in version 6. */
588 else if (strcasecmp ("Carbon", child->key) == 0)
589 wg_config_node (child);
590 else
591 {
592 ERROR ("write_graphite plugin: Invalid configuration "
593 "option: %s.", child->key);
594 }
595 }
597 return (0);
598 }
600 void module_register (void)
601 {
602 plugin_register_complex_config ("write_graphite", wg_config);
603 }
605 /* vim: set sw=4 ts=4 sts=4 tw=78 et : */