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 if (cb->sock_fd >= 0)
251 {
252 close (cb->sock_fd);
253 cb->sock_fd = -1;
254 }
256 sfree(cb->node);
257 sfree(cb->service);
258 sfree(cb->prefix);
259 sfree(cb->postfix);
261 pthread_mutex_destroy (&cb->send_lock);
263 sfree(cb);
264 }
266 static int wg_flush (cdtime_t timeout,
267 const char *identifier __attribute__((unused)),
268 user_data_t *user_data)
269 {
270 struct wg_callback *cb;
271 int status;
273 if (user_data == NULL)
274 return (-EINVAL);
276 cb = user_data->data;
278 pthread_mutex_lock (&cb->send_lock);
280 if (cb->sock_fd < 0)
281 {
282 status = wg_callback_init (cb);
283 if (status != 0)
284 {
285 /* An error message has already been printed. */
286 pthread_mutex_unlock (&cb->send_lock);
287 return (-1);
288 }
289 }
291 status = wg_flush_nolock (timeout, cb);
292 pthread_mutex_unlock (&cb->send_lock);
294 return (status);
295 }
297 static int wg_send_message (char const *message, struct wg_callback *cb)
298 {
299 int status;
300 size_t message_len;
302 message_len = strlen (message);
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 if (message_len >= cb->send_buf_free)
318 {
319 status = wg_flush_nolock (/* timeout = */ 0, cb);
320 if (status != 0)
321 {
322 pthread_mutex_unlock (&cb->send_lock);
323 return (status);
324 }
325 }
327 /* Assert that we have enough space for this message. */
328 assert (message_len < cb->send_buf_free);
330 /* `message_len + 1' because `message_len' does not include the
331 * trailing null byte. Neither does `send_buffer_fill'. */
332 memcpy (cb->send_buf + cb->send_buf_fill,
333 message, message_len + 1);
334 cb->send_buf_fill += message_len;
335 cb->send_buf_free -= message_len;
337 DEBUG ("write_graphite plugin: [%s]:%s buf %zu/%zu (%.1f %%) \"%s\"",
338 cb->node,
339 cb->service,
340 cb->send_buf_fill, sizeof (cb->send_buf),
341 100.0 * ((double) cb->send_buf_fill) / ((double) sizeof (cb->send_buf)),
342 message);
344 pthread_mutex_unlock (&cb->send_lock);
346 return (0);
347 }
349 static int wg_write_messages (const data_set_t *ds, const value_list_t *vl,
350 struct wg_callback *cb)
351 {
352 char buffer[WG_SEND_BUF_SIZE];
353 int status;
355 if (0 != strcmp (ds->type, vl->type))
356 {
357 ERROR ("write_graphite plugin: DS type does not match "
358 "value list type");
359 return -1;
360 }
362 memset (buffer, 0, sizeof (buffer));
363 status = format_graphite (buffer, sizeof (buffer), ds, vl,
364 cb->prefix, cb->postfix, cb->escape_char, cb->format_flags);
365 if (status != 0) /* error message has been printed already. */
366 return (status);
368 /* Send the message to graphite */
369 status = wg_send_message (buffer, cb);
370 if (status != 0) /* error message has been printed already. */
371 return (status);
373 return (0);
374 } /* int wg_write_messages */
376 static int wg_write (const data_set_t *ds, const value_list_t *vl,
377 user_data_t *user_data)
378 {
379 struct wg_callback *cb;
380 int status;
382 if (user_data == NULL)
383 return (EINVAL);
385 cb = user_data->data;
387 status = wg_write_messages (ds, vl, cb);
389 return (status);
390 }
392 static int config_set_char (char *dest,
393 oconfig_item_t *ci)
394 {
395 char buffer[4];
396 int status;
398 memset (buffer, 0, sizeof (buffer));
400 status = cf_util_get_string_buffer (ci, buffer, sizeof (buffer));
401 if (status != 0)
402 return (status);
404 if (buffer[0] == 0)
405 {
406 ERROR ("write_graphite plugin: Cannot use an empty string for the "
407 "\"EscapeCharacter\" option.");
408 return (-1);
409 }
411 if (buffer[1] != 0)
412 {
413 WARNING ("write_graphite plugin: Only the first character of the "
414 "\"EscapeCharacter\" option ('%c') will be used.",
415 (int) buffer[0]);
416 }
418 *dest = buffer[0];
420 return (0);
421 }
423 static int wg_config_carbon (oconfig_item_t *ci)
424 {
425 struct wg_callback *cb;
426 user_data_t user_data;
427 char callback_name[DATA_MAX_NAME_LEN];
428 int i;
430 cb = malloc (sizeof (*cb));
431 if (cb == NULL)
432 {
433 ERROR ("write_graphite plugin: malloc failed.");
434 return (-1);
435 }
436 memset (cb, 0, sizeof (*cb));
437 cb->sock_fd = -1;
438 cb->node = NULL;
439 cb->service = NULL;
440 cb->prefix = NULL;
441 cb->postfix = NULL;
442 cb->escape_char = WG_DEFAULT_ESCAPE;
443 cb->format_flags = GRAPHITE_STORE_RATES;
445 pthread_mutex_init (&cb->send_lock, /* attr = */ NULL);
446 C_COMPLAIN_INIT (&cb->init_complaint);
448 for (i = 0; i < ci->children_num; i++)
449 {
450 oconfig_item_t *child = ci->children + i;
452 if (strcasecmp ("Host", child->key) == 0)
453 cf_util_get_string (child, &cb->node);
454 else if (strcasecmp ("Port", child->key) == 0)
455 cf_util_get_service (child, &cb->service);
456 else if (strcasecmp ("Prefix", child->key) == 0)
457 cf_util_get_string (child, &cb->prefix);
458 else if (strcasecmp ("Postfix", child->key) == 0)
459 cf_util_get_string (child, &cb->postfix);
460 else if (strcasecmp ("StoreRates", child->key) == 0)
461 cf_util_get_flag (child, &cb->format_flags,
462 GRAPHITE_STORE_RATES);
463 else if (strcasecmp ("SeparateInstances", child->key) == 0)
464 cf_util_get_flag (child, &cb->format_flags,
465 GRAPHITE_SEPARATE_INSTANCES);
466 else if (strcasecmp ("AlwaysAppendDS", child->key) == 0)
467 cf_util_get_flag (child, &cb->format_flags,
468 GRAPHITE_ALWAYS_APPEND_DS);
469 else if (strcasecmp ("EscapeCharacter", child->key) == 0)
470 config_set_char (&cb->escape_char, child);
471 else
472 {
473 ERROR ("write_graphite plugin: Invalid configuration "
474 "option: %s.", child->key);
475 }
476 }
478 ssnprintf (callback_name, sizeof (callback_name), "write_graphite/%s/%s",
479 cb->node != NULL ? cb->node : WG_DEFAULT_NODE,
480 cb->service != NULL ? cb->service : WG_DEFAULT_SERVICE);
482 memset (&user_data, 0, sizeof (user_data));
483 user_data.data = cb;
484 user_data.free_func = wg_callback_free;
485 plugin_register_write (callback_name, wg_write, &user_data);
487 user_data.free_func = NULL;
488 plugin_register_flush (callback_name, wg_flush, &user_data);
490 return (0);
491 }
493 static int wg_config (oconfig_item_t *ci)
494 {
495 int i;
497 for (i = 0; i < ci->children_num; i++)
498 {
499 oconfig_item_t *child = ci->children + i;
501 if (strcasecmp ("Carbon", child->key) == 0)
502 wg_config_carbon (child);
503 else
504 {
505 ERROR ("write_graphite plugin: Invalid configuration "
506 "option: %s.", child->key);
507 }
508 }
510 return (0);
511 }
513 void module_register (void)
514 {
515 plugin_register_complex_config ("write_graphite", wg_config);
516 }
518 /* vim: set sw=4 ts=4 sts=4 tw=78 et : */