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