615e8b75d1f79cec4ee58dcb83e62f782d6028ff
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"
49 #include "utils_cache.h"
51 #include <netdb.h>
53 #ifndef WT_DEFAULT_NODE
54 #define WT_DEFAULT_NODE "localhost"
55 #endif
57 #ifndef WT_DEFAULT_SERVICE
58 #define WT_DEFAULT_SERVICE "4242"
59 #endif
61 #ifndef WT_DEFAULT_ESCAPE
62 #define WT_DEFAULT_ESCAPE '.'
63 #endif
65 /* Ethernet - (IPv6 + TCP) = 1500 - (40 + 32) = 1428 */
66 #ifndef WT_SEND_BUF_SIZE
67 #define WT_SEND_BUF_SIZE 1428
68 #endif
70 /*
71 * Private variables
72 */
73 struct wt_callback {
74 struct addrinfo *sock_info;
75 cdtime_t sock_info_last_update;
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 };
93 static cdtime_t dnsttl = TIME_T_TO_CDTIME_T_STATIC(60);
95 /*
96 * Functions
97 */
98 static void wt_reset_buffer(struct wt_callback *cb) {
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 ssize_t status = 0;
108 status = swrite(cb->sock_fd, cb->send_buf, strlen(cb->send_buf));
109 if (status < 0) {
110 char errbuf[1024];
111 ERROR("write_tsdb plugin: send failed with status %zi (%s)", status,
112 sstrerror(errno, errbuf, sizeof(errbuf)));
114 close(cb->sock_fd);
115 cb->sock_fd = -1;
117 return -1;
118 }
120 return 0;
121 }
123 /* NOTE: You must hold cb->send_lock when calling this function! */
124 static int wt_flush_nolock(cdtime_t timeout, struct wt_callback *cb) {
125 int status;
127 DEBUG("write_tsdb plugin: wt_flush_nolock: timeout = %.3f; "
128 "send_buf_fill = %zu;",
129 (double)timeout, cb->send_buf_fill);
131 /* timeout == 0 => flush unconditionally */
132 if (timeout > 0) {
133 cdtime_t now;
135 now = cdtime();
136 if ((cb->send_buf_init_time + timeout) > now)
137 return 0;
138 }
140 if (cb->send_buf_fill == 0) {
141 cb->send_buf_init_time = cdtime();
142 return 0;
143 }
145 status = wt_send_buffer(cb);
146 wt_reset_buffer(cb);
148 return status;
149 }
151 static int wt_callback_init(struct wt_callback *cb) {
152 int status;
153 cdtime_t now;
155 const char *node = cb->node ? cb->node : WT_DEFAULT_NODE;
156 const char *service = cb->service ? cb->service : WT_DEFAULT_SERVICE;
158 if (cb->sock_fd > 0)
159 return 0;
161 now = cdtime();
162 if ((cb->sock_info_last_update + dnsttl) < now) {
163 if (cb->sock_info) {
164 freeaddrinfo(cb->sock_info);
165 cb->sock_info = NULL;
166 }
167 }
169 if (NULL == cb->sock_info) {
170 struct addrinfo ai_hints = {
171 .ai_family = AF_UNSPEC,
172 .ai_flags = AI_ADDRCONFIG,
173 .ai_socktype = SOCK_STREAM,
174 };
176 if ((cb->sock_info_last_update + dnsttl) >= now) {
177 DEBUG("write_tsdb plugin: too many getaddrinfo (%s, %s) failures", node,
178 service);
179 return (-1);
180 }
182 cb->sock_info_last_update = now;
183 status = getaddrinfo(node, service, &ai_hints, &(cb->sock_info));
184 if (status != 0) {
185 if (cb->sock_info) {
186 freeaddrinfo(cb->sock_info);
187 cb->sock_info = NULL;
188 }
189 if (cb->connect_failed_log_enabled) {
190 ERROR("write_tsdb plugin: getaddrinfo (%s, %s) failed: %s", node,
191 service, gai_strerror(status));
192 cb->connect_failed_log_enabled = 0;
193 }
194 return -1;
195 }
196 }
198 assert(cb->sock_info != NULL);
199 for (struct addrinfo *ai_ptr = cb->sock_info; ai_ptr != NULL;
200 ai_ptr = ai_ptr->ai_next) {
201 cb->sock_fd =
202 socket(ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol);
203 if (cb->sock_fd < 0)
204 continue;
206 set_sock_opts(cb->sock_fd);
208 status = connect(cb->sock_fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
209 if (status != 0) {
210 close(cb->sock_fd);
211 cb->sock_fd = -1;
212 continue;
213 }
215 break;
216 }
218 if (cb->sock_fd < 0) {
219 char errbuf[1024];
220 ERROR("write_tsdb plugin: Connecting to %s:%s failed. "
221 "The last error was: %s",
222 node, service, sstrerror(errno, errbuf, sizeof(errbuf)));
223 return -1;
224 }
226 wt_reset_buffer(cb);
228 return 0;
229 }
231 static void wt_callback_free(void *data) {
232 struct wt_callback *cb;
234 if (data == NULL)
235 return;
237 cb = data;
239 pthread_mutex_lock(&cb->send_lock);
241 wt_flush_nolock(0, cb);
243 close(cb->sock_fd);
244 cb->sock_fd = -1;
246 sfree(cb->node);
247 sfree(cb->service);
248 sfree(cb->host_tags);
250 pthread_mutex_destroy(&cb->send_lock);
252 sfree(cb);
253 }
255 static int wt_flush(cdtime_t timeout,
256 const char *identifier __attribute__((unused)),
257 user_data_t *user_data) {
258 struct wt_callback *cb;
259 int status;
261 if (user_data == NULL)
262 return -EINVAL;
264 cb = user_data->data;
266 pthread_mutex_lock(&cb->send_lock);
268 if (cb->sock_fd < 0) {
269 status = wt_callback_init(cb);
270 if (status != 0) {
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, int ds_num,
284 const data_set_t *ds, const value_list_t *vl,
285 _Bool store_rates) {
286 size_t offset = 0;
287 int status;
288 gauge_t *rates = NULL;
290 assert(0 == strcmp(ds->type, vl->type));
292 memset(ret, 0, ret_len);
294 #define BUFFER_ADD(...) \
295 do { \
296 status = ssnprintf(ret + offset, ret_len - offset, __VA_ARGS__); \
297 if (status < 1) { \
298 sfree(rates); \
299 return -1; \
300 } else if (((size_t)status) >= (ret_len - offset)) { \
301 sfree(rates); \
302 return -1; \
303 } else \
304 offset += ((size_t)status); \
305 } while (0)
307 if (ds->ds[ds_num].type == DS_TYPE_GAUGE)
308 BUFFER_ADD(GAUGE_FORMAT, vl->values[ds_num].gauge);
309 else if (store_rates) {
310 if (rates == NULL)
311 rates = uc_get_rate(ds, vl);
312 if (rates == NULL) {
313 WARNING("format_values: "
314 "uc_get_rate failed.");
315 return -1;
316 }
317 BUFFER_ADD(GAUGE_FORMAT, rates[ds_num]);
318 } else if (ds->ds[ds_num].type == DS_TYPE_COUNTER)
319 BUFFER_ADD("%llu", vl->values[ds_num].counter);
320 else if (ds->ds[ds_num].type == DS_TYPE_DERIVE)
321 BUFFER_ADD("%" PRIi64, vl->values[ds_num].derive);
322 else if (ds->ds[ds_num].type == DS_TYPE_ABSOLUTE)
323 BUFFER_ADD("%" PRIu64, vl->values[ds_num].absolute);
324 else {
325 ERROR("format_values plugin: Unknown data source type: %i",
326 ds->ds[ds_num].type);
327 sfree(rates);
328 return -1;
329 }
331 #undef BUFFER_ADD
333 sfree(rates);
334 return 0;
335 }
337 static int wt_format_name(char *ret, int ret_len, const value_list_t *vl,
338 const struct wt_callback *cb, const char *ds_name) {
339 int status;
340 char *temp = NULL;
341 const char *prefix = "";
342 const char *meta_prefix = "tsdb_prefix";
344 if (vl->meta) {
345 status = meta_data_get_string(vl->meta, meta_prefix, &temp);
346 if (status == -ENOENT) {
347 /* defaults to empty string */
348 } else if (status < 0) {
349 sfree(temp);
350 return status;
351 } else {
352 prefix = temp;
353 }
354 }
356 if (ds_name != NULL) {
357 if (vl->plugin_instance[0] == '\0') {
358 if (vl->type_instance[0] == '\0') {
359 ssnprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin, vl->type,
360 ds_name);
361 } else {
362 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin, vl->type,
363 vl->type_instance, ds_name);
364 }
365 } else { /* vl->plugin_instance != "" */
366 if (vl->type_instance[0] == '\0') {
367 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin,
368 vl->plugin_instance, vl->type, ds_name);
369 } else {
370 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s.%s", prefix, vl->plugin,
371 vl->plugin_instance, vl->type, vl->type_instance, ds_name);
372 }
373 }
374 } else { /* ds_name == NULL */
375 if (vl->plugin_instance[0] == '\0') {
376 if (vl->type_instance[0] == '\0') {
377 ssnprintf(ret, ret_len, "%s%s.%s", prefix, vl->plugin, vl->type);
378 } else {
379 ssnprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin,
380 vl->type_instance, vl->type);
381 }
382 } else { /* vl->plugin_instance != "" */
383 if (vl->type_instance[0] == '\0') {
384 ssnprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin,
385 vl->plugin_instance, vl->type);
386 } else {
387 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin,
388 vl->plugin_instance, vl->type, vl->type_instance);
389 }
390 }
391 }
393 sfree(temp);
394 return 0;
395 }
397 static int wt_send_message(const char *key, const char *value, cdtime_t time,
398 struct wt_callback *cb, const char *host,
399 meta_data_t *md) {
400 int status;
401 size_t message_len;
402 char *temp = NULL;
403 const char *tags = "";
404 char message[1024];
405 const char *host_tags = cb->host_tags ? cb->host_tags : "";
406 const char *meta_tsdb = "tsdb_tags";
408 /* skip if value is NaN */
409 if (value[0] == 'n')
410 return 0;
412 if (md) {
413 status = meta_data_get_string(md, meta_tsdb, &temp);
414 if (status == -ENOENT) {
415 /* defaults to empty string */
416 } else if (status < 0) {
417 ERROR("write_tsdb plugin: tags metadata get failure");
418 sfree(temp);
419 pthread_mutex_unlock(&cb->send_lock);
420 return status;
421 } else {
422 tags = temp;
423 }
424 }
426 status =
427 ssnprintf(message, sizeof(message), "put %s %.0f %s fqdn=%s %s %s\r\n",
428 key, CDTIME_T_TO_DOUBLE(time), value, host, tags, host_tags);
429 sfree(temp);
430 if (status < 0)
431 return -1;
432 message_len = (size_t)status;
434 if (message_len >= sizeof(message)) {
435 ERROR("write_tsdb plugin: message buffer too small: "
436 "Need %zu bytes.",
437 message_len + 1);
438 return -1;
439 }
441 pthread_mutex_lock(&cb->send_lock);
443 if (cb->sock_fd < 0) {
444 status = wt_callback_init(cb);
445 if (status != 0) {
446 ERROR("write_tsdb plugin: wt_callback_init failed.");
447 pthread_mutex_unlock(&cb->send_lock);
448 return -1;
449 }
450 }
452 if (message_len >= cb->send_buf_free) {
453 status = wt_flush_nolock(0, cb);
454 if (status != 0) {
455 pthread_mutex_unlock(&cb->send_lock);
456 return status;
457 }
458 }
460 /* Assert that we have enough space for this message. */
461 assert(message_len < cb->send_buf_free);
463 /* `message_len + 1' because `message_len' does not include the
464 * trailing null byte. Neither does `send_buffer_fill'. */
465 memcpy(cb->send_buf + cb->send_buf_fill, message, message_len + 1);
466 cb->send_buf_fill += message_len;
467 cb->send_buf_free -= message_len;
469 DEBUG("write_tsdb plugin: [%s]:%s buf %zu/%zu (%.1f %%) \"%s\"", cb->node,
470 cb->service, cb->send_buf_fill, sizeof(cb->send_buf),
471 100.0 * ((double)cb->send_buf_fill) / ((double)sizeof(cb->send_buf)),
472 message);
474 pthread_mutex_unlock(&cb->send_lock);
476 return 0;
477 }
479 static int wt_write_messages(const data_set_t *ds, const value_list_t *vl,
480 struct wt_callback *cb) {
481 char key[10 * DATA_MAX_NAME_LEN];
482 char values[512];
484 int status;
486 if (0 != strcmp(ds->type, vl->type)) {
487 ERROR("write_tsdb plugin: DS type does not match "
488 "value list type");
489 return -1;
490 }
492 for (size_t i = 0; i < ds->ds_num; i++) {
493 const char *ds_name = NULL;
495 if (cb->always_append_ds || (ds->ds_num > 1))
496 ds_name = ds->ds[i].name;
498 /* Copy the identifier to 'key' and escape it. */
499 status = wt_format_name(key, sizeof(key), vl, cb, ds_name);
500 if (status != 0) {
501 ERROR("write_tsdb plugin: error with format_name");
502 return status;
503 }
505 escape_string(key, sizeof(key));
506 /* Convert the values to an ASCII representation and put that into
507 * 'values'. */
508 status =
509 wt_format_values(values, sizeof(values), i, ds, vl, cb->store_rates);
510 if (status != 0) {
511 ERROR("write_tsdb plugin: error with "
512 "wt_format_values");
513 return status;
514 }
516 /* Send the message to tsdb */
517 status = wt_send_message(key, values, vl->time, cb, vl->host, vl->meta);
518 if (status != 0) {
519 ERROR("write_tsdb plugin: error with "
520 "wt_send_message");
521 return status;
522 }
523 }
525 return 0;
526 }
528 static int wt_write(const data_set_t *ds, const value_list_t *vl,
529 user_data_t *user_data) {
530 struct wt_callback *cb;
531 int status;
533 if (user_data == NULL)
534 return EINVAL;
536 cb = user_data->data;
538 status = wt_write_messages(ds, vl, cb);
540 return status;
541 }
543 static int wt_config_tsd(oconfig_item_t *ci) {
544 struct wt_callback *cb;
545 char callback_name[DATA_MAX_NAME_LEN];
547 cb = calloc(1, sizeof(*cb));
548 if (cb == NULL) {
549 ERROR("write_tsdb plugin: calloc failed.");
550 return -1;
551 }
552 cb->sock_fd = -1;
554 pthread_mutex_init(&cb->send_lock, NULL);
556 for (int i = 0; i < ci->children_num; i++) {
557 oconfig_item_t *child = ci->children + i;
559 if (strcasecmp("Host", child->key) == 0)
560 cf_util_get_string(child, &cb->node);
561 else if (strcasecmp("Port", child->key) == 0)
562 cf_util_get_service(child, &cb->service);
563 else if (strcasecmp("HostTags", child->key) == 0)
564 cf_util_get_string(child, &cb->host_tags);
565 else if (strcasecmp("StoreRates", child->key) == 0)
566 cf_util_get_boolean(child, &cb->store_rates);
567 else if (strcasecmp("AlwaysAppendDS", child->key) == 0)
568 cf_util_get_boolean(child, &cb->always_append_ds);
569 else {
570 ERROR("write_tsdb plugin: Invalid configuration "
571 "option: %s.",
572 child->key);
573 }
574 }
576 ssnprintf(callback_name, sizeof(callback_name), "write_tsdb/%s/%s",
577 cb->node != NULL ? cb->node : WT_DEFAULT_NODE,
578 cb->service != NULL ? cb->service : WT_DEFAULT_SERVICE);
580 user_data_t user_data = {.data = cb, .free_func = wt_callback_free};
582 plugin_register_write(callback_name, wt_write, &user_data);
584 user_data.free_func = NULL;
585 plugin_register_flush(callback_name, wt_flush, &user_data);
587 return 0;
588 }
590 static int wt_config(oconfig_item_t *ci) {
591 for (int i = 0; i < ci->children_num; i++) {
592 oconfig_item_t *child = ci->children + i;
594 if (strcasecmp("Node", child->key) == 0)
595 wt_config_tsd(child);
596 else if (strcasecmp("DNS_Cache_TTL", child->key) == 0) {
597 int ttl;
598 cf_util_get_int(child, &ttl);
599 dnsttl = TIME_T_TO_CDTIME_T(ttl);
600 } else {
601 ERROR("write_tsdb plugin: Invalid configuration "
602 "option: %s.",
603 child->key);
604 }
605 }
607 return 0;
608 }
610 void module_register(void) {
611 plugin_register_complex_config("write_tsdb", wt_config);
612 }
614 /* vim: set sw=4 ts=4 sts=4 tw=78 et : */