Code

bring back prefix/postfix handling. simplify swap_chars.
[collectd.git] / src / write_graphite.c
1 /**
2  * collectd - src/write_graphite.c
3  * Copyright (C) 2011  Scott Sanders
4  *
5  * This program is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License as published by the
7  * Free Software Foundation; only version 2 of the License is applicable.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License along
15  * with this program; if not, write to the Free Software Foundation, Inc.,
16  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
17  *
18  * Author:
19  *   Scott Sanders <scott@jssjr.com>
20  *
21  *   based on the excellent write_http plugin
22  **/
24  /* write_graphite plugin configuation example
25   *
26   * <Plugin write_graphite>
27   *   <Carbon>
28   *     Host "localhost"
29   *     Port "2003"
30   *     Prefix "collectd"
31   *   </Carbon>
32   * </Plugin>
33   */
35 #include "collectd.h"
36 #include "common.h"
37 #include "plugin.h"
38 #include "configfile.h"
40 #include "utils_cache.h"
41 #include "utils_parse_option.h"
43 /* Folks without pthread will need to disable this plugin. */
44 #include <pthread.h>
46 #include <sys/socket.h>
47 #include <sys/stat.h>
48 #include <sys/types.h>
50 #include <netinet/in.h>
51 #include <netdb.h>
53 #ifndef WG_FORMAT_NAME
54 #define WG_FORMAT_NAME(ret, ret_len, vl, cb, name) \
55         wg_format_name (ret, ret_len, (vl)->host, (vl)->plugin, \
56                          (vl)->plugin_instance, (vl)->type, \
57                          (vl)->type_instance, (cb)->prefix, (cb)->postfix, \
58                          name, (cb)->dotchar)
59 #endif
61 #ifndef WG_DEFAULT_NODE
62 # define WG_DEFAULT_NODE "localhost"
63 #endif
65 #ifndef WG_DEFAULT_SERVICE
66 # define WG_DEFAULT_SERVICE "2003"
67 #endif
69 #ifndef WG_SEND_BUF_SIZE
70 # define WG_SEND_BUF_SIZE 4096
71 #endif
73 /*
74  * Private variables
75  */
76 struct wg_callback
77 {
78     int      sock_fd;
79     struct hostent *server;
81     char    *node;
82     char    *service;
83     char    *prefix;
84     char    *postfix;
85     char     dotchar;
87     char     send_buf[WG_SEND_BUF_SIZE];
88     size_t   send_buf_free;
89     size_t   send_buf_fill;
90     cdtime_t send_buf_init_time;
92     pthread_mutex_t send_lock;
93 };
96 /*
97  * Functions
98  */
99 static void wg_reset_buffer (struct wg_callback *cb)
101     memset (cb->send_buf, 0, sizeof (cb->send_buf));
102     cb->send_buf_free = sizeof (cb->send_buf);
103     cb->send_buf_fill = 0;
104     cb->send_buf_init_time = cdtime ();
107 static int wg_send_buffer (struct wg_callback *cb)
109     int status = 0;
111     status = write (cb->sock_fd, cb->send_buf, strlen (cb->send_buf));
112     if (status < 0)
113     {
114         ERROR ("write_graphite plugin: send failed with "
115                 "status %i (%s)",
116                 status,
117                 strerror (errno));
119         pthread_mutex_trylock (&cb->send_lock);
121         DEBUG ("write_graphite plugin: closing socket and restting fd "
122                 "so reinit will occur");
123         close (cb->sock_fd);
124         cb->sock_fd = -1;
126         pthread_mutex_unlock (&cb->send_lock);
128         return (-1);
129     }
130     return (0);
133 static int wg_flush_nolock (cdtime_t timeout, struct wg_callback *cb)
135     int status;
137     DEBUG ("write_graphite plugin: wg_flush_nolock: timeout = %.3f; "
138             "send_buf_fill = %zu;",
139             (double)timeout,
140             cb->send_buf_fill);
142     /* timeout == 0  => flush unconditionally */
143     if (timeout > 0)
144     {
145         cdtime_t now;
147         now = cdtime ();
148         if ((cb->send_buf_init_time + timeout) > now)
149             return (0);
150     }
152     if (cb->send_buf_fill <= 0)
153     {
154         cb->send_buf_init_time = cdtime ();
155         return (0);
156     }
158     status = wg_send_buffer (cb);
159     wg_reset_buffer (cb);
161     return (status);
164 static int wg_callback_init (struct wg_callback *cb)
166     struct addrinfo ai_hints;
167     struct addrinfo *ai_list;
168     struct addrinfo *ai_ptr;
169     int status;
171     const char *node = cb->node ? cb->node : WG_DEFAULT_NODE;
172     const char *service = cb->service ? cb->service : WG_DEFAULT_SERVICE;
174     if (cb->sock_fd > 0)
175         return (0);
177     memset (&ai_hints, 0, sizeof (ai_hints));
178 #ifdef AI_ADDRCONFIG
179     ai_hints.ai_flags |= AI_ADDRCONFIG;
180 #endif
181     ai_hints.ai_family = AF_UNSPEC;
182     ai_hints.ai_socktype = SOCK_STREAM;
184     ai_list = NULL;
186     status = getaddrinfo (node, service, &ai_hints, &ai_list);
187     if (status != 0)
188     {
189         ERROR ("write_graphite plugin: getaddrinfo (%s, %s) failed: %s",
190                 node, service, gai_strerror (status));
191         return (-1);
192     }
194     assert (ai_list != NULL);
195     for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
196     {
197         cb->sock_fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype,
198                 ai_ptr->ai_protocol);
199         if (cb->sock_fd < 0)
200             continue;
202         status = connect (cb->sock_fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
203         if (status != 0)
204         {
205             close (cb->sock_fd);
206             cb->sock_fd = -1;
207             continue;
208         }
210         break;
211     }
213     freeaddrinfo (ai_list);
215     if (cb->sock_fd < 0)
216     {
217         char errbuf[1024];
218         ERROR ("write_graphite plugin: Connecting to %s:%s failed. "
219                 "The last error was: %s", node, service,
220                 sstrerror (errno, errbuf, sizeof (errbuf)));
221         close (cb->sock_fd);
222         return (-1);
223     }
225     wg_reset_buffer (cb);
227     return (0);
230 static void wg_callback_free (void *data)
232     struct wg_callback *cb;
234     if (data == NULL)
235         return;
237     cb = data;
239     wg_flush_nolock (/* timeout = */ 0, cb);
241     close(cb->sock_fd);
242     sfree(cb->node);
243     sfree(cb->service);
244     sfree(cb->prefix);
245     sfree(cb->postfix);
247     sfree(cb);
250 static int wg_flush (cdtime_t timeout,
251         const char *identifier __attribute__((unused)),
252         user_data_t *user_data)
254     struct wg_callback *cb;
255     int status;
257     if (user_data == NULL)
258         return (-EINVAL);
260     cb = user_data->data;
262     pthread_mutex_lock (&cb->send_lock);
264     if (cb->sock_fd < 0)
265     {
266         status = wg_callback_init (cb);
267         if (status != 0)
268         {
269             ERROR ("write_graphite plugin: wg_callback_init failed.");
270             pthread_mutex_unlock (&cb->send_lock);
271             return (-1);
272         }
273     }
275     status = wg_flush_nolock (timeout, cb);
276     pthread_mutex_unlock (&cb->send_lock);
278     return (status);
281 static int wg_format_values (char *ret, size_t ret_len,
282         int ds_num, const data_set_t *ds, const value_list_t *vl,
283         _Bool store_rates)
285     size_t offset = 0;
286     int status;
287     gauge_t *rates = NULL;
289     assert (0 == strcmp (ds->type, vl->type));
291     memset (ret, 0, ret_len);
293 #define BUFFER_ADD(...) do { \
294     status = ssnprintf (ret + offset, ret_len - offset, \
295             __VA_ARGS__); \
296     if (status < 1) \
297     { \
298         sfree (rates); \
299         return (-1); \
300     } \
301     else if (((size_t) status) >= (ret_len - offset)) \
302     { \
303         sfree (rates); \
304         return (-1); \
305     } \
306     else \
307     offset += ((size_t) status); \
308 } while (0)
310     if (ds->ds[ds_num].type == DS_TYPE_GAUGE)
311         BUFFER_ADD ("%f", vl->values[ds_num].gauge);
312     else if (store_rates)
313     {
314         if (rates == NULL)
315             rates = uc_get_rate (ds, vl);
316         if (rates == NULL)
317         {
318             WARNING ("format_values: "
319                     "uc_get_rate failed.");
320             return (-1);
321         }
322         BUFFER_ADD ("%g", rates[ds_num]);
323     }
324     else if (ds->ds[ds_num].type == DS_TYPE_COUNTER)
325         BUFFER_ADD ("%llu", vl->values[ds_num].counter);
326     else if (ds->ds[ds_num].type == DS_TYPE_DERIVE)
327         BUFFER_ADD ("%"PRIi64, vl->values[ds_num].derive);
328     else if (ds->ds[ds_num].type == DS_TYPE_ABSOLUTE)
329         BUFFER_ADD ("%"PRIu64, vl->values[ds_num].absolute);
330     else
331     {
332         ERROR ("format_values plugin: Unknown data source type: %i",
333                 ds->ds[ds_num].type);
334         sfree (rates);
335         return (-1);
336     }
338 #undef BUFFER_ADD
340     sfree (rates);
341     return (0);
344 static void swap_chars (char *dst, const char *src,
345         const char from, const char to)
347     size_t i;
349     for (i = 0; i < strlen(src) ; i++)
350     {
351         if (src[i] == from)
352             dst[i] = to;
353         else
354             dst[i] = src[i];
355     }
356     dst[i] = '\0';
359 static int wg_format_name (char *ret, int ret_len,
360         const char *hostname,
361         const char *plugin, const char *plugin_instance,
362         const char *type, const char *type_instance,
363         const char *prefix, const char *postfix,
364         const char *ds_name, const char dotchar)
366     int  status;
367     char *n_hostname = NULL;
368     char *n_plugin = NULL;
369     char *n_plugin_instance = NULL;
370     char *n_type = NULL;
371     char *n_type_instance = NULL;
373     assert (plugin != NULL);
374     assert (type != NULL);
376     if (prefix == NULL)
377         prefix = "";
379     if (postfix == NULL)
380         postfix = "";
382     if ((n_hostname = malloc(strlen(hostname)+1)) == NULL)
383     {
384         ERROR ("Unable to allocate memory for normalized hostname buffer");
385         return (-1);
386     }
388     if ((n_plugin = malloc(strlen(plugin)+1)) == NULL)
389     {
390         ERROR ("Unable to allocate memory for normalized plugin buffer");
391         return (-1);
392     }
394     if ((n_type = malloc(strlen(type)+1)) == NULL)
395     {
396         ERROR ("Unable to allocate memory for normalized type buffer");
397         return (-1);
398     }
400     swap_chars(n_hostname, hostname, '.', dotchar);
401     swap_chars(n_plugin, plugin, ' ', '_');
402     swap_chars(n_type, type, ' ', '_');
404     if (type_instance != NULL && type_instance[0] != '\0')
405     {
406         if ((n_type_instance = malloc(strlen(type_instance)+1)) == NULL)
407         {
408             ERROR ("Unable to allocate memory for normalized datasource name buffer");
409             return (-1);
410         }
411         swap_chars(n_type_instance, type_instance, '.', dotchar);
412         swap_chars(n_type_instance, type_instance, ' ', '_');
413     }
415     if (plugin_instance != NULL && plugin_instance[0] != '\0')
416     {
417         if ((n_plugin_instance = malloc(strlen(plugin_instance)+1)) == NULL)
418         {
419             ERROR ("Unable to allocate memory for normalized plugin instance buffer");
420             return (-1);
421         }
422         swap_chars(n_plugin_instance, plugin_instance, ' ', '_');
423     }
425     if ((n_plugin_instance == NULL) || (n_plugin_instance[0] == '\0'))
426     {
427         if ((n_type_instance == NULL) || (n_type_instance[0] == '\0'))
428         {
429             if ((ds_name == NULL) || (ds_name[0] == '\0'))
430                 status = ssnprintf (ret, ret_len, "%s%s%s.%s.%s",
431                         prefix, n_hostname, postfix, n_plugin, n_type);
432             else
433                 status = ssnprintf (ret, ret_len, "%s%s%s.%s.%s.%s",
434                         prefix, n_hostname, postfix, n_plugin, n_type, ds_name);
435         }
436         else
437         {
438             if ((ds_name == NULL) || (ds_name[0] == '\0'))
439                 status = ssnprintf (ret, ret_len, "%s%s%s.%s.%s-%s",
440                         prefix, n_hostname, postfix, n_plugin, n_type,
441                         n_type_instance);
442             else
443                 status = ssnprintf (ret, ret_len, "%s%s%s.%s.%s-%s.%s",
444                         prefix, n_hostname, postfix, n_plugin, n_type,
445                         n_type_instance, ds_name);
446         }
447     }
448     else
449     {
450         if ((n_type_instance == NULL) || (n_type_instance[0] == '\0'))
451         {
452             if ((ds_name == NULL) || (ds_name[0] == '\0'))
453                 status = ssnprintf (ret, ret_len, "%s%s%s.%s.%s.%s",
454                         prefix, n_hostname, postfix, n_plugin,
455                         n_plugin_instance, n_type);
456             else
457                 status = ssnprintf (ret, ret_len, "%s%s%s.%s.%s.%s.%s",
458                         prefix, n_hostname, postfix, n_plugin,
459                         n_plugin_instance, n_type, ds_name);
460         }
461         else
462         {
463             if ((ds_name == NULL) || (ds_name[0] == '\0'))
464                 status = ssnprintf (ret, ret_len, "%s%s%s.%s.%s.%s-%s",
465                         prefix, n_hostname, postfix, n_plugin,
466                         n_plugin_instance, n_type, n_type_instance);
467             else
468                 status = ssnprintf (ret, ret_len, "%s%s%s.%s.%s.%s-%s.%s",
469                         prefix, n_hostname, postfix, n_plugin,
470                         n_plugin_instance, n_type, n_type_instance, ds_name);
471         }
472     }
474     sfree(n_hostname);
475     sfree(n_type_instance);
476     sfree(n_type);
477     sfree(n_plugin);
478     sfree(n_plugin_instance);
480     if ((status < 1) || (status >= ret_len))
481         return (-1);
482     return (0);
485 static int wg_send_message (const char* key, const char* value,
486         cdtime_t time, struct wg_callback *cb)
488     int status;
489     size_t message_len;
490     char message[1024];
492     message_len = (size_t) ssnprintf (message, sizeof (message),
493             "%s %s %.0f\n",
494             key,
495             value,
496             CDTIME_T_TO_DOUBLE(time));
497     if (message_len >= sizeof (message)) {
498         ERROR ("write_graphite plugin: message buffer too small: "
499                 "Need %zu bytes.", message_len + 1);
500         return (-1);
501     }
504     pthread_mutex_lock (&cb->send_lock);
506     if (cb->sock_fd < 0)
507     {
508         status = wg_callback_init (cb);
509         if (status != 0)
510         {
511             ERROR ("write_graphite plugin: wg_callback_init failed.");
512             pthread_mutex_unlock (&cb->send_lock);
513             return (-1);
514         }
515     }
517     if (message_len >= cb->send_buf_free)
518     {
519         status = wg_flush_nolock (/* timeout = */ 0, cb);
520         if (status != 0)
521         {
522             pthread_mutex_unlock (&cb->send_lock);
523             return (status);
524         }
525     }
526     assert (message_len < cb->send_buf_free);
528     /* `message_len + 1' because `message_len' does not include the
529      * trailing null byte. Neither does `send_buffer_fill'. */
530     memcpy (cb->send_buf + cb->send_buf_fill,
531             message, message_len + 1);
532     cb->send_buf_fill += message_len;
533     cb->send_buf_free -= message_len;
535     DEBUG ("write_graphite plugin: <%s:%s> buf %zu/%zu (%g%%) \"%s\"",
536             cb->node,
537             cb->service,
538             cb->send_buf_fill, sizeof (cb->send_buf),
539             100.0 * ((double) cb->send_buf_fill) / ((double) sizeof (cb->send_buf)),
540             message);
542     /* Check if we have enough space for this message. */
543     pthread_mutex_unlock (&cb->send_lock);
545     return (0);
548 static int wg_write_messages (const data_set_t *ds, const value_list_t *vl,
549         struct wg_callback *cb)
551     char key[10*DATA_MAX_NAME_LEN];
552     char values[512];
554     int status, i;
556     if (0 != strcmp (ds->type, vl->type))
557     {
558         ERROR ("write_graphite plugin: DS type does not match "
559                 "value list type");
560         return -1;
561     }
563     if (ds->ds_num > 1)
564     {
565         for (i = 0; i < ds->ds_num; i++)
566         {
567             /* Copy the identifier to `key' and escape it. */
568             status = WG_FORMAT_NAME (key, sizeof (key), vl, cb, ds->ds[i].name);
569             if (status != 0)
570             {
571                 ERROR ("write_graphite plugin: error with format_name");
572                 return (status);
573             }
575             escape_string (key, sizeof (key));
576             /* Convert the values to an ASCII representation and put that
577              * into `values'. */
578             status = wg_format_values (values, sizeof (values), i, ds, vl, 0);
579             if (status != 0)
580             {
581                 ERROR ("write_graphite plugin: error with "
582                         "wg_format_values");
583                 return (status);
584             }
586             /* Send the message to graphite */
587             status = wg_send_message (key, values, vl->time, cb);
588             if (status != 0)
589             {
590                 ERROR ("write_graphite plugin: error with "
591                         "wg_send_message");
592                 return (status);
593             }
594         }
595     }
596     else
597     {
598         /* Copy the identifier to `key' and escape it. */
599         status = WG_FORMAT_NAME (key, sizeof (key), vl, cb, NULL);
600         if (status != 0)
601         {
602             ERROR ("write_graphite plugin: error with format_name");
603             return (status);
604         }
606         escape_string (key, sizeof (key));
607         /* Convert the values to an ASCII representation and put that into
608          * `values'. */
609         status = wg_format_values (values, sizeof (values), 0, ds, vl, 0);
610         if (status != 0)
611         {
612             ERROR ("write_graphite plugin: error with "
613                     "wg_format_values");
614             return (status);
615         }
617         /* Send the message to graphite */
618         status = wg_send_message (key, values, vl->time, cb);
619         if (status != 0)
620         {
621             ERROR ("write_graphite plugin: error with "
622                     "wg_send_message");
623             return (status);
624         }
625     }
627     return (0);
630 static int wg_write (const data_set_t *ds, const value_list_t *vl,
631         user_data_t *user_data)
633     struct wg_callback *cb;
634     int status;
636     if (user_data == NULL)
637         return (-EINVAL);
639     cb = user_data->data;
641     status = wg_write_messages (ds, vl, cb);
643     return (status);
646 static int config_set_char (char *dest,
647         oconfig_item_t *ci)
649     if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
650     {
651         WARNING ("write_graphite plugin: The `%s' config option "
652                 "needs exactly one string argument.", ci->key);
653         return (-1);
654     }
656     *dest = ci->values[0].value.string[0];
658     return (0);
661 static int wg_config_carbon (oconfig_item_t *ci)
663     struct wg_callback *cb;
664     user_data_t user_data;
665     int i;
667     cb = malloc (sizeof (*cb));
668     if (cb == NULL)
669     {
670         ERROR ("write_graphite plugin: malloc failed.");
671         return (-1);
672     }
673     memset (cb, 0, sizeof (*cb));
674     cb->sock_fd = -1;
675     cb->node = NULL;
676     cb->service = NULL;
677     cb->prefix = NULL;
678     cb->postfix = NULL;
679     cb->server = NULL;
680     cb->dotchar = '_';
682     pthread_mutex_init (&cb->send_lock, /* attr = */ NULL);
684     for (i = 0; i < ci->children_num; i++)
685     {
686         oconfig_item_t *child = ci->children + i;
688         if (strcasecmp ("Host", child->key) == 0)
689             cf_util_get_string (child, &cb->node);
690         else if (strcasecmp ("Port", child->key) == 0)
691             cf_util_get_string (child, &cb->service);
692         else if (strcasecmp ("Prefix", child->key) == 0)
693             cf_util_get_string (child, &cb->prefix);
694         else if (strcasecmp ("Postfix", child->key) == 0)
695             cf_util_get_string (child, &cb->postfix);
696         else if (strcasecmp ("DotCharacter", child->key) == 0)
697             config_set_char (&cb->dotchar, child);
698         else
699         {
700             ERROR ("write_graphite plugin: Invalid configuration "
701                         "option: %s.", child->key);
702         }
703     }
705     DEBUG ("write_graphite: Registering write callback to carbon agent %s:%s",
706             cb->node ? cb->node : WG_DEFAULT_NODE,
707             cb->service ? cb->service : WG_DEFAULT_SERVICE);
709     memset (&user_data, 0, sizeof (user_data));
710     user_data.data = cb;
711     user_data.free_func = NULL;
712     plugin_register_flush ("write_graphite", wg_flush, &user_data);
714     user_data.free_func = wg_callback_free;
715     plugin_register_write ("write_graphite", wg_write, &user_data);
717     return (0);
720 static int wg_config (oconfig_item_t *ci)
722     int i;
724     for (i = 0; i < ci->children_num; i++)
725     {
726         oconfig_item_t *child = ci->children + i;
728         if (strcasecmp ("Carbon", child->key) == 0)
729             wg_config_carbon (child);
730         else
731         {
732             ERROR ("write_graphite plugin: Invalid configuration "
733                     "option: %s.", child->key);
734         }
735     }
737     return (0);
740 void module_register (void)
742     plugin_register_complex_config ("write_graphite", wg_config);
745 /* vim: set sw=4 ts=4 sts=4 tw=78 et : */