write_graphite: remove dead assignment
[collectd.git] / src / write_graphite.c
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  **/
31
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   */
44
45 #include "collectd.h"
46 #include "common.h"
47 #include "plugin.h"
48 #include "configfile.h"
49
50 #include "utils_cache.h"
51 #include "utils_complain.h"
52 #include "utils_format_graphite.h"
53
54 #include <netdb.h>
55
56 #define WG_DEFAULT_NODE "localhost"
57 #define WG_DEFAULT_SERVICE "2003"
58 #define WG_DEFAULT_PROTOCOL "tcp"
59 #define WG_DEFAULT_LOG_SEND_ERRORS 1
60 #define WG_DEFAULT_ESCAPE '_'
61
62 /* Ethernet - (IPv6 + TCP) = 1500 - (40 + 32) = 1428 */
63 #define WG_SEND_BUF_SIZE 1428
64
65 #define WG_MIN_RECONNECT_INTERVAL TIME_T_TO_CDTIME_T (1)
66
67 /*
68  * Private variables
69  */
70 struct wg_callback
71 {
72     int      sock_fd;
73
74     char    *name;
75
76     char    *node;
77     char    *service;
78     char    *protocol;
79     _Bool   log_send_errors;
80     char    *prefix;
81     char    *postfix;
82     char     escape_char;
83
84     unsigned int format_flags;
85
86     char     send_buf[WG_SEND_BUF_SIZE];
87     size_t   send_buf_free;
88     size_t   send_buf_fill;
89     cdtime_t send_buf_init_time;
90
91     pthread_mutex_t send_lock;
92     c_complain_t init_complaint;
93     cdtime_t last_connect_time;
94
95     /* Force reconnect useful for load balanced environments */
96     cdtime_t last_reconnect_time;
97     cdtime_t reconnect_interval;
98     _Bool reconnect_interval_reached;
99 };
100
101 /* wg_force_reconnect_check closes cb->sock_fd when it was open for longer
102  * than cb->reconnect_interval. Must hold cb->send_lock when calling. */
103 static void wg_force_reconnect_check (struct wg_callback *cb)
104 {
105     cdtime_t now;
106
107     if (cb->reconnect_interval == 0)
108         return;
109
110     /* check if address changes if addr_timeout */
111     now = cdtime ();
112     if ((now - cb->last_reconnect_time) < cb->reconnect_interval)
113         return;
114
115     /* here we should close connection on next */
116     close (cb->sock_fd);
117     cb->sock_fd = -1;
118     cb->last_reconnect_time = now;
119     cb->reconnect_interval_reached = 1;
120
121     INFO ("write_graphite plugin: Connection closed after %.3f seconds.",
122           CDTIME_T_TO_DOUBLE (now - cb->last_reconnect_time));
123 }
124
125 /*
126  * Functions
127  */
128 static void wg_reset_buffer (struct wg_callback *cb)
129 {
130     memset (cb->send_buf, 0, sizeof (cb->send_buf));
131     cb->send_buf_free = sizeof (cb->send_buf);
132     cb->send_buf_fill = 0;
133     cb->send_buf_init_time = cdtime ();
134 }
135
136 static int wg_send_buffer (struct wg_callback *cb)
137 {
138     ssize_t status;
139
140     status = swrite (cb->sock_fd, cb->send_buf, strlen (cb->send_buf));
141     if (status != 0)
142     {
143         if (cb->log_send_errors)
144         {
145             char errbuf[1024];
146             ERROR ("write_graphite plugin: send to %s:%s (%s) failed with status %zi (%s)",
147                     cb->node, cb->service, cb->protocol,
148                     status, sstrerror (errno, errbuf, sizeof (errbuf)));
149         }
150
151         close (cb->sock_fd);
152         cb->sock_fd = -1;
153
154         return (-1);
155     }
156
157     return (0);
158 }
159
160 /* NOTE: You must hold cb->send_lock when calling this function! */
161 static int wg_flush_nolock (cdtime_t timeout, struct wg_callback *cb)
162 {
163     int status;
164
165     DEBUG ("write_graphite plugin: wg_flush_nolock: timeout = %.3f; "
166             "send_buf_fill = %zu;",
167             (double)timeout,
168             cb->send_buf_fill);
169
170     /* timeout == 0  => flush unconditionally */
171     if (timeout > 0)
172     {
173         cdtime_t now;
174
175         now = cdtime ();
176         if ((cb->send_buf_init_time + timeout) > now)
177             return (0);
178     }
179
180     if (cb->send_buf_fill == 0)
181     {
182         cb->send_buf_init_time = cdtime ();
183         return (0);
184     }
185
186     status = wg_send_buffer (cb);
187     wg_reset_buffer (cb);
188
189     return (status);
190 }
191
192 static int wg_callback_init (struct wg_callback *cb)
193 {
194     struct addrinfo ai_hints;
195     struct addrinfo *ai_list;
196     struct addrinfo *ai_ptr;
197     cdtime_t now;
198     int status;
199
200     char connerr[1024] = "";
201
202     if (cb->sock_fd > 0)
203         return (0);
204
205     /* Don't try to reconnect too often. By default, one reconnection attempt
206      * is made per second. */
207     now = cdtime ();
208     if ((now - cb->last_connect_time) < WG_MIN_RECONNECT_INTERVAL)
209         return (EAGAIN);
210     cb->last_connect_time = now;
211
212     memset (&ai_hints, 0, sizeof (ai_hints));
213 #ifdef AI_ADDRCONFIG
214     ai_hints.ai_flags |= AI_ADDRCONFIG;
215 #endif
216     ai_hints.ai_family = AF_UNSPEC;
217
218     if (0 == strcasecmp ("tcp", cb->protocol))
219         ai_hints.ai_socktype = SOCK_STREAM;
220     else
221         ai_hints.ai_socktype = SOCK_DGRAM;
222
223     ai_list = NULL;
224
225     status = getaddrinfo (cb->node, cb->service, &ai_hints, &ai_list);
226     if (status != 0)
227     {
228         ERROR ("write_graphite plugin: getaddrinfo (%s, %s, %s) failed: %s",
229                 cb->node, cb->service, cb->protocol, gai_strerror (status));
230         return (-1);
231     }
232
233     assert (ai_list != NULL);
234     for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
235     {
236         cb->sock_fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype,
237                 ai_ptr->ai_protocol);
238         if (cb->sock_fd < 0) {
239             char errbuf[1024];
240             snprintf (connerr, sizeof (connerr), "failed to open socket: %s",
241                     sstrerror (errno, errbuf, sizeof (errbuf)));
242             continue;
243         }
244
245         status = connect (cb->sock_fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
246         if (status != 0)
247         {
248             char errbuf[1024];
249             snprintf (connerr, sizeof (connerr), "failed to connect to remote "
250                     "host: %s", sstrerror (errno, errbuf, sizeof (errbuf)));
251             close (cb->sock_fd);
252             cb->sock_fd = -1;
253             continue;
254         }
255
256         break;
257     }
258
259     freeaddrinfo (ai_list);
260
261     if (cb->sock_fd < 0)
262     {
263         if (connerr[0] == '\0')
264             /* this should not happen but try to get a message anyway */
265             sstrerror (errno, connerr, sizeof (connerr));
266         c_complain (LOG_ERR, &cb->init_complaint,
267                   "write_graphite plugin: Connecting to %s:%s via %s failed. "
268                   "The last error was: %s", cb->node, cb->service, cb->protocol, connerr);
269         return (-1);
270     }
271     else
272     {
273         c_release (LOG_INFO, &cb->init_complaint,
274                 "write_graphite plugin: Successfully connected to %s:%s via %s.",
275                 cb->node, cb->service, cb->protocol);
276     }
277
278     /* wg_force_reconnect_check does not flush the buffer before closing a
279      * sending socket, so only call wg_reset_buffer() if the socket was closed
280      * for a different reason (tracked in cb->reconnect_interval_reached). */
281     if (!cb->reconnect_interval_reached || (cb->send_buf_free == 0))
282         wg_reset_buffer (cb);
283     else
284         cb->reconnect_interval_reached = 0;
285
286     return (0);
287 }
288
289 static void wg_callback_free (void *data)
290 {
291     struct wg_callback *cb;
292
293     if (data == NULL)
294         return;
295
296     cb = data;
297
298     pthread_mutex_lock (&cb->send_lock);
299
300     wg_flush_nolock (/* timeout = */ 0, cb);
301
302     if (cb->sock_fd >= 0)
303     {
304         close (cb->sock_fd);
305         cb->sock_fd = -1;
306     }
307
308     sfree(cb->name);
309     sfree(cb->node);
310     sfree(cb->protocol);
311     sfree(cb->service);
312     sfree(cb->prefix);
313     sfree(cb->postfix);
314
315     pthread_mutex_destroy (&cb->send_lock);
316
317     sfree(cb);
318 }
319
320 static int wg_flush (cdtime_t timeout,
321         const char *identifier __attribute__((unused)),
322         user_data_t *user_data)
323 {
324     struct wg_callback *cb;
325     int status;
326
327     if (user_data == NULL)
328         return (-EINVAL);
329
330     cb = user_data->data;
331
332     pthread_mutex_lock (&cb->send_lock);
333
334     if (cb->sock_fd < 0)
335     {
336         status = wg_callback_init (cb);
337         if (status != 0)
338         {
339             /* An error message has already been printed. */
340             pthread_mutex_unlock (&cb->send_lock);
341             return (-1);
342         }
343     }
344
345     status = wg_flush_nolock (timeout, cb);
346     pthread_mutex_unlock (&cb->send_lock);
347
348     return (status);
349 }
350
351 static int wg_send_message (char const *message, struct wg_callback *cb)
352 {
353     int status;
354     size_t message_len;
355
356     message_len = strlen (message);
357
358     pthread_mutex_lock (&cb->send_lock);
359
360     wg_force_reconnect_check (cb);
361
362     if (cb->sock_fd < 0)
363     {
364         status = wg_callback_init (cb);
365         if (status != 0)
366         {
367             /* An error message has already been printed. */
368             pthread_mutex_unlock (&cb->send_lock);
369             return (-1);
370         }
371     }
372
373     if (message_len >= cb->send_buf_free)
374     {
375         status = wg_flush_nolock (/* timeout = */ 0, cb);
376         if (status != 0)
377         {
378             pthread_mutex_unlock (&cb->send_lock);
379             return (status);
380         }
381     }
382
383     /* Assert that we have enough space for this message. */
384     assert (message_len < cb->send_buf_free);
385
386     /* `message_len + 1' because `message_len' does not include the
387      * trailing null byte. Neither does `send_buffer_fill'. */
388     memcpy (cb->send_buf + cb->send_buf_fill,
389             message, message_len + 1);
390     cb->send_buf_fill += message_len;
391     cb->send_buf_free -= message_len;
392
393     DEBUG ("write_graphite plugin: [%s]:%s (%s) buf %zu/%zu (%.1f %%) \"%s\"",
394             cb->node, cb->service, cb->protocol,
395             cb->send_buf_fill, sizeof (cb->send_buf),
396             100.0 * ((double) cb->send_buf_fill) / ((double) sizeof (cb->send_buf)),
397             message);
398
399     pthread_mutex_unlock (&cb->send_lock);
400
401     return (0);
402 }
403
404 static int wg_write_messages (const data_set_t *ds, const value_list_t *vl,
405         struct wg_callback *cb)
406 {
407     char buffer[WG_SEND_BUF_SIZE];
408     int status;
409
410     if (0 != strcmp (ds->type, vl->type))
411     {
412         ERROR ("write_graphite plugin: DS type does not match "
413                 "value list type");
414         return -1;
415     }
416
417     memset (buffer, 0, sizeof (buffer));
418     status = format_graphite (buffer, sizeof (buffer), ds, vl,
419             cb->prefix, cb->postfix, cb->escape_char, cb->format_flags);
420     if (status != 0) /* error message has been printed already. */
421         return (status);
422
423     /* Send the message to graphite */
424     status = wg_send_message (buffer, cb);
425     if (status != 0) /* error message has been printed already. */
426         return (status);
427
428     return (0);
429 } /* int wg_write_messages */
430
431 static int wg_write (const data_set_t *ds, const value_list_t *vl,
432         user_data_t *user_data)
433 {
434     struct wg_callback *cb;
435     int status;
436
437     if (user_data == NULL)
438         return (EINVAL);
439
440     cb = user_data->data;
441
442     status = wg_write_messages (ds, vl, cb);
443
444     return (status);
445 }
446
447 static int config_set_char (char *dest,
448         oconfig_item_t *ci)
449 {
450     char buffer[4];
451     int status;
452
453     memset (buffer, 0, sizeof (buffer));
454
455     status = cf_util_get_string_buffer (ci, buffer, sizeof (buffer));
456     if (status != 0)
457         return (status);
458
459     if (buffer[0] == 0)
460     {
461         ERROR ("write_graphite plugin: Cannot use an empty string for the "
462                 "\"EscapeCharacter\" option.");
463         return (-1);
464     }
465
466     if (buffer[1] != 0)
467     {
468         WARNING ("write_graphite plugin: Only the first character of the "
469                 "\"EscapeCharacter\" option ('%c') will be used.",
470                 (int) buffer[0]);
471     }
472
473     *dest = buffer[0];
474
475     return (0);
476 }
477
478 static int wg_config_node (oconfig_item_t *ci)
479 {
480     struct wg_callback *cb;
481     user_data_t user_data;
482     char callback_name[DATA_MAX_NAME_LEN];
483     int i;
484     int status = 0;
485
486     cb = calloc (1, sizeof (*cb));
487     if (cb == NULL)
488     {
489         ERROR ("write_graphite plugin: calloc failed.");
490         return (-1);
491     }
492     cb->sock_fd = -1;
493     cb->name = NULL;
494     cb->node = strdup (WG_DEFAULT_NODE);
495     cb->service = strdup (WG_DEFAULT_SERVICE);
496     cb->protocol = strdup (WG_DEFAULT_PROTOCOL);
497     cb->last_reconnect_time = cdtime();
498     cb->reconnect_interval = 0;
499     cb->reconnect_interval_reached = 0;
500     cb->log_send_errors = WG_DEFAULT_LOG_SEND_ERRORS;
501     cb->prefix = NULL;
502     cb->postfix = NULL;
503     cb->escape_char = WG_DEFAULT_ESCAPE;
504     cb->format_flags = GRAPHITE_STORE_RATES;
505
506     /* FIXME: Legacy configuration syntax. */
507     if (strcasecmp ("Carbon", ci->key) != 0)
508     {
509         status = cf_util_get_string (ci, &cb->name);
510         if (status != 0)
511         {
512             wg_callback_free (cb);
513             return (status);
514         }
515     }
516
517     pthread_mutex_init (&cb->send_lock, /* attr = */ NULL);
518     C_COMPLAIN_INIT (&cb->init_complaint);
519
520     for (i = 0; i < ci->children_num; i++)
521     {
522         oconfig_item_t *child = ci->children + i;
523
524         if (strcasecmp ("Host", child->key) == 0)
525             cf_util_get_string (child, &cb->node);
526         else if (strcasecmp ("Port", child->key) == 0)
527             cf_util_get_service (child, &cb->service);
528         else if (strcasecmp ("Protocol", child->key) == 0)
529         {
530             cf_util_get_string (child, &cb->protocol);
531
532             if (strcasecmp ("UDP", cb->protocol) != 0 &&
533                 strcasecmp ("TCP", cb->protocol) != 0)
534             {
535                 ERROR ("write_graphite plugin: Unknown protocol (%s)",
536                         cb->protocol);
537                 status = -1;
538             }
539         }
540         else if (strcasecmp ("ReconnectInterval", child->key) == 0)
541             cf_util_get_cdtime (child, &cb->reconnect_interval);
542         else if (strcasecmp ("LogSendErrors", child->key) == 0)
543             cf_util_get_boolean (child, &cb->log_send_errors);
544         else if (strcasecmp ("Prefix", child->key) == 0)
545             cf_util_get_string (child, &cb->prefix);
546         else if (strcasecmp ("Postfix", child->key) == 0)
547             cf_util_get_string (child, &cb->postfix);
548         else if (strcasecmp ("StoreRates", child->key) == 0)
549             cf_util_get_flag (child, &cb->format_flags,
550                     GRAPHITE_STORE_RATES);
551         else if (strcasecmp ("SeparateInstances", child->key) == 0)
552             cf_util_get_flag (child, &cb->format_flags,
553                     GRAPHITE_SEPARATE_INSTANCES);
554         else if (strcasecmp ("AlwaysAppendDS", child->key) == 0)
555             cf_util_get_flag (child, &cb->format_flags,
556                     GRAPHITE_ALWAYS_APPEND_DS);
557         else if (strcasecmp ("EscapeCharacter", child->key) == 0)
558             config_set_char (&cb->escape_char, child);
559         else
560         {
561             ERROR ("write_graphite plugin: Invalid configuration "
562                         "option: %s.", child->key);
563             status = -1;
564         }
565
566         if (status != 0)
567             break;
568     }
569
570     if (status != 0)
571     {
572         wg_callback_free (cb);
573         return (status);
574     }
575
576     /* FIXME: Legacy configuration syntax. */
577     if (cb->name == NULL)
578         ssnprintf (callback_name, sizeof (callback_name), "write_graphite/%s/%s/%s",
579                 cb->node, cb->service, cb->protocol);
580     else
581         ssnprintf (callback_name, sizeof (callback_name), "write_graphite/%s",
582                 cb->name);
583
584     memset (&user_data, 0, sizeof (user_data));
585     user_data.data = cb;
586     user_data.free_func = wg_callback_free;
587     plugin_register_write (callback_name, wg_write, &user_data);
588
589     user_data.free_func = NULL;
590     plugin_register_flush (callback_name, wg_flush, &user_data);
591
592     return (0);
593 }
594
595 static int wg_config (oconfig_item_t *ci)
596 {
597     int i;
598
599     for (i = 0; i < ci->children_num; i++)
600     {
601         oconfig_item_t *child = ci->children + i;
602
603         if (strcasecmp ("Node", child->key) == 0)
604             wg_config_node (child);
605         /* FIXME: Remove this legacy mode in version 6. */
606         else if (strcasecmp ("Carbon", child->key) == 0)
607             wg_config_node (child);
608         else
609         {
610             ERROR ("write_graphite plugin: Invalid configuration "
611                     "option: %s.", child->key);
612         }
613     }
614
615     return (0);
616 }
617
618 void module_register (void)
619 {
620     plugin_register_complex_config ("write_graphite", wg_config);
621 }
622
623 /* vim: set sw=4 ts=4 sts=4 tw=78 et : */