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 * Prefix "collectd"
39 * </Carbon>
40 * </Plugin>
41 */
43 #include "collectd.h"
44 #include "common.h"
45 #include "plugin.h"
46 #include "configfile.h"
48 #include "utils_cache.h"
49 #include "utils_complain.h"
50 #include "utils_parse_option.h"
51 #include "utils_format_graphite.h"
53 /* Folks without pthread will need to disable this plugin. */
54 #include <pthread.h>
56 #include <sys/socket.h>
57 #include <netdb.h>
59 #ifndef WG_DEFAULT_NODE
60 # define WG_DEFAULT_NODE "localhost"
61 #endif
63 #ifndef WG_DEFAULT_SERVICE
64 # define WG_DEFAULT_SERVICE "2003"
65 #endif
67 #ifndef WG_DEFAULT_ESCAPE
68 # define WG_DEFAULT_ESCAPE '_'
69 #endif
71 /* Ethernet - (IPv6 + TCP) = 1500 - (40 + 32) = 1428 */
72 #ifndef WG_SEND_BUF_SIZE
73 # define WG_SEND_BUF_SIZE 1428
74 #endif
76 /*
77 * Private variables
78 */
79 struct wg_callback
80 {
81 int sock_fd;
83 char *node;
84 char *service;
85 char *prefix;
86 char *postfix;
87 char escape_char;
89 unsigned int format_flags;
91 char send_buf[WG_SEND_BUF_SIZE];
92 size_t send_buf_free;
93 size_t send_buf_fill;
94 cdtime_t send_buf_init_time;
96 pthread_mutex_t send_lock;
97 c_complain_t init_complaint;
98 };
101 /*
102 * Functions
103 */
104 static void wg_reset_buffer (struct wg_callback *cb)
105 {
106 memset (cb->send_buf, 0, sizeof (cb->send_buf));
107 cb->send_buf_free = sizeof (cb->send_buf);
108 cb->send_buf_fill = 0;
109 cb->send_buf_init_time = cdtime ();
110 }
112 static int wg_send_buffer (struct wg_callback *cb)
113 {
114 ssize_t status = 0;
116 status = swrite (cb->sock_fd, cb->send_buf, strlen (cb->send_buf));
117 if (status < 0)
118 {
119 char errbuf[1024];
120 ERROR ("write_graphite plugin: send failed with status %zi (%s)",
121 status, sstrerror (errno, errbuf, sizeof (errbuf)));
124 close (cb->sock_fd);
125 cb->sock_fd = -1;
127 return (-1);
128 }
130 return (0);
131 }
133 /* NOTE: You must hold cb->send_lock when calling this function! */
134 static int wg_flush_nolock (cdtime_t timeout, struct wg_callback *cb)
135 {
136 int status;
138 DEBUG ("write_graphite plugin: wg_flush_nolock: timeout = %.3f; "
139 "send_buf_fill = %zu;",
140 (double)timeout,
141 cb->send_buf_fill);
143 /* timeout == 0 => flush unconditionally */
144 if (timeout > 0)
145 {
146 cdtime_t now;
148 now = cdtime ();
149 if ((cb->send_buf_init_time + timeout) > now)
150 return (0);
151 }
153 if (cb->send_buf_fill <= 0)
154 {
155 cb->send_buf_init_time = cdtime ();
156 return (0);
157 }
159 status = wg_send_buffer (cb);
160 wg_reset_buffer (cb);
162 return (status);
163 }
165 static int wg_callback_init (struct wg_callback *cb)
166 {
167 struct addrinfo ai_hints;
168 struct addrinfo *ai_list;
169 struct addrinfo *ai_ptr;
170 int status;
172 const char *node = cb->node ? cb->node : WG_DEFAULT_NODE;
173 const char *service = cb->service ? cb->service : WG_DEFAULT_SERVICE;
175 if (cb->sock_fd > 0)
176 return (0);
178 memset (&ai_hints, 0, sizeof (ai_hints));
179 #ifdef AI_ADDRCONFIG
180 ai_hints.ai_flags |= AI_ADDRCONFIG;
181 #endif
182 ai_hints.ai_family = AF_UNSPEC;
183 ai_hints.ai_socktype = SOCK_STREAM;
185 ai_list = NULL;
187 status = getaddrinfo (node, service, &ai_hints, &ai_list);
188 if (status != 0)
189 {
190 ERROR ("write_graphite plugin: getaddrinfo (%s, %s) failed: %s",
191 node, service, gai_strerror (status));
192 return (-1);
193 }
195 assert (ai_list != NULL);
196 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
197 {
198 cb->sock_fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype,
199 ai_ptr->ai_protocol);
200 if (cb->sock_fd < 0)
201 continue;
203 status = connect (cb->sock_fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
204 if (status != 0)
205 {
206 close (cb->sock_fd);
207 cb->sock_fd = -1;
208 continue;
209 }
211 break;
212 }
214 freeaddrinfo (ai_list);
216 if (cb->sock_fd < 0)
217 {
218 char errbuf[1024];
219 c_complain (LOG_ERR, &cb->init_complaint,
220 "write_graphite plugin: Connecting to %s:%s failed. "
221 "The last error was: %s", node, service,
222 sstrerror (errno, errbuf, sizeof (errbuf)));
223 return (-1);
224 }
225 else
226 {
227 c_release (LOG_INFO, &cb->init_complaint,
228 "write_graphite plugin: Successfully connected to %s:%s.",
229 node, service);
230 }
232 wg_reset_buffer (cb);
234 return (0);
235 }
237 static void wg_callback_free (void *data)
238 {
239 struct wg_callback *cb;
241 if (data == NULL)
242 return;
244 cb = data;
246 pthread_mutex_lock (&cb->send_lock);
248 wg_flush_nolock (/* timeout = */ 0, cb);
250 close(cb->sock_fd);
251 cb->sock_fd = -1;
253 sfree(cb->node);
254 sfree(cb->service);
255 sfree(cb->prefix);
256 sfree(cb->postfix);
258 pthread_mutex_destroy (&cb->send_lock);
260 sfree(cb);
261 }
263 static int wg_flush (cdtime_t timeout,
264 const char *identifier __attribute__((unused)),
265 user_data_t *user_data)
266 {
267 struct wg_callback *cb;
268 int status;
270 if (user_data == NULL)
271 return (-EINVAL);
273 cb = user_data->data;
275 pthread_mutex_lock (&cb->send_lock);
277 if (cb->sock_fd < 0)
278 {
279 status = wg_callback_init (cb);
280 if (status != 0)
281 {
282 /* An error message has already been printed. */
283 pthread_mutex_unlock (&cb->send_lock);
284 return (-1);
285 }
286 }
288 status = wg_flush_nolock (timeout, cb);
289 pthread_mutex_unlock (&cb->send_lock);
291 return (status);
292 }
294 static int wg_send_message (char const *message, struct wg_callback *cb)
295 {
296 int status;
297 size_t message_len;
299 message_len = strlen (message);
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 if (message_len >= cb->send_buf_free)
315 {
316 status = wg_flush_nolock (/* timeout = */ 0, cb);
317 if (status != 0)
318 {
319 pthread_mutex_unlock (&cb->send_lock);
320 return (status);
321 }
322 }
324 /* Assert that we have enough space for this message. */
325 assert (message_len < cb->send_buf_free);
327 /* `message_len + 1' because `message_len' does not include the
328 * trailing null byte. Neither does `send_buffer_fill'. */
329 memcpy (cb->send_buf + cb->send_buf_fill,
330 message, message_len + 1);
331 cb->send_buf_fill += message_len;
332 cb->send_buf_free -= message_len;
334 DEBUG ("write_graphite plugin: [%s]:%s buf %zu/%zu (%.1f %%) \"%s\"",
335 cb->node,
336 cb->service,
337 cb->send_buf_fill, sizeof (cb->send_buf),
338 100.0 * ((double) cb->send_buf_fill) / ((double) sizeof (cb->send_buf)),
339 message);
341 pthread_mutex_unlock (&cb->send_lock);
343 return (0);
344 }
346 static int wg_write_messages (const data_set_t *ds, const value_list_t *vl,
347 struct wg_callback *cb)
348 {
349 char buffer[WG_SEND_BUF_SIZE];
350 int status;
352 if (0 != strcmp (ds->type, vl->type))
353 {
354 ERROR ("write_graphite plugin: DS type does not match "
355 "value list type");
356 return -1;
357 }
359 memset (buffer, 0, sizeof (buffer));
360 status = format_graphite (buffer, sizeof (buffer), ds, vl,
361 cb->prefix, cb->postfix, cb->escape_char, cb->format_flags);
362 if (status != 0) /* error message has been printed already. */
363 return (status);
365 /* Send the message to graphite */
366 status = wg_send_message (buffer, cb);
367 if (status != 0) /* error message has been printed already. */
368 return (status);
370 return (0);
371 } /* int wg_write_messages */
373 static int wg_write (const data_set_t *ds, const value_list_t *vl,
374 user_data_t *user_data)
375 {
376 struct wg_callback *cb;
377 int status;
379 if (user_data == NULL)
380 return (EINVAL);
382 cb = user_data->data;
384 status = wg_write_messages (ds, vl, cb);
386 return (status);
387 }
389 static int config_set_char (char *dest,
390 oconfig_item_t *ci)
391 {
392 char buffer[4];
393 int status;
395 memset (buffer, 0, sizeof (buffer));
397 status = cf_util_get_string_buffer (ci, buffer, sizeof (buffer));
398 if (status != 0)
399 return (status);
401 if (buffer[0] == 0)
402 {
403 ERROR ("write_graphite plugin: Cannot use an empty string for the "
404 "\"EscapeCharacter\" option.");
405 return (-1);
406 }
408 if (buffer[1] != 0)
409 {
410 WARNING ("write_graphite plugin: Only the first character of the "
411 "\"EscapeCharacter\" option ('%c') will be used.",
412 (int) buffer[0]);
413 }
415 *dest = buffer[0];
417 return (0);
418 }
420 static int wg_config_carbon (oconfig_item_t *ci)
421 {
422 struct wg_callback *cb;
423 user_data_t user_data;
424 char callback_name[DATA_MAX_NAME_LEN];
425 int i;
427 cb = malloc (sizeof (*cb));
428 if (cb == NULL)
429 {
430 ERROR ("write_graphite plugin: malloc failed.");
431 return (-1);
432 }
433 memset (cb, 0, sizeof (*cb));
434 cb->sock_fd = -1;
435 cb->node = NULL;
436 cb->service = NULL;
437 cb->prefix = NULL;
438 cb->postfix = NULL;
439 cb->escape_char = WG_DEFAULT_ESCAPE;
440 cb->format_flags = GRAPHITE_STORE_RATES;
442 pthread_mutex_init (&cb->send_lock, /* attr = */ NULL);
443 C_COMPLAIN_INIT (&cb->init_complaint);
445 for (i = 0; i < ci->children_num; i++)
446 {
447 oconfig_item_t *child = ci->children + i;
449 if (strcasecmp ("Host", child->key) == 0)
450 cf_util_get_string (child, &cb->node);
451 else if (strcasecmp ("Port", child->key) == 0)
452 cf_util_get_service (child, &cb->service);
453 else if (strcasecmp ("Prefix", child->key) == 0)
454 cf_util_get_string (child, &cb->prefix);
455 else if (strcasecmp ("Postfix", child->key) == 0)
456 cf_util_get_string (child, &cb->postfix);
457 else if (strcasecmp ("StoreRates", child->key) == 0)
458 cf_util_get_flag (child, &cb->format_flags,
459 GRAPHITE_STORE_RATES);
460 else if (strcasecmp ("SeparateInstances", child->key) == 0)
461 cf_util_get_flag (child, &cb->format_flags,
462 GRAPHITE_SEPARATE_INSTANCES);
463 else if (strcasecmp ("AlwaysAppendDS", child->key) == 0)
464 cf_util_get_flag (child, &cb->format_flags,
465 GRAPHITE_ALWAYS_APPEND_DS);
466 else if (strcasecmp ("EscapeCharacter", child->key) == 0)
467 config_set_char (&cb->escape_char, child);
468 else
469 {
470 ERROR ("write_graphite plugin: Invalid configuration "
471 "option: %s.", child->key);
472 }
473 }
475 ssnprintf (callback_name, sizeof (callback_name), "write_graphite/%s/%s",
476 cb->node != NULL ? cb->node : WG_DEFAULT_NODE,
477 cb->service != NULL ? cb->service : WG_DEFAULT_SERVICE);
479 memset (&user_data, 0, sizeof (user_data));
480 user_data.data = cb;
481 user_data.free_func = wg_callback_free;
482 plugin_register_write (callback_name, wg_write, &user_data);
484 user_data.free_func = NULL;
485 plugin_register_flush (callback_name, wg_flush, &user_data);
487 return (0);
488 }
490 static int wg_config (oconfig_item_t *ci)
491 {
492 int i;
494 for (i = 0; i < ci->children_num; i++)
495 {
496 oconfig_item_t *child = ci->children + i;
498 if (strcasecmp ("Carbon", child->key) == 0)
499 wg_config_carbon (child);
500 else
501 {
502 ERROR ("write_graphite plugin: Invalid configuration "
503 "option: %s.", child->key);
504 }
505 }
507 return (0);
508 }
510 void module_register (void)
511 {
512 plugin_register_complex_config ("write_graphite", wg_config);
513 }
515 /* vim: set sw=4 ts=4 sts=4 tw=78 et : */