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();
104 }
106 static int wt_send_buffer(struct wt_callback *cb)
107 {
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;
124 }
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)
128 {
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;
156 }
158 static int wt_callback_init(struct wt_callback *cb)
159 {
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 return -1;
216 }
218 wt_reset_buffer(cb);
220 return 0;
221 }
223 static void wt_callback_free(void *data)
224 {
225 struct wt_callback *cb;
227 if (data == NULL)
228 return;
230 cb = data;
232 pthread_mutex_lock(&cb->send_lock);
234 wt_flush_nolock(0, cb);
236 close(cb->sock_fd);
237 cb->sock_fd = -1;
239 sfree(cb->node);
240 sfree(cb->service);
241 sfree(cb->host_tags);
243 pthread_mutex_destroy(&cb->send_lock);
245 sfree(cb);
246 }
248 static int wt_flush(cdtime_t timeout,
249 const char *identifier __attribute__((unused)),
250 user_data_t *user_data)
251 {
252 struct wt_callback *cb;
253 int status;
255 if (user_data == NULL)
256 return -EINVAL;
258 cb = user_data->data;
260 pthread_mutex_lock(&cb->send_lock);
262 if (cb->sock_fd < 0)
263 {
264 status = wt_callback_init(cb);
265 if (status != 0)
266 {
267 ERROR("write_tsdb plugin: wt_callback_init failed.");
268 pthread_mutex_unlock(&cb->send_lock);
269 return -1;
270 }
271 }
273 status = wt_flush_nolock(timeout, cb);
274 pthread_mutex_unlock(&cb->send_lock);
276 return status;
277 }
279 static int wt_format_values(char *ret, size_t ret_len,
280 int ds_num, const data_set_t *ds,
281 const value_list_t *vl,
282 _Bool store_rates)
283 {
284 size_t offset = 0;
285 int status;
286 gauge_t *rates = NULL;
288 assert(0 == strcmp (ds->type, vl->type));
290 memset(ret, 0, ret_len);
292 #define BUFFER_ADD(...) do { \
293 status = ssnprintf (ret + offset, ret_len - offset, \
294 __VA_ARGS__); \
295 if (status < 1) \
296 { \
297 sfree(rates); \
298 return -1; \
299 } \
300 else if (((size_t) status) >= (ret_len - offset)) \
301 { \
302 sfree(rates); \
303 return -1; \
304 } \
305 else \
306 offset += ((size_t) status); \
307 } while (0)
309 if (ds->ds[ds_num].type == DS_TYPE_GAUGE)
310 BUFFER_ADD(GAUGE_FORMAT, vl->values[ds_num].gauge);
311 else if (store_rates)
312 {
313 if (rates == NULL)
314 rates = uc_get_rate (ds, vl);
315 if (rates == NULL)
316 {
317 WARNING("format_values: "
318 "uc_get_rate failed.");
319 return -1;
320 }
321 BUFFER_ADD(GAUGE_FORMAT, rates[ds_num]);
322 }
323 else if (ds->ds[ds_num].type == DS_TYPE_COUNTER)
324 BUFFER_ADD("%llu", vl->values[ds_num].counter);
325 else if (ds->ds[ds_num].type == DS_TYPE_DERIVE)
326 BUFFER_ADD("%" PRIi64, vl->values[ds_num].derive);
327 else if (ds->ds[ds_num].type == DS_TYPE_ABSOLUTE)
328 BUFFER_ADD("%" PRIu64, vl->values[ds_num].absolute);
329 else
330 {
331 ERROR("format_values plugin: Unknown data source type: %i",
332 ds->ds[ds_num].type);
333 sfree(rates);
334 return -1;
335 }
337 #undef BUFFER_ADD
339 sfree(rates);
340 return 0;
341 }
343 static int wt_format_name(char *ret, int ret_len,
344 const value_list_t *vl,
345 const struct wt_callback *cb,
346 const char *ds_name)
347 {
348 int status;
349 char *temp = NULL;
350 char *prefix = "";
351 const char *meta_prefix = "tsdb_prefix";
353 if (vl->meta) {
354 status = meta_data_get_string(vl->meta, meta_prefix, &temp);
355 if (status == -ENOENT) {
356 /* defaults to empty string */
357 } else if (status < 0) {
358 sfree(temp);
359 return status;
360 } else {
361 prefix = temp;
362 }
363 }
365 if (ds_name != NULL) {
366 if (vl->plugin_instance[0] == '\0') {
367 if (vl->type_instance[0] == '\0') {
368 ssnprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin,
369 vl->type, ds_name);
370 } else {
371 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin,
372 vl->type, vl->type_instance, ds_name);
373 }
374 } else { /* vl->plugin_instance != "" */
375 if (vl->type_instance[0] == '\0') {
376 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin,
377 vl->plugin_instance, vl->type, ds_name);
378 } else {
379 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s.%s", prefix,
380 vl->plugin, vl->plugin_instance, vl->type,
381 vl->type_instance, ds_name);
382 }
383 }
384 } else { /* ds_name == NULL */
385 if (vl->plugin_instance[0] == '\0') {
386 if (vl->type_instance[0] == '\0') {
387 ssnprintf(ret, ret_len, "%s%s.%s", prefix, vl->plugin,
388 vl->type);
389 } else {
390 ssnprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin,
391 vl->type_instance, vl->type);
392 }
393 } else { /* vl->plugin_instance != "" */
394 if (vl->type_instance[0] == '\0') {
395 ssnprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin,
396 vl->plugin_instance, vl->type);
397 } else {
398 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin,
399 vl->plugin_instance, vl->type, vl->type_instance);
400 }
401 }
402 }
404 sfree(temp);
405 return 0;
406 }
408 static int wt_send_message (const char* key, const char* value,
409 cdtime_t time, struct wt_callback *cb,
410 const char* host, meta_data_t *md)
411 {
412 int status;
413 int message_len;
414 char *temp = NULL;
415 char *tags = "";
416 char message[1024];
417 char *host_tags = cb->host_tags ? cb->host_tags : "";
418 const char *meta_tsdb = "tsdb_tags";
420 /* skip if value is NaN */
421 if (value[0] == 'n')
422 return 0;
424 if (md) {
425 status = meta_data_get_string(md, meta_tsdb, &temp);
426 if (status == -ENOENT) {
427 /* defaults to empty string */
428 } else if (status < 0) {
429 ERROR("write_tsdb plugin: tags metadata get failure");
430 sfree(temp);
431 pthread_mutex_unlock(&cb->send_lock);
432 return status;
433 } else {
434 tags = temp;
435 }
436 }
438 message_len = ssnprintf (message,
439 sizeof(message),
440 "put %s %.0f %s fqdn=%s %s %s\r\n",
441 key,
442 CDTIME_T_TO_DOUBLE(time),
443 value,
444 host,
445 tags,
446 host_tags);
448 sfree(temp);
450 if (message_len >= sizeof(message)) {
451 ERROR("write_tsdb plugin: message buffer too small: "
452 "Need %d bytes.", message_len + 1);
453 return -1;
454 }
456 pthread_mutex_lock(&cb->send_lock);
458 if (cb->sock_fd < 0)
459 {
460 status = wt_callback_init(cb);
461 if (status != 0)
462 {
463 ERROR("write_tsdb plugin: wt_callback_init failed.");
464 pthread_mutex_unlock(&cb->send_lock);
465 return -1;
466 }
467 }
469 if (message_len >= cb->send_buf_free)
470 {
471 status = wt_flush_nolock(0, cb);
472 if (status != 0)
473 {
474 pthread_mutex_unlock(&cb->send_lock);
475 return status;
476 }
477 }
479 /* Assert that we have enough space for this message. */
480 assert(message_len < cb->send_buf_free);
482 /* `message_len + 1' because `message_len' does not include the
483 * trailing null byte. Neither does `send_buffer_fill'. */
484 memcpy(cb->send_buf + cb->send_buf_fill,
485 message, message_len + 1);
486 cb->send_buf_fill += message_len;
487 cb->send_buf_free -= message_len;
489 DEBUG("write_tsdb plugin: [%s]:%s buf %zu/%zu (%.1f %%) \"%s\"",
490 cb->node,
491 cb->service,
492 cb->send_buf_fill, sizeof(cb->send_buf),
493 100.0 * ((double) cb->send_buf_fill) /
494 ((double) sizeof(cb->send_buf)),
495 message);
497 pthread_mutex_unlock(&cb->send_lock);
499 return 0;
500 }
502 static int wt_write_messages(const data_set_t *ds, const value_list_t *vl,
503 struct wt_callback *cb)
504 {
505 char key[10*DATA_MAX_NAME_LEN];
506 char values[512];
508 int status, i;
510 if (0 != strcmp(ds->type, vl->type))
511 {
512 ERROR("write_tsdb plugin: DS type does not match "
513 "value list type");
514 return -1;
515 }
517 for (i = 0; i < ds->ds_num; i++)
518 {
519 const char *ds_name = NULL;
521 if (cb->always_append_ds || (ds->ds_num > 1))
522 ds_name = ds->ds[i].name;
524 /* Copy the identifier to 'key' and escape it. */
525 status = wt_format_name(key, sizeof(key), vl, cb, ds_name);
526 if (status != 0)
527 {
528 ERROR("write_tsdb plugin: error with format_name");
529 return status;
530 }
532 escape_string(key, sizeof(key));
533 /* Convert the values to an ASCII representation and put that into
534 * 'values'. */
535 status = wt_format_values(values, sizeof(values), i, ds, vl,
536 cb->store_rates);
537 if (status != 0)
538 {
539 ERROR("write_tsdb plugin: error with "
540 "wt_format_values");
541 return status;
542 }
544 /* Send the message to tsdb */
545 status = wt_send_message(key, values, vl->time, cb, vl->host, vl->meta);
546 if (status != 0)
547 {
548 ERROR("write_tsdb plugin: error with "
549 "wt_send_message");
550 return status;
551 }
552 }
554 return 0;
555 }
557 static int wt_write(const data_set_t *ds, const value_list_t *vl,
558 user_data_t *user_data)
559 {
560 struct wt_callback *cb;
561 int status;
563 if (user_data == NULL)
564 return EINVAL;
566 cb = user_data->data;
568 status = wt_write_messages(ds, vl, cb);
570 return status;
571 }
573 static int wt_config_tsd(oconfig_item_t *ci)
574 {
575 struct wt_callback *cb;
576 user_data_t user_data;
577 char callback_name[DATA_MAX_NAME_LEN];
578 int i;
580 cb = malloc(sizeof(*cb));
581 if (cb == NULL)
582 {
583 ERROR("write_tsdb plugin: malloc failed.");
584 return -1;
585 }
586 memset(cb, 0, sizeof(*cb));
587 cb->sock_fd = -1;
588 cb->node = NULL;
589 cb->service = NULL;
590 cb->host_tags = NULL;
591 cb->store_rates = 0;
593 pthread_mutex_init (&cb->send_lock, NULL);
595 for (i = 0; i < ci->children_num; i++)
596 {
597 oconfig_item_t *child = ci->children + i;
599 if (strcasecmp("Host", child->key) == 0)
600 cf_util_get_string(child, &cb->node);
601 else if (strcasecmp("Port", child->key) == 0)
602 cf_util_get_service(child, &cb->service);
603 else if (strcasecmp("HostTags", child->key) == 0)
604 cf_util_get_string(child, &cb->host_tags);
605 else if (strcasecmp("StoreRates", child->key) == 0)
606 cf_util_get_boolean(child, &cb->store_rates);
607 else if (strcasecmp("AlwaysAppendDS", child->key) == 0)
608 cf_util_get_boolean(child, &cb->always_append_ds);
609 else
610 {
611 ERROR("write_tsdb plugin: Invalid configuration "
612 "option: %s.", child->key);
613 }
614 }
616 ssnprintf(callback_name, sizeof(callback_name), "write_tsdb/%s/%s",
617 cb->node != NULL ? cb->node : WT_DEFAULT_NODE,
618 cb->service != NULL ? cb->service : WT_DEFAULT_SERVICE);
620 memset(&user_data, 0, sizeof(user_data));
621 user_data.data = cb;
622 user_data.free_func = wt_callback_free;
623 plugin_register_write(callback_name, wt_write, &user_data);
625 user_data.free_func = NULL;
626 plugin_register_flush(callback_name, wt_flush, &user_data);
628 return 0;
629 }
631 static int wt_config(oconfig_item_t *ci)
632 {
633 int i;
635 for (i = 0; i < ci->children_num; i++)
636 {
637 oconfig_item_t *child = ci->children + i;
639 if (strcasecmp("Node", child->key) == 0)
640 wt_config_tsd(child);
641 else
642 {
643 ERROR("write_tsdb plugin: Invalid configuration "
644 "option: %s.", child->key);
645 }
646 }
648 return 0;
649 }
651 void module_register(void)
652 {
653 plugin_register_complex_config("write_tsdb", wt_config);
654 }
656 /* vim: set sw=4 ts=4 sts=4 tw=78 et : */