csv plugin: fix implicit conversion warning
[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  **/
32
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  */
43
44 #include "collectd.h"
45
46 #include "common.h"
47 #include "plugin.h"
48 #include "utils_cache.h"
49 #include "utils_random.h"
50
51 #include <netdb.h>
52
53 #ifndef WT_DEFAULT_NODE
54 #define WT_DEFAULT_NODE "localhost"
55 #endif
56
57 #ifndef WT_DEFAULT_SERVICE
58 #define WT_DEFAULT_SERVICE "4242"
59 #endif
60
61 #ifndef WT_DEFAULT_ESCAPE
62 #define WT_DEFAULT_ESCAPE '.'
63 #endif
64
65 /* Ethernet - (IPv6 + TCP) = 1500 - (40 + 32) = 1428 */
66 #ifndef WT_SEND_BUF_SIZE
67 #define WT_SEND_BUF_SIZE 1428
68 #endif
69
70 /*
71  * Private variables
72  */
73 struct wt_callback {
74   struct addrinfo *ai;
75   cdtime_t ai_last_update;
76   int sock_fd;
77
78   char *node;
79   char *service;
80   char *host_tags;
81
82   bool store_rates;
83   bool always_append_ds;
84
85   char send_buf[WT_SEND_BUF_SIZE];
86   size_t send_buf_free;
87   size_t send_buf_fill;
88   cdtime_t send_buf_init_time;
89
90   pthread_mutex_t send_lock;
91
92   bool connect_failed_log_enabled;
93   int connect_dns_failed_attempts_remaining;
94   cdtime_t next_random_ttl;
95 };
96
97 static cdtime_t resolve_interval;
98 static cdtime_t resolve_jitter;
99
100 /*
101  * Functions
102  */
103 static void wt_reset_buffer(struct wt_callback *cb) {
104   memset(cb->send_buf, 0, sizeof(cb->send_buf));
105   cb->send_buf_free = sizeof(cb->send_buf);
106   cb->send_buf_fill = 0;
107   cb->send_buf_init_time = cdtime();
108 }
109
110 static int wt_send_buffer(struct wt_callback *cb) {
111   ssize_t status = 0;
112
113   status = swrite(cb->sock_fd, cb->send_buf, strlen(cb->send_buf));
114   if (status != 0) {
115     ERROR("write_tsdb plugin: send failed with status %zi (%s)", status,
116           STRERRNO);
117
118     close(cb->sock_fd);
119     cb->sock_fd = -1;
120
121     return -1;
122   }
123
124   return 0;
125 }
126
127 /* NOTE: You must hold cb->send_lock when calling this function! */
128 static int wt_flush_nolock(cdtime_t timeout, struct wt_callback *cb) {
129   int status;
130
131   DEBUG("write_tsdb plugin: wt_flush_nolock: timeout = %.3f; "
132         "send_buf_fill = %" PRIsz ";",
133         (double)timeout, cb->send_buf_fill);
134
135   /* timeout == 0  => flush unconditionally */
136   if (timeout > 0) {
137     cdtime_t now;
138
139     now = cdtime();
140     if ((cb->send_buf_init_time + timeout) > now)
141       return 0;
142   }
143
144   if (cb->send_buf_fill == 0) {
145     cb->send_buf_init_time = cdtime();
146     return 0;
147   }
148
149   status = wt_send_buffer(cb);
150   wt_reset_buffer(cb);
151
152   return status;
153 }
154
155 static cdtime_t new_random_ttl(void) {
156   if (resolve_jitter == 0)
157     return 0;
158
159   return (cdtime_t)cdrand_range(0, (long)resolve_jitter);
160 }
161
162 static int wt_callback_init(struct wt_callback *cb) {
163   int status;
164   cdtime_t now;
165
166   const char *node = cb->node ? cb->node : WT_DEFAULT_NODE;
167   const char *service = cb->service ? cb->service : WT_DEFAULT_SERVICE;
168
169   if (cb->sock_fd > 0)
170     return 0;
171
172   now = cdtime();
173   if (cb->ai) {
174     /* When we are here, we still have the IP in cache.
175      * If we have remaining attempts without calling the DNS, we update the
176      * last_update date so we keep the info until next time.
177      * If there is no more attempts, we need to flush the cache.
178      */
179
180     if ((cb->ai_last_update + resolve_interval + cb->next_random_ttl) < now) {
181       cb->next_random_ttl = new_random_ttl();
182       if (cb->connect_dns_failed_attempts_remaining > 0) {
183         /* Warning : this is run under send_lock mutex.
184          * This is why we do not use another mutex here.
185          * */
186         cb->ai_last_update = now;
187         cb->connect_dns_failed_attempts_remaining--;
188       } else {
189         freeaddrinfo(cb->ai);
190         cb->ai = NULL;
191       }
192     }
193   }
194
195   if (cb->ai == NULL) {
196     if ((cb->ai_last_update + resolve_interval + cb->next_random_ttl) >= now) {
197       DEBUG("write_tsdb plugin: too many getaddrinfo(%s, %s) failures", node,
198             service);
199       return -1;
200     }
201     cb->ai_last_update = now;
202     cb->next_random_ttl = new_random_ttl();
203
204     struct addrinfo ai_hints = {
205         .ai_family = AF_UNSPEC,
206         .ai_flags = AI_ADDRCONFIG,
207         .ai_socktype = SOCK_STREAM,
208     };
209
210     status = getaddrinfo(node, service, &ai_hints, &cb->ai);
211     if (status != 0) {
212       if (cb->ai) {
213         freeaddrinfo(cb->ai);
214         cb->ai = NULL;
215       }
216       if (cb->connect_failed_log_enabled) {
217         ERROR("write_tsdb plugin: getaddrinfo(%s, %s) failed: %s", node,
218               service, gai_strerror(status));
219         cb->connect_failed_log_enabled = 0;
220       }
221       return -1;
222     }
223   }
224
225   assert(cb->ai != NULL);
226   for (struct addrinfo *ai = cb->ai; ai != NULL; ai = ai->ai_next) {
227     cb->sock_fd = socket(ai->ai_family, ai->ai_socktype, ai->ai_protocol);
228     if (cb->sock_fd < 0)
229       continue;
230
231     set_sock_opts(cb->sock_fd);
232
233     status = connect(cb->sock_fd, ai->ai_addr, ai->ai_addrlen);
234     if (status != 0) {
235       close(cb->sock_fd);
236       cb->sock_fd = -1;
237       continue;
238     }
239
240     break;
241   }
242
243   if (cb->sock_fd < 0) {
244     ERROR("write_tsdb plugin: Connecting to %s:%s failed. "
245           "The last error was: %s",
246           node, service, STRERRNO);
247     return -1;
248   }
249
250   if (0 == cb->connect_failed_log_enabled) {
251     WARNING("write_tsdb plugin: Connecting to %s:%s succeeded.", node, service);
252     cb->connect_failed_log_enabled = 1;
253   }
254   cb->connect_dns_failed_attempts_remaining = 1;
255
256   wt_reset_buffer(cb);
257
258   return 0;
259 }
260
261 static void wt_callback_free(void *data) {
262   struct wt_callback *cb;
263
264   if (data == NULL)
265     return;
266
267   cb = data;
268
269   pthread_mutex_lock(&cb->send_lock);
270
271   wt_flush_nolock(0, cb);
272
273   close(cb->sock_fd);
274   cb->sock_fd = -1;
275
276   sfree(cb->node);
277   sfree(cb->service);
278   sfree(cb->host_tags);
279
280   pthread_mutex_unlock(&cb->send_lock);
281   pthread_mutex_destroy(&cb->send_lock);
282
283   sfree(cb);
284 }
285
286 static int wt_flush(cdtime_t timeout,
287                     const char *identifier __attribute__((unused)),
288                     user_data_t *user_data) {
289   struct wt_callback *cb;
290   int status;
291
292   if (user_data == NULL)
293     return -EINVAL;
294
295   cb = user_data->data;
296
297   pthread_mutex_lock(&cb->send_lock);
298
299   if (cb->sock_fd < 0) {
300     status = wt_callback_init(cb);
301     if (status != 0) {
302       ERROR("write_tsdb plugin: wt_callback_init failed.");
303       pthread_mutex_unlock(&cb->send_lock);
304       return -1;
305     }
306   }
307
308   status = wt_flush_nolock(timeout, cb);
309   pthread_mutex_unlock(&cb->send_lock);
310
311   return status;
312 }
313
314 static int wt_format_values(char *ret, size_t ret_len, int ds_num,
315                             const data_set_t *ds, const value_list_t *vl,
316                             bool store_rates) {
317   size_t offset = 0;
318   int status;
319   gauge_t *rates = NULL;
320
321   assert(0 == strcmp(ds->type, vl->type));
322
323   memset(ret, 0, ret_len);
324
325 #define BUFFER_ADD(...)                                                        \
326   do {                                                                         \
327     status = snprintf(ret + offset, ret_len - offset, __VA_ARGS__);            \
328     if (status < 1) {                                                          \
329       sfree(rates);                                                            \
330       return -1;                                                               \
331     } else if (((size_t)status) >= (ret_len - offset)) {                       \
332       sfree(rates);                                                            \
333       return -1;                                                               \
334     } else                                                                     \
335       offset += ((size_t)status);                                              \
336   } while (0)
337
338   if (ds->ds[ds_num].type == DS_TYPE_GAUGE)
339     BUFFER_ADD(GAUGE_FORMAT, vl->values[ds_num].gauge);
340   else if (store_rates) {
341     if (rates == NULL)
342       rates = uc_get_rate(ds, vl);
343     if (rates == NULL) {
344       WARNING("format_values: "
345               "uc_get_rate failed.");
346       return -1;
347     }
348     BUFFER_ADD(GAUGE_FORMAT, rates[ds_num]);
349   } else if (ds->ds[ds_num].type == DS_TYPE_COUNTER)
350     BUFFER_ADD("%" PRIu64, (uint64_t)vl->values[ds_num].counter);
351   else if (ds->ds[ds_num].type == DS_TYPE_DERIVE)
352     BUFFER_ADD("%" PRIi64, vl->values[ds_num].derive);
353   else if (ds->ds[ds_num].type == DS_TYPE_ABSOLUTE)
354     BUFFER_ADD("%" PRIu64, vl->values[ds_num].absolute);
355   else {
356     ERROR("format_values plugin: Unknown data source type: %i",
357           ds->ds[ds_num].type);
358     sfree(rates);
359     return -1;
360   }
361
362 #undef BUFFER_ADD
363
364   sfree(rates);
365   return 0;
366 }
367
368 static int wt_format_name(char *ret, int ret_len, const value_list_t *vl,
369                           const struct wt_callback *cb, const char *ds_name) {
370   int status;
371   char *temp = NULL;
372   const char *prefix = "";
373   const char *meta_prefix = "tsdb_prefix";
374
375   if (vl->meta) {
376     status = meta_data_get_string(vl->meta, meta_prefix, &temp);
377     if (status == -ENOENT) {
378       /* defaults to empty string */
379     } else if (status < 0) {
380       sfree(temp);
381       return status;
382     } else {
383       prefix = temp;
384     }
385   }
386
387   if (ds_name != NULL) {
388     if (vl->plugin_instance[0] == '\0') {
389       if (vl->type_instance[0] == '\0') {
390         snprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin, vl->type,
391                  ds_name);
392       } else {
393         snprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin, vl->type,
394                  vl->type_instance, ds_name);
395       }
396     } else { /* vl->plugin_instance != "" */
397       if (vl->type_instance[0] == '\0') {
398         snprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin,
399                  vl->plugin_instance, vl->type, ds_name);
400       } else {
401         snprintf(ret, ret_len, "%s%s.%s.%s.%s.%s", prefix, vl->plugin,
402                  vl->plugin_instance, vl->type, vl->type_instance, ds_name);
403       }
404     }
405   } else { /* ds_name == NULL */
406     if (vl->plugin_instance[0] == '\0') {
407       if (vl->type_instance[0] == '\0') {
408         snprintf(ret, ret_len, "%s%s.%s", prefix, vl->plugin, vl->type);
409       } else {
410         snprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin,
411                  vl->type_instance, vl->type);
412       }
413     } else { /* vl->plugin_instance != "" */
414       if (vl->type_instance[0] == '\0') {
415         snprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin,
416                  vl->plugin_instance, vl->type);
417       } else {
418         snprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin,
419                  vl->plugin_instance, vl->type, vl->type_instance);
420       }
421     }
422   }
423
424   sfree(temp);
425   return 0;
426 }
427
428 static int wt_send_message(const char *key, const char *value, cdtime_t time,
429                            struct wt_callback *cb, const char *host,
430                            meta_data_t *md) {
431   int status;
432   size_t message_len;
433   char *temp = NULL;
434   const char *tags = "";
435   char message[1024];
436   const char *host_tags = cb->host_tags ? cb->host_tags : "";
437   const char *meta_tsdb = "tsdb_tags";
438
439   /* skip if value is NaN */
440   if (value[0] == 'n')
441     return 0;
442
443   if (md) {
444     status = meta_data_get_string(md, meta_tsdb, &temp);
445     if (status == -ENOENT) {
446       /* defaults to empty string */
447     } else if (status < 0) {
448       ERROR("write_tsdb plugin: tags metadata get failure");
449       sfree(temp);
450       pthread_mutex_unlock(&cb->send_lock);
451       return status;
452     } else {
453       tags = temp;
454     }
455   }
456
457   status =
458       snprintf(message, sizeof(message), "put %s %.0f %s fqdn=%s %s %s\r\n",
459                key, CDTIME_T_TO_DOUBLE(time), value, host, tags, host_tags);
460   sfree(temp);
461   if (status < 0)
462     return -1;
463   message_len = (size_t)status;
464
465   if (message_len >= sizeof(message)) {
466     ERROR("write_tsdb plugin: message buffer too small: "
467           "Need %" PRIsz " bytes.",
468           message_len + 1);
469     return -1;
470   }
471
472   pthread_mutex_lock(&cb->send_lock);
473
474   if (cb->sock_fd < 0) {
475     status = wt_callback_init(cb);
476     if (status != 0) {
477       ERROR("write_tsdb plugin: wt_callback_init failed.");
478       pthread_mutex_unlock(&cb->send_lock);
479       return -1;
480     }
481   }
482
483   if (message_len >= cb->send_buf_free) {
484     status = wt_flush_nolock(0, cb);
485     if (status != 0) {
486       pthread_mutex_unlock(&cb->send_lock);
487       return status;
488     }
489   }
490
491   /* Assert that we have enough space for this message. */
492   assert(message_len < cb->send_buf_free);
493
494   /* `message_len + 1' because `message_len' does not include the
495    * trailing null byte. Neither does `send_buffer_fill'. */
496   memcpy(cb->send_buf + cb->send_buf_fill, message, message_len + 1);
497   cb->send_buf_fill += message_len;
498   cb->send_buf_free -= message_len;
499
500   DEBUG("write_tsdb plugin: [%s]:%s buf %" PRIsz "/%" PRIsz " (%.1f %%) \"%s\"",
501         cb->node, cb->service, cb->send_buf_fill, sizeof(cb->send_buf),
502         100.0 * ((double)cb->send_buf_fill) / ((double)sizeof(cb->send_buf)),
503         message);
504
505   pthread_mutex_unlock(&cb->send_lock);
506
507   return 0;
508 }
509
510 static int wt_write_messages(const data_set_t *ds, const value_list_t *vl,
511                              struct wt_callback *cb) {
512   char key[10 * DATA_MAX_NAME_LEN];
513   char values[512];
514
515   int status;
516
517   if (0 != strcmp(ds->type, vl->type)) {
518     ERROR("write_tsdb plugin: DS type does not match "
519           "value list type");
520     return -1;
521   }
522
523   for (size_t i = 0; i < ds->ds_num; i++) {
524     const char *ds_name = NULL;
525
526     if (cb->always_append_ds || (ds->ds_num > 1))
527       ds_name = ds->ds[i].name;
528
529     /* Copy the identifier to 'key' and escape it. */
530     status = wt_format_name(key, sizeof(key), vl, cb, ds_name);
531     if (status != 0) {
532       ERROR("write_tsdb plugin: error with format_name");
533       return status;
534     }
535
536     escape_string(key, sizeof(key));
537     /* Convert the values to an ASCII representation and put that into
538      * 'values'. */
539     status =
540         wt_format_values(values, sizeof(values), i, ds, vl, cb->store_rates);
541     if (status != 0) {
542       ERROR("write_tsdb plugin: error with "
543             "wt_format_values");
544       return status;
545     }
546
547     /* Send the message to tsdb */
548     status = wt_send_message(key, values, vl->time, cb, vl->host, vl->meta);
549     if (status != 0) {
550       ERROR("write_tsdb plugin: error with "
551             "wt_send_message");
552       return status;
553     }
554   }
555
556   return 0;
557 }
558
559 static int wt_write(const data_set_t *ds, const value_list_t *vl,
560                     user_data_t *user_data) {
561   struct wt_callback *cb;
562   int status;
563
564   if (user_data == NULL)
565     return EINVAL;
566
567   cb = user_data->data;
568
569   status = wt_write_messages(ds, vl, cb);
570
571   return status;
572 }
573
574 static int wt_config_tsd(oconfig_item_t *ci) {
575   struct wt_callback *cb;
576   char callback_name[DATA_MAX_NAME_LEN];
577
578   cb = calloc(1, sizeof(*cb));
579   if (cb == NULL) {
580     ERROR("write_tsdb plugin: calloc failed.");
581     return -1;
582   }
583   cb->sock_fd = -1;
584   cb->connect_failed_log_enabled = 1;
585   cb->next_random_ttl = new_random_ttl();
586
587   pthread_mutex_init(&cb->send_lock, NULL);
588
589   for (int i = 0; i < ci->children_num; i++) {
590     oconfig_item_t *child = ci->children + i;
591
592     if (strcasecmp("Host", child->key) == 0)
593       cf_util_get_string(child, &cb->node);
594     else if (strcasecmp("Port", child->key) == 0)
595       cf_util_get_service(child, &cb->service);
596     else if (strcasecmp("HostTags", child->key) == 0)
597       cf_util_get_string(child, &cb->host_tags);
598     else if (strcasecmp("StoreRates", child->key) == 0)
599       cf_util_get_boolean(child, &cb->store_rates);
600     else if (strcasecmp("AlwaysAppendDS", child->key) == 0)
601       cf_util_get_boolean(child, &cb->always_append_ds);
602     else {
603       ERROR("write_tsdb plugin: Invalid configuration "
604             "option: %s.",
605             child->key);
606     }
607   }
608
609   snprintf(callback_name, sizeof(callback_name), "write_tsdb/%s/%s",
610            cb->node != NULL ? cb->node : WT_DEFAULT_NODE,
611            cb->service != NULL ? cb->service : WT_DEFAULT_SERVICE);
612
613   user_data_t user_data = {.data = cb, .free_func = wt_callback_free};
614
615   plugin_register_write(callback_name, wt_write, &user_data);
616
617   user_data.free_func = NULL;
618   plugin_register_flush(callback_name, wt_flush, &user_data);
619
620   return 0;
621 }
622
623 static int wt_config(oconfig_item_t *ci) {
624   if ((resolve_interval == 0) && (resolve_jitter == 0))
625     resolve_interval = resolve_jitter = plugin_get_interval();
626
627   for (int i = 0; i < ci->children_num; i++) {
628     oconfig_item_t *child = ci->children + i;
629
630     if (strcasecmp("Node", child->key) == 0)
631       wt_config_tsd(child);
632     else if (strcasecmp("ResolveInterval", child->key) == 0)
633       cf_util_get_cdtime(child, &resolve_interval);
634     else if (strcasecmp("ResolveJitter", child->key) == 0)
635       cf_util_get_cdtime(child, &resolve_jitter);
636     else {
637       ERROR("write_tsdb plugin: Invalid configuration "
638             "option: %s.",
639             child->key);
640     }
641   }
642
643   return 0;
644 }
645
646 void module_register(void) {
647   plugin_register_complex_config("write_tsdb", wt_config);
648 }