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
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.
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.
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
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>
29 * Based on the write_http plugin.
32 /* write_graphite plugin configuation example
34 * <Plugin write_graphite>
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. */
58 #include <sys/socket.h>
61 #ifndef WG_DEFAULT_NODE
62 # define WG_DEFAULT_NODE "localhost"
65 #ifndef WG_DEFAULT_SERVICE
66 # define WG_DEFAULT_SERVICE "2003"
69 #ifndef WG_DEFAULT_PROTOCOL
70 # define WG_DEFAULT_PROTOCOL "tcp"
73 #ifndef WG_DEFAULT_LOG_SEND_ERRORS
74 # define WG_DEFAULT_LOG_SEND_ERRORS 1
77 #ifndef WG_DEFAULT_ESCAPE
78 # define WG_DEFAULT_ESCAPE '_'
81 /* Ethernet - (IPv6 + TCP) = 1500 - (40 + 32) = 1428 */
82 #ifndef WG_SEND_BUF_SIZE
83 # define WG_SEND_BUF_SIZE 1428
98 _Bool log_send_errors;
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;
118 static void wg_reset_buffer (struct wg_callback *cb)
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 ();
126 static int wg_send_buffer (struct wg_callback *cb)
130 status = swrite (cb->sock_fd, cb->send_buf, strlen (cb->send_buf));
133 const char *protocol = cb->protocol ? cb->protocol : WG_DEFAULT_PROTOCOL;
135 if (cb->log_send_errors)
138 ERROR ("write_graphite plugin: send to %s:%s (%s) failed with status %zi (%s)",
139 cb->node, cb->service, protocol,
140 status, sstrerror (errno, errbuf, sizeof (errbuf)));
152 /* NOTE: You must hold cb->send_lock when calling this function! */
153 static int wg_flush_nolock (cdtime_t timeout, struct wg_callback *cb)
157 DEBUG ("write_graphite plugin: wg_flush_nolock: timeout = %.3f; "
158 "send_buf_fill = %zu;",
162 /* timeout == 0 => flush unconditionally */
168 if ((cb->send_buf_init_time + timeout) > now)
172 if (cb->send_buf_fill <= 0)
174 cb->send_buf_init_time = cdtime ();
178 status = wg_send_buffer (cb);
179 wg_reset_buffer (cb);
184 static int wg_callback_init (struct wg_callback *cb)
186 struct addrinfo ai_hints;
187 struct addrinfo *ai_list;
188 struct addrinfo *ai_ptr;
191 const char *node = cb->node ? cb->node : WG_DEFAULT_NODE;
192 const char *service = cb->service ? cb->service : WG_DEFAULT_SERVICE;
193 const char *protocol = cb->protocol ? cb->protocol : WG_DEFAULT_PROTOCOL;
195 char connerr[1024] = "";
200 memset (&ai_hints, 0, sizeof (ai_hints));
202 ai_hints.ai_flags |= AI_ADDRCONFIG;
204 ai_hints.ai_family = AF_UNSPEC;
206 if (0 == strcasecmp ("tcp", protocol))
207 ai_hints.ai_socktype = SOCK_STREAM;
209 ai_hints.ai_socktype = SOCK_DGRAM;
213 status = getaddrinfo (node, service, &ai_hints, &ai_list);
216 ERROR ("write_graphite plugin: getaddrinfo (%s, %s, %s) failed: %s",
217 node, service, protocol, gai_strerror (status));
221 assert (ai_list != NULL);
222 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
224 cb->sock_fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype,
225 ai_ptr->ai_protocol);
226 if (cb->sock_fd < 0) {
228 snprintf (connerr, sizeof (connerr), "failed to open socket: %s",
229 sstrerror (errno, errbuf, sizeof (errbuf)));
233 status = connect (cb->sock_fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
237 snprintf (connerr, sizeof (connerr), "failed to connect to remote "
238 "host: %s", sstrerror (errno, errbuf, sizeof (errbuf)));
247 freeaddrinfo (ai_list);
251 if (connerr[0] == '\0')
252 /* this should not happen but try to get a message anyway */
253 sstrerror (errno, connerr, sizeof (connerr));
254 c_complain (LOG_ERR, &cb->init_complaint,
255 "write_graphite plugin: Connecting to %s:%s via %s failed. "
256 "The last error was: %s", node, service, protocol, connerr);
261 c_release (LOG_INFO, &cb->init_complaint,
262 "write_graphite plugin: Successfully connected to %s:%s via %s.",
263 node, service, protocol);
266 wg_reset_buffer (cb);
271 static void wg_callback_free (void *data)
273 struct wg_callback *cb;
280 pthread_mutex_lock (&cb->send_lock);
282 wg_flush_nolock (/* timeout = */ 0, cb);
284 if (cb->sock_fd >= 0)
297 pthread_mutex_destroy (&cb->send_lock);
302 static int wg_flush (cdtime_t timeout,
303 const char *identifier __attribute__((unused)),
304 user_data_t *user_data)
306 struct wg_callback *cb;
309 if (user_data == NULL)
312 cb = user_data->data;
314 pthread_mutex_lock (&cb->send_lock);
318 status = wg_callback_init (cb);
321 /* An error message has already been printed. */
322 pthread_mutex_unlock (&cb->send_lock);
327 status = wg_flush_nolock (timeout, cb);
328 pthread_mutex_unlock (&cb->send_lock);
333 static int wg_send_message (char const *message, struct wg_callback *cb)
338 message_len = strlen (message);
340 pthread_mutex_lock (&cb->send_lock);
344 status = wg_callback_init (cb);
347 /* An error message has already been printed. */
348 pthread_mutex_unlock (&cb->send_lock);
353 if (message_len >= cb->send_buf_free)
355 status = wg_flush_nolock (/* timeout = */ 0, cb);
358 pthread_mutex_unlock (&cb->send_lock);
363 /* Assert that we have enough space for this message. */
364 assert (message_len < cb->send_buf_free);
366 /* `message_len + 1' because `message_len' does not include the
367 * trailing null byte. Neither does `send_buffer_fill'. */
368 memcpy (cb->send_buf + cb->send_buf_fill,
369 message, message_len + 1);
370 cb->send_buf_fill += message_len;
371 cb->send_buf_free -= message_len;
373 DEBUG ("write_graphite plugin: [%s]:%s (%s) buf %zu/%zu (%.1f %%) \"%s\"",
377 cb->send_buf_fill, sizeof (cb->send_buf),
378 100.0 * ((double) cb->send_buf_fill) / ((double) sizeof (cb->send_buf)),
381 pthread_mutex_unlock (&cb->send_lock);
386 static int wg_write_messages (const data_set_t *ds, const value_list_t *vl,
387 struct wg_callback *cb)
389 char buffer[WG_SEND_BUF_SIZE];
392 if (0 != strcmp (ds->type, vl->type))
394 ERROR ("write_graphite plugin: DS type does not match "
399 memset (buffer, 0, sizeof (buffer));
400 status = format_graphite (buffer, sizeof (buffer), ds, vl,
401 cb->prefix, cb->postfix, cb->escape_char, cb->format_flags);
402 if (status != 0) /* error message has been printed already. */
405 /* Send the message to graphite */
406 status = wg_send_message (buffer, cb);
407 if (status != 0) /* error message has been printed already. */
411 } /* int wg_write_messages */
413 static int wg_write (const data_set_t *ds, const value_list_t *vl,
414 user_data_t *user_data)
416 struct wg_callback *cb;
419 if (user_data == NULL)
422 cb = user_data->data;
424 status = wg_write_messages (ds, vl, cb);
429 static int config_set_char (char *dest,
435 memset (buffer, 0, sizeof (buffer));
437 status = cf_util_get_string_buffer (ci, buffer, sizeof (buffer));
443 ERROR ("write_graphite plugin: Cannot use an empty string for the "
444 "\"EscapeCharacter\" option.");
450 WARNING ("write_graphite plugin: Only the first character of the "
451 "\"EscapeCharacter\" option ('%c') will be used.",
460 static int wg_config_node (oconfig_item_t *ci)
462 struct wg_callback *cb;
463 user_data_t user_data;
464 char callback_name[DATA_MAX_NAME_LEN];
468 cb = malloc (sizeof (*cb));
471 ERROR ("write_graphite plugin: malloc failed.");
474 memset (cb, 0, sizeof (*cb));
480 cb->log_send_errors = WG_DEFAULT_LOG_SEND_ERRORS;
483 cb->escape_char = WG_DEFAULT_ESCAPE;
484 cb->format_flags = GRAPHITE_STORE_RATES;
486 /* FIXME: Legacy configuration syntax. */
487 if (strcasecmp ("Carbon", ci->key) != 0)
489 status = cf_util_get_string (ci, &cb->name);
492 wg_callback_free (cb);
497 pthread_mutex_init (&cb->send_lock, /* attr = */ NULL);
498 C_COMPLAIN_INIT (&cb->init_complaint);
500 for (i = 0; i < ci->children_num; i++)
502 oconfig_item_t *child = ci->children + i;
504 if (strcasecmp ("Host", child->key) == 0)
505 cf_util_get_string (child, &cb->node);
506 else if (strcasecmp ("Port", child->key) == 0)
507 cf_util_get_service (child, &cb->service);
508 else if (strcasecmp ("Protocol", child->key) == 0)
510 cf_util_get_string (child, &cb->protocol);
512 if (strcasecmp ("UDP", cb->protocol) != 0 &&
513 strcasecmp ("TCP", cb->protocol) != 0)
515 ERROR ("write_graphite plugin: Unknown protocol (%s)",
520 else if (strcasecmp ("LogSendErrors", child->key) == 0)
521 cf_util_get_boolean (child, &cb->log_send_errors);
522 else if (strcasecmp ("Prefix", child->key) == 0)
523 cf_util_get_string (child, &cb->prefix);
524 else if (strcasecmp ("Postfix", child->key) == 0)
525 cf_util_get_string (child, &cb->postfix);
526 else if (strcasecmp ("StoreRates", child->key) == 0)
527 cf_util_get_flag (child, &cb->format_flags,
528 GRAPHITE_STORE_RATES);
529 else if (strcasecmp ("SeparateInstances", child->key) == 0)
530 cf_util_get_flag (child, &cb->format_flags,
531 GRAPHITE_SEPARATE_INSTANCES);
532 else if (strcasecmp ("AlwaysAppendDS", child->key) == 0)
533 cf_util_get_flag (child, &cb->format_flags,
534 GRAPHITE_ALWAYS_APPEND_DS);
535 else if (strcasecmp ("EscapeCharacter", child->key) == 0)
536 config_set_char (&cb->escape_char, child);
539 ERROR ("write_graphite plugin: Invalid configuration "
540 "option: %s.", child->key);
550 wg_callback_free (cb);
554 /* FIXME: Legacy configuration syntax. */
555 if (cb->name == NULL)
556 ssnprintf (callback_name, sizeof (callback_name), "write_graphite/%s/%s/%s",
557 cb->node != NULL ? cb->node : WG_DEFAULT_NODE,
558 cb->service != NULL ? cb->service : WG_DEFAULT_SERVICE,
559 cb->protocol != NULL ? cb->protocol : WG_DEFAULT_PROTOCOL);
561 ssnprintf (callback_name, sizeof (callback_name), "write_graphite/%s",
564 memset (&user_data, 0, sizeof (user_data));
566 user_data.free_func = wg_callback_free;
567 plugin_register_write (callback_name, wg_write, &user_data);
569 user_data.free_func = NULL;
570 plugin_register_flush (callback_name, wg_flush, &user_data);
575 static int wg_config (oconfig_item_t *ci)
579 for (i = 0; i < ci->children_num; i++)
581 oconfig_item_t *child = ci->children + i;
583 if (strcasecmp ("Node", child->key) == 0)
584 wg_config_node (child);
585 /* FIXME: Remove this legacy mode in version 6. */
586 else if (strcasecmp ("Carbon", child->key) == 0)
587 wg_config_node (child);
590 ERROR ("write_graphite plugin: Invalid configuration "
591 "option: %s.", child->key);
598 void module_register (void)
600 plugin_register_complex_config ("write_graphite", wg_config);
603 /* vim: set sw=4 ts=4 sts=4 tw=78 et : */