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 <netdb.h>
59 #define WG_DEFAULT_NODE "localhost"
60 #define WG_DEFAULT_SERVICE "2003"
61 #define WG_DEFAULT_PROTOCOL "tcp"
62 #define WG_DEFAULT_LOG_SEND_ERRORS 1
63 #define WG_DEFAULT_ESCAPE '_'
65 /* Ethernet - (IPv6 + TCP) = 1500 - (40 + 32) = 1428 */
66 #define WG_SEND_BUF_SIZE 1428
68 #define WG_MIN_RECONNECT_INTERVAL TIME_T_TO_CDTIME_T (1)
70 /*
71 * Private variables
72 */
73 struct wg_callback
74 {
75 int sock_fd;
77 char *name;
79 char *node;
80 char *service;
81 char *protocol;
82 _Bool log_send_errors;
83 char *prefix;
84 char *postfix;
85 char escape_char;
87 unsigned int format_flags;
89 char send_buf[WG_SEND_BUF_SIZE];
90 size_t send_buf_free;
91 size_t send_buf_fill;
92 cdtime_t send_buf_init_time;
94 pthread_mutex_t send_lock;
95 c_complain_t init_complaint;
96 cdtime_t last_connect_time;
97 };
100 /*
101 * Functions
102 */
103 static void wg_reset_buffer (struct wg_callback *cb)
104 {
105 memset (cb->send_buf, 0, sizeof (cb->send_buf));
106 cb->send_buf_free = sizeof (cb->send_buf);
107 cb->send_buf_fill = 0;
108 cb->send_buf_init_time = cdtime ();
109 }
111 static int wg_send_buffer (struct wg_callback *cb)
112 {
113 ssize_t status = 0;
115 status = swrite (cb->sock_fd, cb->send_buf, strlen (cb->send_buf));
116 if (status < 0)
117 {
118 if (cb->log_send_errors)
119 {
120 char errbuf[1024];
121 ERROR ("write_graphite plugin: send to %s:%s (%s) failed with status %zi (%s)",
122 cb->node, cb->service, cb->protocol,
123 status, sstrerror (errno, errbuf, sizeof (errbuf)));
124 }
126 close (cb->sock_fd);
127 cb->sock_fd = -1;
129 return (-1);
130 }
132 return (0);
133 }
135 /* NOTE: You must hold cb->send_lock when calling this function! */
136 static int wg_flush_nolock (cdtime_t timeout, struct wg_callback *cb)
137 {
138 int status;
140 DEBUG ("write_graphite plugin: wg_flush_nolock: timeout = %.3f; "
141 "send_buf_fill = %zu;",
142 (double)timeout,
143 cb->send_buf_fill);
145 /* timeout == 0 => flush unconditionally */
146 if (timeout > 0)
147 {
148 cdtime_t now;
150 now = cdtime ();
151 if ((cb->send_buf_init_time + timeout) > now)
152 return (0);
153 }
155 if (cb->send_buf_fill <= 0)
156 {
157 cb->send_buf_init_time = cdtime ();
158 return (0);
159 }
161 status = wg_send_buffer (cb);
162 wg_reset_buffer (cb);
164 return (status);
165 }
167 static int wg_callback_init (struct wg_callback *cb)
168 {
169 struct addrinfo ai_hints;
170 struct addrinfo *ai_list;
171 struct addrinfo *ai_ptr;
172 cdtime_t now;
173 int status;
175 char connerr[1024] = "";
177 if (cb->sock_fd > 0)
178 return (0);
180 /* Don't try to reconnect too often. By default, one reconnection attempt
181 * is made per second. */
182 now = cdtime ();
183 if ((now - cb->last_connect_time) < WG_MIN_RECONNECT_INTERVAL)
184 return (EAGAIN);
185 cb->last_connect_time = now;
187 memset (&ai_hints, 0, sizeof (ai_hints));
188 #ifdef AI_ADDRCONFIG
189 ai_hints.ai_flags |= AI_ADDRCONFIG;
190 #endif
191 ai_hints.ai_family = AF_UNSPEC;
193 if (0 == strcasecmp ("tcp", cb->protocol))
194 ai_hints.ai_socktype = SOCK_STREAM;
195 else
196 ai_hints.ai_socktype = SOCK_DGRAM;
198 ai_list = NULL;
200 status = getaddrinfo (cb->node, cb->service, &ai_hints, &ai_list);
201 if (status != 0)
202 {
203 ERROR ("write_graphite plugin: getaddrinfo (%s, %s, %s) failed: %s",
204 cb->node, cb->service, cb->protocol, gai_strerror (status));
205 return (-1);
206 }
208 assert (ai_list != NULL);
209 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
210 {
211 cb->sock_fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype,
212 ai_ptr->ai_protocol);
213 if (cb->sock_fd < 0) {
214 char errbuf[1024];
215 snprintf (connerr, sizeof (connerr), "failed to open socket: %s",
216 sstrerror (errno, errbuf, sizeof (errbuf)));
217 continue;
218 }
220 status = connect (cb->sock_fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
221 if (status != 0)
222 {
223 char errbuf[1024];
224 snprintf (connerr, sizeof (connerr), "failed to connect to remote "
225 "host: %s", sstrerror (errno, errbuf, sizeof (errbuf)));
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 if (connerr[0] == '\0')
239 /* this should not happen but try to get a message anyway */
240 sstrerror (errno, connerr, sizeof (connerr));
241 c_complain (LOG_ERR, &cb->init_complaint,
242 "write_graphite plugin: Connecting to %s:%s via %s failed. "
243 "The last error was: %s", cb->node, cb->service, cb->protocol, connerr);
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 cb->node, cb->service, cb->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 if (cb->sock_fd >= 0)
272 {
273 close (cb->sock_fd);
274 cb->sock_fd = -1;
275 }
277 sfree(cb->name);
278 sfree(cb->node);
279 sfree(cb->protocol);
280 sfree(cb->service);
281 sfree(cb->prefix);
282 sfree(cb->postfix);
284 pthread_mutex_destroy (&cb->send_lock);
286 sfree(cb);
287 }
289 static int wg_flush (cdtime_t timeout,
290 const char *identifier __attribute__((unused)),
291 user_data_t *user_data)
292 {
293 struct wg_callback *cb;
294 int status;
296 if (user_data == NULL)
297 return (-EINVAL);
299 cb = user_data->data;
301 pthread_mutex_lock (&cb->send_lock);
303 if (cb->sock_fd < 0)
304 {
305 status = wg_callback_init (cb);
306 if (status != 0)
307 {
308 /* An error message has already been printed. */
309 pthread_mutex_unlock (&cb->send_lock);
310 return (-1);
311 }
312 }
314 status = wg_flush_nolock (timeout, cb);
315 pthread_mutex_unlock (&cb->send_lock);
317 return (status);
318 }
320 static int wg_send_message (char const *message, struct wg_callback *cb)
321 {
322 int status;
323 size_t message_len;
325 message_len = strlen (message);
327 pthread_mutex_lock (&cb->send_lock);
329 if (cb->sock_fd < 0)
330 {
331 status = wg_callback_init (cb);
332 if (status != 0)
333 {
334 /* An error message has already been printed. */
335 pthread_mutex_unlock (&cb->send_lock);
336 return (-1);
337 }
338 }
340 if (message_len >= cb->send_buf_free)
341 {
342 status = wg_flush_nolock (/* timeout = */ 0, cb);
343 if (status != 0)
344 {
345 pthread_mutex_unlock (&cb->send_lock);
346 return (status);
347 }
348 }
350 /* Assert that we have enough space for this message. */
351 assert (message_len < cb->send_buf_free);
353 /* `message_len + 1' because `message_len' does not include the
354 * trailing null byte. Neither does `send_buffer_fill'. */
355 memcpy (cb->send_buf + cb->send_buf_fill,
356 message, message_len + 1);
357 cb->send_buf_fill += message_len;
358 cb->send_buf_free -= message_len;
360 DEBUG ("write_graphite plugin: [%s]:%s (%s) buf %zu/%zu (%.1f %%) \"%s\"",
361 cb->node, cb->service, cb->protocol,
362 cb->send_buf_fill, sizeof (cb->send_buf),
363 100.0 * ((double) cb->send_buf_fill) / ((double) sizeof (cb->send_buf)),
364 message);
366 pthread_mutex_unlock (&cb->send_lock);
368 return (0);
369 }
371 static int wg_write_messages (const data_set_t *ds, const value_list_t *vl,
372 struct wg_callback *cb)
373 {
374 char buffer[WG_SEND_BUF_SIZE];
375 int status;
377 if (0 != strcmp (ds->type, vl->type))
378 {
379 ERROR ("write_graphite plugin: DS type does not match "
380 "value list type");
381 return -1;
382 }
384 memset (buffer, 0, sizeof (buffer));
385 status = format_graphite (buffer, sizeof (buffer), ds, vl,
386 cb->prefix, cb->postfix, cb->escape_char, cb->format_flags);
387 if (status != 0) /* error message has been printed already. */
388 return (status);
390 /* Send the message to graphite */
391 status = wg_send_message (buffer, cb);
392 if (status != 0) /* error message has been printed already. */
393 return (status);
395 return (0);
396 } /* int wg_write_messages */
398 static int wg_write (const data_set_t *ds, const value_list_t *vl,
399 user_data_t *user_data)
400 {
401 struct wg_callback *cb;
402 int status;
404 if (user_data == NULL)
405 return (EINVAL);
407 cb = user_data->data;
409 status = wg_write_messages (ds, vl, cb);
411 return (status);
412 }
414 static int config_set_char (char *dest,
415 oconfig_item_t *ci)
416 {
417 char buffer[4];
418 int status;
420 memset (buffer, 0, sizeof (buffer));
422 status = cf_util_get_string_buffer (ci, buffer, sizeof (buffer));
423 if (status != 0)
424 return (status);
426 if (buffer[0] == 0)
427 {
428 ERROR ("write_graphite plugin: Cannot use an empty string for the "
429 "\"EscapeCharacter\" option.");
430 return (-1);
431 }
433 if (buffer[1] != 0)
434 {
435 WARNING ("write_graphite plugin: Only the first character of the "
436 "\"EscapeCharacter\" option ('%c') will be used.",
437 (int) buffer[0]);
438 }
440 *dest = buffer[0];
442 return (0);
443 }
445 static int wg_config_node (oconfig_item_t *ci)
446 {
447 struct wg_callback *cb;
448 user_data_t user_data;
449 char callback_name[DATA_MAX_NAME_LEN];
450 int i;
451 int status = 0;
453 cb = malloc (sizeof (*cb));
454 if (cb == NULL)
455 {
456 ERROR ("write_graphite plugin: malloc failed.");
457 return (-1);
458 }
459 memset (cb, 0, sizeof (*cb));
460 cb->sock_fd = -1;
461 cb->name = NULL;
462 cb->node = strdup (WG_DEFAULT_NODE);
463 cb->service = strdup (WG_DEFAULT_SERVICE);
464 cb->protocol = strdup (WG_DEFAULT_PROTOCOL);
465 cb->log_send_errors = WG_DEFAULT_LOG_SEND_ERRORS;
466 cb->prefix = NULL;
467 cb->postfix = NULL;
468 cb->escape_char = WG_DEFAULT_ESCAPE;
469 cb->format_flags = GRAPHITE_STORE_RATES;
471 /* FIXME: Legacy configuration syntax. */
472 if (strcasecmp ("Carbon", ci->key) != 0)
473 {
474 status = cf_util_get_string (ci, &cb->name);
475 if (status != 0)
476 {
477 wg_callback_free (cb);
478 return (status);
479 }
480 }
482 pthread_mutex_init (&cb->send_lock, /* attr = */ NULL);
483 C_COMPLAIN_INIT (&cb->init_complaint);
485 for (i = 0; i < ci->children_num; i++)
486 {
487 oconfig_item_t *child = ci->children + i;
489 if (strcasecmp ("Host", child->key) == 0)
490 cf_util_get_string (child, &cb->node);
491 else if (strcasecmp ("Port", child->key) == 0)
492 cf_util_get_service (child, &cb->service);
493 else if (strcasecmp ("Protocol", child->key) == 0)
494 {
495 cf_util_get_string (child, &cb->protocol);
497 if (strcasecmp ("UDP", cb->protocol) != 0 &&
498 strcasecmp ("TCP", cb->protocol) != 0)
499 {
500 ERROR ("write_graphite plugin: Unknown protocol (%s)",
501 cb->protocol);
502 status = -1;
503 }
504 }
505 else if (strcasecmp ("LogSendErrors", child->key) == 0)
506 cf_util_get_boolean (child, &cb->log_send_errors);
507 else if (strcasecmp ("Prefix", child->key) == 0)
508 cf_util_get_string (child, &cb->prefix);
509 else if (strcasecmp ("Postfix", child->key) == 0)
510 cf_util_get_string (child, &cb->postfix);
511 else if (strcasecmp ("StoreRates", child->key) == 0)
512 cf_util_get_flag (child, &cb->format_flags,
513 GRAPHITE_STORE_RATES);
514 else if (strcasecmp ("SeparateInstances", child->key) == 0)
515 cf_util_get_flag (child, &cb->format_flags,
516 GRAPHITE_SEPARATE_INSTANCES);
517 else if (strcasecmp ("AlwaysAppendDS", child->key) == 0)
518 cf_util_get_flag (child, &cb->format_flags,
519 GRAPHITE_ALWAYS_APPEND_DS);
520 else if (strcasecmp ("EscapeCharacter", child->key) == 0)
521 config_set_char (&cb->escape_char, child);
522 else
523 {
524 ERROR ("write_graphite plugin: Invalid configuration "
525 "option: %s.", child->key);
526 status = -1;
527 }
529 if (status != 0)
530 break;
531 }
533 if (status != 0)
534 {
535 wg_callback_free (cb);
536 return (status);
537 }
539 /* FIXME: Legacy configuration syntax. */
540 if (cb->name == NULL)
541 ssnprintf (callback_name, sizeof (callback_name), "write_graphite/%s/%s/%s",
542 cb->node, cb->service, cb->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 : */