Code

zfs-arc plugin: check return value of malloc
[collectd.git] / src / write_tsdb.c
1 /**
2  * collectd - src/write_tsdb.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-2012  Florian octo Forster
8  * Copyright (C) 2013-2014  Limelight Networks, Inc.
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  * Based on the write_graphite plugin. 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  * write_tsdb Authors:
29  *   Brett Hawn <bhawn at llnw.com>
30  *   Kevin Bowling <kbowling@llnw.com>
31  **/
33 /* write_tsdb plugin configuation example
34  *
35  * <Plugin write_tsdb>
36  *   <Node>
37  *     Host "localhost"
38  *     Port "4242"
39  *     HostTags "status=production deviceclass=www"
40  *   </Node>
41  * </Plugin>
42  */
44 #include "collectd.h"
45 #include "common.h"
46 #include "plugin.h"
47 #include "configfile.h"
49 #include "utils_cache.h"
51 #include <pthread.h>
52 #include <sys/socket.h>
53 #include <netdb.h>
55 #ifndef WT_DEFAULT_NODE
56 # define WT_DEFAULT_NODE "localhost"
57 #endif
59 #ifndef WT_DEFAULT_SERVICE
60 # define WT_DEFAULT_SERVICE "4242"
61 #endif
63 #ifndef WT_DEFAULT_ESCAPE
64 # define WT_DEFAULT_ESCAPE '.'
65 #endif
67 /* Ethernet - (IPv6 + TCP) = 1500 - (40 + 32) = 1428 */
68 #ifndef WT_SEND_BUF_SIZE
69 # define WT_SEND_BUF_SIZE 1428
70 #endif
72 /*
73  * Private variables
74  */
75 struct wt_callback
76 {
77     int      sock_fd;
79     char     *node;
80     char     *service;
81     char     *host_tags;
83     _Bool    store_rates;
84     _Bool    always_append_ds;
86     char     send_buf[WT_SEND_BUF_SIZE];
87     size_t   send_buf_free;
88     size_t   send_buf_fill;
89     cdtime_t send_buf_init_time;
91     pthread_mutex_t send_lock;
92 };
95 /*
96  * Functions
97  */
98 static void wt_reset_buffer(struct wt_callback *cb)
99 {
100     memset(cb->send_buf, 0, sizeof(cb->send_buf));
101     cb->send_buf_free = sizeof(cb->send_buf);
102     cb->send_buf_fill = 0;
103     cb->send_buf_init_time = cdtime();
106 static int wt_send_buffer(struct wt_callback *cb)
108     ssize_t status = 0;
110     status = swrite(cb->sock_fd, cb->send_buf, strlen(cb->send_buf));
111     if (status < 0)
112     {
113         char errbuf[1024];
114         ERROR("write_tsdb plugin: send failed with status %zi (%s)",
115               status, sstrerror (errno, errbuf, sizeof (errbuf)));
117         close (cb->sock_fd);
118         cb->sock_fd = -1;
120         return -1;
121     }
123     return 0;
126 /* NOTE: You must hold cb->send_lock when calling this function! */
127 static int wt_flush_nolock(cdtime_t timeout, struct wt_callback *cb)
129     int status;
131     DEBUG("write_tsdb plugin: wt_flush_nolock: timeout = %.3f; "
132           "send_buf_fill = %zu;",
133           (double)timeout,
134           cb->send_buf_fill);
136     /* timeout == 0  => flush unconditionally */
137     if (timeout > 0)
138     {
139         cdtime_t now;
141         now = cdtime();
142         if ((cb->send_buf_init_time + timeout) > now)
143             return 0;
144     }
146     if (cb->send_buf_fill <= 0)
147     {
148         cb->send_buf_init_time = cdtime();
149         return 0;
150     }
152     status = wt_send_buffer(cb);
153     wt_reset_buffer(cb);
155     return status;
158 static int wt_callback_init(struct wt_callback *cb)
160     struct addrinfo ai_hints;
161     struct addrinfo *ai_list;
162     struct addrinfo *ai_ptr;
163     int status;
165     const char *node = cb->node ? cb->node : WT_DEFAULT_NODE;
166     const char *service = cb->service ? cb->service : WT_DEFAULT_SERVICE;
168     if (cb->sock_fd > 0)
169         return 0;
171     memset(&ai_hints, 0, sizeof(ai_hints));
172 #ifdef AI_ADDRCONFIG
173     ai_hints.ai_flags    |= AI_ADDRCONFIG;
174 #endif
175     ai_hints.ai_family   = AF_UNSPEC;
176     ai_hints.ai_socktype = SOCK_STREAM;
178     ai_list = NULL;
180     status = getaddrinfo(node, service, &ai_hints, &ai_list);
181     if (status != 0)
182     {
183         ERROR("write_tsdb plugin: getaddrinfo (%s, %s) failed: %s",
184               node, service, gai_strerror (status));
185         return -1;
186     }
188     assert (ai_list != NULL);
189     for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
190     {
191         cb->sock_fd = socket(ai_ptr->ai_family, ai_ptr->ai_socktype,
192                              ai_ptr->ai_protocol);
193         if (cb->sock_fd < 0)
194             continue;
196         status = connect(cb->sock_fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
197         if (status != 0)
198         {
199             close(cb->sock_fd);
200             cb->sock_fd = -1;
201             continue;
202         }
204         break;
205     }
207     freeaddrinfo(ai_list);
209     if (cb->sock_fd < 0)
210     {
211         char errbuf[1024];
212         ERROR("write_tsdb plugin: Connecting to %s:%s failed. "
213               "The last error was: %s", node, service,
214               sstrerror (errno, errbuf, sizeof(errbuf)));
215         close(cb->sock_fd);
216         return -1;
217     }
219     wt_reset_buffer(cb);
221     return 0;
224 static void wt_callback_free(void *data)
226     struct wt_callback *cb;
228     if (data == NULL)
229         return;
231     cb = data;
233     pthread_mutex_lock(&cb->send_lock);
235     wt_flush_nolock(0, cb);
237     close(cb->sock_fd);
238     cb->sock_fd = -1;
240     sfree(cb->node);
241     sfree(cb->service);
242     sfree(cb->host_tags);
244     pthread_mutex_destroy(&cb->send_lock);
246     sfree(cb);
249 static int wt_flush(cdtime_t timeout,
250                     const char *identifier __attribute__((unused)),
251                     user_data_t *user_data)
253     struct wt_callback *cb;
254     int status;
256     if (user_data == NULL)
257         return -EINVAL;
259     cb = user_data->data;
261     pthread_mutex_lock(&cb->send_lock);
263     if (cb->sock_fd < 0)
264     {
265         status = wt_callback_init(cb);
266         if (status != 0)
267         {
268             ERROR("write_tsdb plugin: wt_callback_init failed.");
269             pthread_mutex_unlock(&cb->send_lock);
270             return -1;
271         }
272     }
274     status = wt_flush_nolock(timeout, cb);
275     pthread_mutex_unlock(&cb->send_lock);
277     return status;
280 static int wt_format_values(char *ret, size_t ret_len,
281                             int ds_num, const data_set_t *ds,
282                             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(GAUGE_FORMAT, 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(GAUGE_FORMAT, 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 int wt_format_name(char *ret, int ret_len,
345                           const value_list_t *vl,
346                           const struct wt_callback *cb,
347                           const char *ds_name)
349     int status;
350     char *temp = NULL;
351     char *prefix = "";
352     const char *meta_prefix = "tsdb_prefix";
354     if (vl->meta) {
355         status = meta_data_get_string(vl->meta, meta_prefix, &temp);
356         if (status == -ENOENT) {
357             /* defaults to empty string */
358         } else if (status < 0) {
359             sfree(temp);
360             return status;
361         } else {
362             prefix = temp;
363         }
364     }
366     if (ds_name != NULL) {
367         if (vl->plugin_instance[0] == '\0') {
368             if (vl->type_instance[0] == '\0') {
369                 ssnprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin,
370                         vl->type, ds_name);
371             } else {
372                 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin,
373                         vl->type, vl->type_instance, ds_name);
374             }
375         } else { /* vl->plugin_instance != "" */
376             if (vl->type_instance[0] == '\0') {
377                 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin,
378                         vl->plugin_instance, vl->type, ds_name);
379             } else {
380                 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s.%s", prefix,
381                         vl->plugin, vl->plugin_instance, vl->type,
382                         vl->type_instance, ds_name);
383             }
384         }
385     } else { /* ds_name == NULL */
386         if (vl->plugin_instance[0] == '\0') {
387             if (vl->type_instance[0] == '\0') {
388                 ssnprintf(ret, ret_len, "%s%s.%s", prefix, vl->plugin,
389                         vl->type);
390             } else {
391                 ssnprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin,
392                         vl->type_instance, vl->type);
393             }
394         } else { /* vl->plugin_instance != "" */
395             if (vl->type_instance[0] == '\0') {
396                 ssnprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin,
397                         vl->plugin_instance, vl->type);
398             } else {
399                 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin,
400                         vl->plugin_instance, vl->type, vl->type_instance);
401             }
402         }
403     }
405     sfree(temp);
406     return 0;
409 static int wt_send_message (const char* key, const char* value,
410                             cdtime_t time, struct wt_callback *cb,
411                             const char* host, meta_data_t *md)
413     int status;
414     int message_len;
415     char *temp = NULL;
416     char *tags = "";
417     char message[1024];
418     char *host_tags = cb->host_tags ? cb->host_tags : "";
419     const char *meta_tsdb = "tsdb_tags";
421     /* skip if value is NaN */
422     if (value[0] == 'n')
423         return 0;
425     if (md) {
426         status = meta_data_get_string(md, meta_tsdb, &temp);
427         if (status == -ENOENT) {
428             /* defaults to empty string */
429         } else if (status < 0) {
430             ERROR("write_tsdb plugin: tags metadata get failure");
431             sfree(temp);
432             pthread_mutex_unlock(&cb->send_lock);
433             return status;
434         } else {
435             tags = temp;
436         }
437     }
439     message_len = ssnprintf (message,
440                              sizeof(message),
441                              "put %s %.0f %s fqdn=%s %s %s\r\n",
442                              key,
443                              CDTIME_T_TO_DOUBLE(time),
444                              value,
445                              host,
446                              tags,
447                              host_tags);
449     sfree(temp);
451     if (message_len >= sizeof(message)) {
452         ERROR("write_tsdb plugin: message buffer too small: "
453               "Need %d bytes.", message_len + 1);
454         return -1;
455     }
457     pthread_mutex_lock(&cb->send_lock);
459     if (cb->sock_fd < 0)
460     {
461         status = wt_callback_init(cb);
462         if (status != 0)
463         {
464             ERROR("write_tsdb plugin: wt_callback_init failed.");
465             pthread_mutex_unlock(&cb->send_lock);
466             return -1;
467         }
468     }
470     if (message_len >= cb->send_buf_free)
471     {
472         status = wt_flush_nolock(0, cb);
473         if (status != 0)
474         {
475             pthread_mutex_unlock(&cb->send_lock);
476             return status;
477         }
478     }
480     /* Assert that we have enough space for this message. */
481     assert(message_len < cb->send_buf_free);
483     /* `message_len + 1' because `message_len' does not include the
484      * trailing null byte. Neither does `send_buffer_fill'. */
485     memcpy(cb->send_buf + cb->send_buf_fill,
486             message, message_len + 1);
487     cb->send_buf_fill += message_len;
488     cb->send_buf_free -= message_len;
490     DEBUG("write_tsdb plugin: [%s]:%s buf %zu/%zu (%.1f %%) \"%s\"",
491           cb->node,
492           cb->service,
493           cb->send_buf_fill, sizeof(cb->send_buf),
494           100.0 * ((double) cb->send_buf_fill) /
495           ((double) sizeof(cb->send_buf)),
496           message);
498     pthread_mutex_unlock(&cb->send_lock);
500     return 0;
503 static int wt_write_messages(const data_set_t *ds, const value_list_t *vl,
504                              struct wt_callback *cb)
506     char key[10*DATA_MAX_NAME_LEN];
507     char values[512];
509     int status, i;
511     if (0 != strcmp(ds->type, vl->type))
512     {
513         ERROR("write_tsdb plugin: DS type does not match "
514               "value list type");
515         return -1;
516     }
518     for (i = 0; i < ds->ds_num; i++)
519     {
520         const char *ds_name = NULL;
522         if (cb->always_append_ds || (ds->ds_num > 1))
523             ds_name = ds->ds[i].name;
525         /* Copy the identifier to 'key' and escape it. */
526         status = wt_format_name(key, sizeof(key), vl, cb, ds_name);
527         if (status != 0)
528         {
529             ERROR("write_tsdb plugin: error with format_name");
530             return status;
531         }
533         escape_string(key, sizeof(key));
534         /* Convert the values to an ASCII representation and put that into
535          * 'values'. */
536         status = wt_format_values(values, sizeof(values), i, ds, vl,
537                                   cb->store_rates);
538         if (status != 0)
539         {
540             ERROR("write_tsdb plugin: error with "
541                   "wt_format_values");
542             return status;
543         }
545         /* Send the message to tsdb */
546         status = wt_send_message(key, values, vl->time, cb, vl->host, vl->meta);
547         if (status != 0)
548         {
549             ERROR("write_tsdb plugin: error with "
550                   "wt_send_message");
551             return status;
552         }
553     }
555     return 0;
558 static int wt_write(const data_set_t *ds, const value_list_t *vl,
559                     user_data_t *user_data)
561     struct wt_callback *cb;
562     int status;
564     if (user_data == NULL)
565         return EINVAL;
567     cb = user_data->data;
569     status = wt_write_messages(ds, vl, cb);
571     return status;
574 static int wt_config_tsd(oconfig_item_t *ci)
576     struct wt_callback *cb;
577     user_data_t user_data;
578     char callback_name[DATA_MAX_NAME_LEN];
579     int i;
581     cb = malloc(sizeof(*cb));
582     if (cb == NULL)
583     {
584         ERROR("write_tsdb plugin: malloc failed.");
585         return -1;
586     }
587     memset(cb, 0, sizeof(*cb));
588     cb->sock_fd = -1;
589     cb->node = NULL;
590     cb->service = NULL;
591     cb->host_tags = NULL;
592     cb->store_rates = 0;
594     pthread_mutex_init (&cb->send_lock, NULL);
596     for (i = 0; i < ci->children_num; i++)
597     {
598         oconfig_item_t *child = ci->children + i;
600         if (strcasecmp("Host", child->key) == 0)
601             cf_util_get_string(child, &cb->node);
602         else if (strcasecmp("Port", child->key) == 0)
603             cf_util_get_service(child, &cb->service);
604         else if (strcasecmp("HostTags", child->key) == 0)
605             cf_util_get_string(child, &cb->host_tags);
606         else if (strcasecmp("StoreRates", child->key) == 0)
607             cf_util_get_boolean(child, &cb->store_rates);
608         else if (strcasecmp("AlwaysAppendDS", child->key) == 0)
609             cf_util_get_boolean(child, &cb->always_append_ds);
610         else
611         {
612             ERROR("write_tsdb plugin: Invalid configuration "
613                   "option: %s.", child->key);
614         }
615     }
617     ssnprintf(callback_name, sizeof(callback_name), "write_tsdb/%s/%s",
618               cb->node != NULL ? cb->node : WT_DEFAULT_NODE,
619               cb->service != NULL ? cb->service : WT_DEFAULT_SERVICE);
621     memset(&user_data, 0, sizeof(user_data));
622     user_data.data = cb;
623     user_data.free_func = wt_callback_free;
624     plugin_register_write(callback_name, wt_write, &user_data);
626     user_data.free_func = NULL;
627     plugin_register_flush(callback_name, wt_flush, &user_data);
629     return 0;
632 static int wt_config(oconfig_item_t *ci)
634     int i;
636     for (i = 0; i < ci->children_num; i++)
637     {
638         oconfig_item_t *child = ci->children + i;
640         if (strcasecmp("Node", child->key) == 0)
641             wt_config_tsd(child);
642         else
643         {
644             ERROR("write_tsdb plugin: Invalid configuration "
645                   "option: %s.", child->key);
646         }
647     }
649     return 0;
652 void module_register(void)
654     plugin_register_complex_config("write_tsdb", wt_config);
657 /* vim: set sw=4 ts=4 sts=4 tw=78 et : */