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"
50 #include "utils_parse_option.h"
52 #include <pthread.h>
53 #include <sys/socket.h>
54 #include <netdb.h>
56 #ifndef WT_DEFAULT_NODE
57 # define WT_DEFAULT_NODE "localhost"
58 #endif
60 #ifndef WT_DEFAULT_SERVICE
61 # define WT_DEFAULT_SERVICE "4242"
62 #endif
64 #ifndef WT_DEFAULT_ESCAPE
65 # define WT_DEFAULT_ESCAPE '.'
66 #endif
68 /* Ethernet - (IPv6 + TCP) = 1500 - (40 + 32) = 1428 */
69 #ifndef WT_SEND_BUF_SIZE
70 # define WT_SEND_BUF_SIZE 1428
71 #endif
73 /*
74 * Private variables
75 */
76 struct wt_callback
77 {
78 int sock_fd;
80 char *node;
81 char *service;
82 char *host_tags;
83 char escape_char;
85 _Bool store_rates;
86 _Bool separate_instances;
87 _Bool always_append_ds;
89 char send_buf[WT_SEND_BUF_SIZE];
90 size_t send_buf_free;
91 size_t send_buf_fill;
92 cdtime_t send_buf_init_time;
94 pthread_mutex_t send_lock;
95 };
98 /*
99 * Functions
100 */
101 static void wt_reset_buffer(struct wt_callback *cb)
102 {
103 memset(cb->send_buf, 0, sizeof(cb->send_buf));
104 cb->send_buf_free = sizeof(cb->send_buf);
105 cb->send_buf_fill = 0;
106 cb->send_buf_init_time = cdtime();
107 }
109 static int wt_send_buffer(struct wt_callback *cb)
110 {
111 ssize_t status = 0;
113 status = swrite(cb->sock_fd, cb->send_buf, strlen(cb->send_buf));
114 if (status < 0)
115 {
116 char errbuf[1024];
117 ERROR("write_tsdb plugin: send failed with status %zi (%s)",
118 status, sstrerror (errno, errbuf, sizeof (errbuf)));
120 close (cb->sock_fd);
121 cb->sock_fd = -1;
123 return -1;
124 }
126 return 0;
127 }
129 /* NOTE: You must hold cb->send_lock when calling this function! */
130 static int wt_flush_nolock(cdtime_t timeout, struct wt_callback *cb)
131 {
132 int status;
134 DEBUG("write_tsdb plugin: wt_flush_nolock: timeout = %.3f; "
135 "send_buf_fill = %zu;",
136 (double)timeout,
137 cb->send_buf_fill);
139 /* timeout == 0 => flush unconditionally */
140 if (timeout > 0)
141 {
142 cdtime_t now;
144 now = cdtime();
145 if ((cb->send_buf_init_time + timeout) > now)
146 return 0;
147 }
149 if (cb->send_buf_fill <= 0)
150 {
151 cb->send_buf_init_time = cdtime();
152 return 0;
153 }
155 status = wt_send_buffer(cb);
156 wt_reset_buffer(cb);
158 return status;
159 }
161 static int wt_callback_init(struct wt_callback *cb)
162 {
163 struct addrinfo ai_hints;
164 struct addrinfo *ai_list;
165 struct addrinfo *ai_ptr;
166 int status;
168 const char *node = cb->node ? cb->node : WT_DEFAULT_NODE;
169 const char *service = cb->service ? cb->service : WT_DEFAULT_SERVICE;
171 if (cb->sock_fd > 0)
172 return 0;
174 memset(&ai_hints, 0, sizeof(ai_hints));
175 #ifdef AI_ADDRCONFIG
176 ai_hints.ai_flags |= AI_ADDRCONFIG;
177 #endif
178 ai_hints.ai_family = AF_UNSPEC;
179 ai_hints.ai_socktype = SOCK_STREAM;
181 ai_list = NULL;
183 status = getaddrinfo(node, service, &ai_hints, &ai_list);
184 if (status != 0)
185 {
186 ERROR("write_tsdb plugin: getaddrinfo (%s, %s) failed: %s",
187 node, service, gai_strerror (status));
188 return -1;
189 }
191 assert (ai_list != NULL);
192 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
193 {
194 cb->sock_fd = socket(ai_ptr->ai_family, ai_ptr->ai_socktype,
195 ai_ptr->ai_protocol);
196 if (cb->sock_fd < 0)
197 continue;
199 status = connect(cb->sock_fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
200 if (status != 0)
201 {
202 close(cb->sock_fd);
203 cb->sock_fd = -1;
204 continue;
205 }
207 break;
208 }
210 freeaddrinfo(ai_list);
212 if (cb->sock_fd < 0)
213 {
214 char errbuf[1024];
215 ERROR("write_tsdb plugin: Connecting to %s:%s failed. "
216 "The last error was: %s", node, service,
217 sstrerror (errno, errbuf, sizeof(errbuf)));
218 close(cb->sock_fd);
219 return -1;
220 }
222 wt_reset_buffer(cb);
224 return 0;
225 }
227 static void wt_callback_free(void *data)
228 {
229 struct wt_callback *cb;
231 if (data == NULL)
232 return;
234 cb = data;
236 pthread_mutex_lock(&cb->send_lock);
238 wt_flush_nolock(0, cb);
240 close(cb->sock_fd);
241 cb->sock_fd = -1;
243 sfree(cb->node);
244 sfree(cb->service);
245 sfree(cb->host_tags);
247 pthread_mutex_destroy(&cb->send_lock);
249 sfree(cb);
250 }
252 static int wt_flush(cdtime_t timeout,
253 const char *identifier __attribute__((unused)),
254 user_data_t *user_data)
255 {
256 struct wt_callback *cb;
257 int status;
259 if (user_data == NULL)
260 return -EINVAL;
262 cb = user_data->data;
264 pthread_mutex_lock(&cb->send_lock);
266 if (cb->sock_fd < 0)
267 {
268 status = wt_callback_init(cb);
269 if (status != 0)
270 {
271 ERROR("write_tsdb plugin: wt_callback_init failed.");
272 pthread_mutex_unlock(&cb->send_lock);
273 return -1;
274 }
275 }
277 status = wt_flush_nolock(timeout, cb);
278 pthread_mutex_unlock(&cb->send_lock);
280 return status;
281 }
283 static int wt_format_values(char *ret, size_t ret_len,
284 int ds_num, const data_set_t *ds,
285 const value_list_t *vl,
286 _Bool store_rates)
287 {
288 size_t offset = 0;
289 int status;
290 gauge_t *rates = NULL;
292 assert(0 == strcmp (ds->type, vl->type));
294 memset(ret, 0, ret_len);
296 #define BUFFER_ADD(...) do { \
297 status = ssnprintf (ret + offset, ret_len - offset, \
298 __VA_ARGS__); \
299 if (status < 1) \
300 { \
301 sfree(rates); \
302 return -1; \
303 } \
304 else if (((size_t) status) >= (ret_len - offset)) \
305 { \
306 sfree(rates); \
307 return -1; \
308 } \
309 else \
310 offset += ((size_t) status); \
311 } while (0)
313 if (ds->ds[ds_num].type == DS_TYPE_GAUGE)
314 BUFFER_ADD("%f", vl->values[ds_num].gauge);
315 else if (store_rates)
316 {
317 if (rates == NULL)
318 rates = uc_get_rate (ds, vl);
319 if (rates == NULL)
320 {
321 WARNING("format_values: "
322 "uc_get_rate failed.");
323 return -1;
324 }
325 BUFFER_ADD("%f", rates[ds_num]);
326 }
327 else if (ds->ds[ds_num].type == DS_TYPE_COUNTER)
328 BUFFER_ADD("%llu", vl->values[ds_num].counter);
329 else if (ds->ds[ds_num].type == DS_TYPE_DERIVE)
330 BUFFER_ADD("%" PRIi64, vl->values[ds_num].derive);
331 else if (ds->ds[ds_num].type == DS_TYPE_ABSOLUTE)
332 BUFFER_ADD("%" PRIu64, vl->values[ds_num].absolute);
333 else
334 {
335 ERROR("format_values plugin: Unknown data source type: %i",
336 ds->ds[ds_num].type);
337 sfree(rates);
338 return -1;
339 }
341 #undef BUFFER_ADD
343 sfree(rates);
344 return 0;
345 }
347 static int wt_format_name(char *ret, int ret_len,
348 const value_list_t *vl,
349 const struct wt_callback *cb,
350 const char *ds_name)
351 {
352 int status;
353 char *temp = NULL;
354 char *prefix = "";
355 const char *meta_prefix = "tsdb_prefix";
357 if (vl->meta) {
358 status = meta_data_get_string(vl->meta, meta_prefix, &temp);
359 if (status == -ENOENT) {
360 /* defaults to empty string */
361 } else if (status < 0) {
362 sfree(temp);
363 return status;
364 } else {
365 prefix = temp;
366 }
367 }
369 if (ds_name != NULL) {
370 if (vl->plugin_instance[0] == '\0') {
371 ssnprintf(ret, ret_len, "%s%s.%s",
372 prefix, vl->plugin, ds_name);
373 } else if (vl->type_instance == '\0') {
374 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s",
375 prefix, vl->plugin, vl->plugin_instance,
376 vl->type_instance, ds_name);
377 } else {
378 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s",
379 prefix, vl->plugin, vl->plugin_instance, vl->type,
380 ds_name);
381 }
382 } else if (vl->plugin_instance[0] == '\0') {
383 if (vl->type_instance[0] == '\0')
384 ssnprintf(ret, ret_len, "%s%s.%s",
385 prefix, vl->plugin, vl->type);
386 else
387 ssnprintf(ret, ret_len, "%s%s.%s",
388 prefix, vl->plugin, vl->type_instance);
389 } else if (vl->type_instance[0] == '\0') {
390 ssnprintf(ret, ret_len, "%s%s.%s.%s",
391 prefix, vl->plugin, vl->plugin_instance, vl->type);
392 } else {
393 ssnprintf(ret, ret_len, "%s%s.%s.%s",
394 prefix, vl->plugin, vl->plugin_instance, vl->type_instance);
395 }
397 sfree(temp);
398 return 0;
399 }
401 static int wt_send_message (const char* key, const char* value,
402 cdtime_t time, struct wt_callback *cb,
403 const char* host, meta_data_t *md)
404 {
405 int status;
406 int message_len;
407 char *temp = NULL;
408 char *tags = "";
409 char message[1024];
410 char *host_tags = cb->host_tags ? cb->host_tags : "";
411 const char *message_fmt;
412 const char *meta_tsdb = "tsdb_tags";
414 /* skip if value is NaN */
415 if (value[0] == 'n')
416 return 0;
418 if (md) {
419 status = meta_data_get_string(md, meta_tsdb, &temp);
420 if (status == -ENOENT) {
421 /* defaults to empty string */
422 } else if (status < 0) {
423 ERROR("write_tsdb plugin: tags metadata get failure");
424 sfree(temp);
425 pthread_mutex_unlock(&cb->send_lock);
426 return status;
427 } else {
428 tags = temp;
429 }
430 }
432 message_fmt = "put %s %u %s fqdn=%s %s %s\r\n";
433 message_len = ssnprintf (message, sizeof(message),
434 message_fmt,
435 key,
436 (unsigned int)CDTIME_T_TO_TIME_T(
437 time),
438 value,
439 host,
440 tags,
441 host_tags);
443 sfree(temp);
445 if (message_len >= sizeof(message)) {
446 ERROR("write_tsdb plugin: message buffer too small: "
447 "Need %d bytes.", message_len + 1);
448 return -1;
449 }
451 pthread_mutex_lock(&cb->send_lock);
453 if (cb->sock_fd < 0)
454 {
455 status = wt_callback_init(cb);
456 if (status != 0)
457 {
458 ERROR("write_tsdb plugin: wt_callback_init failed.");
459 pthread_mutex_unlock(&cb->send_lock);
460 return -1;
461 }
462 }
464 if (message_len >= cb->send_buf_free)
465 {
466 status = wt_flush_nolock(0, cb);
467 if (status != 0)
468 {
469 pthread_mutex_unlock(&cb->send_lock);
470 return status;
471 }
472 }
474 /* Assert that we have enough space for this message. */
475 assert(message_len < cb->send_buf_free);
477 /* `message_len + 1' because `message_len' does not include the
478 * trailing null byte. Neither does `send_buffer_fill'. */
479 memcpy(cb->send_buf + cb->send_buf_fill,
480 message, message_len + 1);
481 cb->send_buf_fill += message_len;
482 cb->send_buf_free -= message_len;
484 DEBUG("write_tsdb plugin: [%s]:%s buf %zu/%zu (%.1f %%) \"%s\"",
485 cb->node,
486 cb->service,
487 cb->send_buf_fill, sizeof(cb->send_buf),
488 100.0 * ((double) cb->send_buf_fill) /
489 ((double) sizeof(cb->send_buf)),
490 message);
492 pthread_mutex_unlock(&cb->send_lock);
494 return 0;
495 }
497 static int wt_write_messages(const data_set_t *ds, const value_list_t *vl,
498 struct wt_callback *cb)
499 {
500 char key[10*DATA_MAX_NAME_LEN];
501 char values[512];
503 int status, i;
505 if (0 != strcmp(ds->type, vl->type))
506 {
507 ERROR("write_tsdb plugin: DS type does not match "
508 "value list type");
509 return -1;
510 }
512 for (i = 0; i < ds->ds_num; i++)
513 {
514 const char *ds_name = NULL;
516 if (cb->always_append_ds || (ds->ds_num > 1))
517 ds_name = ds->ds[i].name;
519 /* Copy the identifier to 'key' and escape it. */
520 status = wt_format_name(key, sizeof(key), vl, cb, ds_name);
521 if (status != 0)
522 {
523 ERROR("write_tsdb plugin: error with format_name");
524 return status;
525 }
527 escape_string(key, sizeof(key));
528 /* Convert the values to an ASCII representation and put that into
529 * 'values'. */
530 status = wt_format_values(values, sizeof(values), i, ds, vl,
531 cb->store_rates);
532 if (status != 0)
533 {
534 ERROR("write_tsdb plugin: error with "
535 "wt_format_values");
536 return status;
537 }
539 /* Send the message to tsdb */
540 status = wt_send_message(key, values, vl->time, cb, vl->host, vl->meta);
541 if (status != 0)
542 {
543 ERROR("write_tsdb plugin: error with "
544 "wt_send_message");
545 return status;
546 }
547 }
549 return 0;
550 }
552 static int wt_write(const data_set_t *ds, const value_list_t *vl,
553 user_data_t *user_data)
554 {
555 struct wt_callback *cb;
556 int status;
558 if (user_data == NULL)
559 return EINVAL;
561 cb = user_data->data;
563 status = wt_write_messages(ds, vl, cb);
565 return status;
566 }
568 static int config_set_char(char *dest,
569 oconfig_item_t *ci)
570 {
571 char buffer[4];
572 int status;
574 memset(buffer, 0, sizeof(buffer));
576 status = cf_util_get_string_buffer(ci, buffer, sizeof(buffer));
577 if (status != 0)
578 return (status);
580 if (buffer[0] == 0)
581 {
582 ERROR("write_tsdb plugin: Cannot use an empty string for the "
583 "\"EscapeCharacter\" option.");
584 return -1;
585 }
587 if (buffer[1] != 0)
588 {
589 WARNING("write_tsdb plugin: Only the first character of the "
590 "\"EscapeCharacter\" option ('%c') will be used.",
591 (int) buffer[0]);
592 }
594 *dest = buffer[0];
596 return 0;
597 }
599 static int wt_config_tsd(oconfig_item_t *ci)
600 {
601 struct wt_callback *cb;
602 user_data_t user_data;
603 char callback_name[DATA_MAX_NAME_LEN];
604 int i;
606 cb = malloc(sizeof(*cb));
607 if (cb == NULL)
608 {
609 ERROR("write_tsdb plugin: malloc failed.");
610 return -1;
611 }
612 memset(cb, 0, sizeof(*cb));
613 cb->sock_fd = -1;
614 cb->node = NULL;
615 cb->service = NULL;
616 cb->host_tags = NULL;
617 cb->escape_char = WT_DEFAULT_ESCAPE;
618 cb->store_rates = 1;
620 pthread_mutex_init (&cb->send_lock, NULL);
622 for (i = 0; i < ci->children_num; i++)
623 {
624 oconfig_item_t *child = ci->children + i;
626 if (strcasecmp("Host", child->key) == 0)
627 cf_util_get_string(child, &cb->node);
628 else if (strcasecmp("Port", child->key) == 0)
629 cf_util_get_service(child, &cb->service);
630 else if (strcasecmp("HostTags", child->key) == 0)
631 cf_util_get_string(child, &cb->host_tags);
632 else if (strcasecmp("StoreRates", child->key) == 0)
633 cf_util_get_boolean(child, &cb->store_rates);
634 else if (strcasecmp("SeparateInstances", child->key) == 0)
635 cf_util_get_boolean(child, &cb->separate_instances);
636 else if (strcasecmp("AlwaysAppendDS", child->key) == 0)
637 cf_util_get_boolean(child, &cb->always_append_ds);
638 else if (strcasecmp("EscapeCharacter", child->key) == 0)
639 config_set_char(&cb->escape_char, child);
640 else
641 {
642 ERROR("write_tsdb plugin: Invalid configuration "
643 "option: %s.", child->key);
644 }
645 }
647 ssnprintf(callback_name, sizeof(callback_name), "write_tsdb/%s/%s",
648 cb->node != NULL ? cb->node : WT_DEFAULT_NODE,
649 cb->service != NULL ? cb->service : WT_DEFAULT_SERVICE);
651 memset(&user_data, 0, sizeof(user_data));
652 user_data.data = cb;
653 user_data.free_func = wt_callback_free;
654 plugin_register_write(callback_name, wt_write, &user_data);
656 user_data.free_func = NULL;
657 plugin_register_flush(callback_name, wt_flush, &user_data);
659 return 0;
660 }
662 static int wt_config(oconfig_item_t *ci)
663 {
664 int i;
666 for (i = 0; i < ci->children_num; i++)
667 {
668 oconfig_item_t *child = ci->children + i;
670 if (strcasecmp("Node", child->key) == 0)
671 wt_config_tsd(child);
672 else
673 {
674 ERROR("write_tsdb plugin: Invalid configuration "
675 "option: %s.", child->key);
676 }
677 }
679 return 0;
680 }
682 void module_register(void)
683 {
684 plugin_register_complex_config("write_tsdb", wt_config);
685 }
687 /* vim: set sw=4 ts=4 sts=4 tw=78 et : */