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.
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.
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
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>
29 * Brett Hawn <bhawn at llnw.com>
30 * Kevin Bowling <kbowling@llnw.com>
33 /* write_tsdb plugin configuation example
39 * HostTags "status=production deviceclass=www"
47 #include "configfile.h"
49 #include "utils_cache.h"
53 #ifndef WT_DEFAULT_NODE
54 # define WT_DEFAULT_NODE "localhost"
57 #ifndef WT_DEFAULT_SERVICE
58 # define WT_DEFAULT_SERVICE "4242"
61 #ifndef WT_DEFAULT_ESCAPE
62 # define WT_DEFAULT_ESCAPE '.'
65 /* Ethernet - (IPv6 + TCP) = 1500 - (40 + 32) = 1428 */
66 #ifndef WT_SEND_BUF_SIZE
67 # define WT_SEND_BUF_SIZE 1428
82 _Bool always_append_ds;
84 char send_buf[WT_SEND_BUF_SIZE];
87 cdtime_t send_buf_init_time;
89 pthread_mutex_t send_lock;
96 static void wt_reset_buffer(struct wt_callback *cb)
98 memset(cb->send_buf, 0, sizeof(cb->send_buf));
99 cb->send_buf_free = sizeof(cb->send_buf);
100 cb->send_buf_fill = 0;
101 cb->send_buf_init_time = cdtime();
104 static int wt_send_buffer(struct wt_callback *cb)
108 status = swrite(cb->sock_fd, cb->send_buf, strlen(cb->send_buf));
112 ERROR("write_tsdb plugin: send failed with status %zi (%s)",
113 status, sstrerror (errno, errbuf, sizeof (errbuf)));
124 /* NOTE: You must hold cb->send_lock when calling this function! */
125 static int wt_flush_nolock(cdtime_t timeout, struct wt_callback *cb)
129 DEBUG("write_tsdb plugin: wt_flush_nolock: timeout = %.3f; "
130 "send_buf_fill = %zu;",
134 /* timeout == 0 => flush unconditionally */
140 if ((cb->send_buf_init_time + timeout) > now)
144 if (cb->send_buf_fill == 0)
146 cb->send_buf_init_time = cdtime();
150 status = wt_send_buffer(cb);
156 static int wt_callback_init(struct wt_callback *cb)
158 struct addrinfo *ai_list;
159 struct addrinfo *ai_ptr;
162 const char *node = cb->node ? cb->node : WT_DEFAULT_NODE;
163 const char *service = cb->service ? cb->service : WT_DEFAULT_SERVICE;
170 struct addrinfo ai_hints = {
171 .ai_family = AF_UNSPEC,
172 .ai_flags = AI_ADDRCONFIG,
173 .ai_socktype = SOCK_STREAM
176 status = getaddrinfo(node, service, &ai_hints, &ai_list);
179 ERROR("write_tsdb plugin: getaddrinfo (%s, %s) failed: %s",
180 node, service, gai_strerror (status));
184 assert (ai_list != NULL);
185 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
187 cb->sock_fd = socket(ai_ptr->ai_family, ai_ptr->ai_socktype,
188 ai_ptr->ai_protocol);
192 status = connect(cb->sock_fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
203 freeaddrinfo(ai_list);
208 ERROR("write_tsdb plugin: Connecting to %s:%s failed. "
209 "The last error was: %s", node, service,
210 sstrerror (errno, errbuf, sizeof(errbuf)));
219 static void wt_callback_free(void *data)
221 struct wt_callback *cb;
228 pthread_mutex_lock(&cb->send_lock);
230 wt_flush_nolock(0, cb);
237 sfree(cb->host_tags);
239 pthread_mutex_destroy(&cb->send_lock);
244 static int wt_flush(cdtime_t timeout,
245 const char *identifier __attribute__((unused)),
246 user_data_t *user_data)
248 struct wt_callback *cb;
251 if (user_data == NULL)
254 cb = user_data->data;
256 pthread_mutex_lock(&cb->send_lock);
260 status = wt_callback_init(cb);
263 ERROR("write_tsdb plugin: wt_callback_init failed.");
264 pthread_mutex_unlock(&cb->send_lock);
269 status = wt_flush_nolock(timeout, cb);
270 pthread_mutex_unlock(&cb->send_lock);
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,
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, \
296 else if (((size_t) status) >= (ret_len - offset)) \
302 offset += ((size_t) status); \
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)
310 rates = uc_get_rate (ds, vl);
313 WARNING("format_values: "
314 "uc_get_rate failed.");
317 BUFFER_ADD(GAUGE_FORMAT, rates[ds_num]);
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);
327 ERROR("format_values plugin: Unknown data source type: %i",
328 ds->ds[ds_num].type);
339 static int wt_format_name(char *ret, int ret_len,
340 const value_list_t *vl,
341 const struct wt_callback *cb,
346 const char *prefix = "";
347 const char *meta_prefix = "tsdb_prefix";
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) {
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,
367 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin,
368 vl->type, vl->type_instance, ds_name);
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);
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);
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,
386 ssnprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin,
387 vl->type_instance, vl->type);
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);
394 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin,
395 vl->plugin_instance, vl->type, vl->type_instance);
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)
411 const char *tags = "";
413 const char *host_tags = cb->host_tags ? cb->host_tags : "";
414 const char *meta_tsdb = "tsdb_tags";
416 /* skip if value is NaN */
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");
427 pthread_mutex_unlock(&cb->send_lock);
434 status = ssnprintf (message,
436 "put %s %.0f %s fqdn=%s %s %s\r\n",
438 CDTIME_T_TO_DOUBLE(time),
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);
454 pthread_mutex_lock(&cb->send_lock);
458 status = wt_callback_init(cb);
461 ERROR("write_tsdb plugin: wt_callback_init failed.");
462 pthread_mutex_unlock(&cb->send_lock);
467 if (message_len >= cb->send_buf_free)
469 status = wt_flush_nolock(0, cb);
472 pthread_mutex_unlock(&cb->send_lock);
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\"",
490 cb->send_buf_fill, sizeof(cb->send_buf),
491 100.0 * ((double) cb->send_buf_fill) /
492 ((double) sizeof(cb->send_buf)),
495 pthread_mutex_unlock(&cb->send_lock);
500 static int wt_write_messages(const data_set_t *ds, const value_list_t *vl,
501 struct wt_callback *cb)
503 char key[10*DATA_MAX_NAME_LEN];
509 if (0 != strcmp(ds->type, vl->type))
511 ERROR("write_tsdb plugin: DS type does not match "
516 for (i = 0; i < ds->ds_num; i++)
518 const char *ds_name = NULL;
520 if (cb->always_append_ds || (ds->ds_num > 1))
521 ds_name = ds->ds[i].name;
523 /* Copy the identifier to 'key' and escape it. */
524 status = wt_format_name(key, sizeof(key), vl, cb, ds_name);
527 ERROR("write_tsdb plugin: error with format_name");
531 escape_string(key, sizeof(key));
532 /* Convert the values to an ASCII representation and put that into
534 status = wt_format_values(values, sizeof(values), i, ds, vl,
538 ERROR("write_tsdb plugin: error with "
543 /* Send the message to tsdb */
544 status = wt_send_message(key, values, vl->time, cb, vl->host, vl->meta);
547 ERROR("write_tsdb plugin: error with "
556 static int wt_write(const data_set_t *ds, const value_list_t *vl,
557 user_data_t *user_data)
559 struct wt_callback *cb;
562 if (user_data == NULL)
565 cb = user_data->data;
567 status = wt_write_messages(ds, vl, cb);
572 static int wt_config_tsd(oconfig_item_t *ci)
574 struct wt_callback *cb;
575 user_data_t user_data = { 0 };
576 char callback_name[DATA_MAX_NAME_LEN];
579 cb = calloc(1, sizeof(*cb));
582 ERROR("write_tsdb plugin: calloc failed.");
588 cb->host_tags = NULL;
591 pthread_mutex_init (&cb->send_lock, NULL);
593 for (i = 0; i < ci->children_num; i++)
595 oconfig_item_t *child = ci->children + i;
597 if (strcasecmp("Host", child->key) == 0)
598 cf_util_get_string(child, &cb->node);
599 else if (strcasecmp("Port", child->key) == 0)
600 cf_util_get_service(child, &cb->service);
601 else if (strcasecmp("HostTags", child->key) == 0)
602 cf_util_get_string(child, &cb->host_tags);
603 else if (strcasecmp("StoreRates", child->key) == 0)
604 cf_util_get_boolean(child, &cb->store_rates);
605 else if (strcasecmp("AlwaysAppendDS", child->key) == 0)
606 cf_util_get_boolean(child, &cb->always_append_ds);
609 ERROR("write_tsdb plugin: Invalid configuration "
610 "option: %s.", child->key);
614 ssnprintf(callback_name, sizeof(callback_name), "write_tsdb/%s/%s",
615 cb->node != NULL ? cb->node : WT_DEFAULT_NODE,
616 cb->service != NULL ? cb->service : WT_DEFAULT_SERVICE);
619 user_data.free_func = wt_callback_free;
620 plugin_register_write(callback_name, wt_write, &user_data);
622 user_data.free_func = NULL;
623 plugin_register_flush(callback_name, wt_flush, &user_data);
628 static int wt_config(oconfig_item_t *ci)
632 for (i = 0; i < ci->children_num; i++)
634 oconfig_item_t *child = ci->children + i;
636 if (strcasecmp("Node", child->key) == 0)
637 wt_config_tsd(child);
640 ERROR("write_tsdb plugin: Invalid configuration "
641 "option: %s.", child->key);
648 void module_register(void)
650 plugin_register_complex_config("write_tsdb", wt_config);
653 /* vim: set sw=4 ts=4 sts=4 tw=78 et : */