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"
54 #ifndef WT_DEFAULT_NODE
55 # define WT_DEFAULT_NODE "localhost"
58 #ifndef WT_DEFAULT_SERVICE
59 # define WT_DEFAULT_SERVICE "4242"
62 #ifndef WT_DEFAULT_ESCAPE
63 # define WT_DEFAULT_ESCAPE '.'
66 /* Ethernet - (IPv6 + TCP) = 1500 - (40 + 32) = 1428 */
67 #ifndef WT_SEND_BUF_SIZE
68 # define WT_SEND_BUF_SIZE 1428
83 _Bool always_append_ds;
85 char send_buf[WT_SEND_BUF_SIZE];
88 cdtime_t send_buf_init_time;
90 pthread_mutex_t send_lock;
97 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();
105 static int wt_send_buffer(struct wt_callback *cb)
109 status = swrite(cb->sock_fd, cb->send_buf, strlen(cb->send_buf));
113 ERROR("write_tsdb plugin: send failed with status %zi (%s)",
114 status, sstrerror (errno, errbuf, sizeof (errbuf)));
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)
130 DEBUG("write_tsdb plugin: wt_flush_nolock: timeout = %.3f; "
131 "send_buf_fill = %zu;",
135 /* timeout == 0 => flush unconditionally */
141 if ((cb->send_buf_init_time + timeout) > now)
145 if (cb->send_buf_fill <= 0)
147 cb->send_buf_init_time = cdtime();
151 status = wt_send_buffer(cb);
157 static int wt_callback_init(struct wt_callback *cb)
159 struct addrinfo ai_hints;
160 struct addrinfo *ai_list;
161 struct addrinfo *ai_ptr;
164 const char *node = cb->node ? cb->node : WT_DEFAULT_NODE;
165 const char *service = cb->service ? cb->service : WT_DEFAULT_SERVICE;
170 memset(&ai_hints, 0, sizeof(ai_hints));
172 ai_hints.ai_flags |= AI_ADDRCONFIG;
174 ai_hints.ai_family = AF_UNSPEC;
175 ai_hints.ai_socktype = SOCK_STREAM;
179 status = getaddrinfo(node, service, &ai_hints, &ai_list);
182 ERROR("write_tsdb plugin: getaddrinfo (%s, %s) failed: %s",
183 node, service, gai_strerror (status));
187 assert (ai_list != NULL);
188 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
190 cb->sock_fd = socket(ai_ptr->ai_family, ai_ptr->ai_socktype,
191 ai_ptr->ai_protocol);
195 status = connect(cb->sock_fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
206 freeaddrinfo(ai_list);
211 ERROR("write_tsdb plugin: Connecting to %s:%s failed. "
212 "The last error was: %s", node, service,
213 sstrerror (errno, errbuf, sizeof(errbuf)));
222 static void wt_callback_free(void *data)
224 struct wt_callback *cb;
231 pthread_mutex_lock(&cb->send_lock);
233 wt_flush_nolock(0, cb);
240 sfree(cb->host_tags);
242 pthread_mutex_destroy(&cb->send_lock);
247 static int wt_flush(cdtime_t timeout,
248 const char *identifier __attribute__((unused)),
249 user_data_t *user_data)
251 struct wt_callback *cb;
254 if (user_data == NULL)
257 cb = user_data->data;
259 pthread_mutex_lock(&cb->send_lock);
263 status = wt_callback_init(cb);
266 ERROR("write_tsdb plugin: wt_callback_init failed.");
267 pthread_mutex_unlock(&cb->send_lock);
272 status = wt_flush_nolock(timeout, cb);
273 pthread_mutex_unlock(&cb->send_lock);
278 static int wt_format_values(char *ret, size_t ret_len,
279 int ds_num, const data_set_t *ds,
280 const value_list_t *vl,
285 gauge_t *rates = NULL;
287 assert(0 == strcmp (ds->type, vl->type));
289 memset(ret, 0, ret_len);
291 #define BUFFER_ADD(...) do { \
292 status = ssnprintf (ret + offset, ret_len - offset, \
299 else if (((size_t) status) >= (ret_len - offset)) \
305 offset += ((size_t) status); \
308 if (ds->ds[ds_num].type == DS_TYPE_GAUGE)
309 BUFFER_ADD(GAUGE_FORMAT, vl->values[ds_num].gauge);
310 else if (store_rates)
313 rates = uc_get_rate (ds, vl);
316 WARNING("format_values: "
317 "uc_get_rate failed.");
320 BUFFER_ADD(GAUGE_FORMAT, rates[ds_num]);
322 else if (ds->ds[ds_num].type == DS_TYPE_COUNTER)
323 BUFFER_ADD("%llu", vl->values[ds_num].counter);
324 else if (ds->ds[ds_num].type == DS_TYPE_DERIVE)
325 BUFFER_ADD("%" PRIi64, vl->values[ds_num].derive);
326 else if (ds->ds[ds_num].type == DS_TYPE_ABSOLUTE)
327 BUFFER_ADD("%" PRIu64, vl->values[ds_num].absolute);
330 ERROR("format_values plugin: Unknown data source type: %i",
331 ds->ds[ds_num].type);
342 static int wt_format_name(char *ret, int ret_len,
343 const value_list_t *vl,
344 const struct wt_callback *cb,
349 const char *prefix = "";
350 const char *meta_prefix = "tsdb_prefix";
353 status = meta_data_get_string(vl->meta, meta_prefix, &temp);
354 if (status == -ENOENT) {
355 /* defaults to empty string */
356 } else if (status < 0) {
364 if (ds_name != NULL) {
365 if (vl->plugin_instance[0] == '\0') {
366 if (vl->type_instance[0] == '\0') {
367 ssnprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin,
370 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin,
371 vl->type, vl->type_instance, ds_name);
373 } else { /* vl->plugin_instance != "" */
374 if (vl->type_instance[0] == '\0') {
375 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin,
376 vl->plugin_instance, vl->type, ds_name);
378 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s.%s", prefix,
379 vl->plugin, vl->plugin_instance, vl->type,
380 vl->type_instance, ds_name);
383 } else { /* ds_name == NULL */
384 if (vl->plugin_instance[0] == '\0') {
385 if (vl->type_instance[0] == '\0') {
386 ssnprintf(ret, ret_len, "%s%s.%s", prefix, vl->plugin,
389 ssnprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin,
390 vl->type_instance, vl->type);
392 } else { /* vl->plugin_instance != "" */
393 if (vl->type_instance[0] == '\0') {
394 ssnprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin,
395 vl->plugin_instance, vl->type);
397 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin,
398 vl->plugin_instance, vl->type, vl->type_instance);
407 static int wt_send_message (const char* key, const char* value,
408 cdtime_t time, struct wt_callback *cb,
409 const char* host, meta_data_t *md)
414 const char *tags = "";
416 const char *host_tags = cb->host_tags ? cb->host_tags : "";
417 const char *meta_tsdb = "tsdb_tags";
419 /* skip if value is NaN */
424 status = meta_data_get_string(md, meta_tsdb, &temp);
425 if (status == -ENOENT) {
426 /* defaults to empty string */
427 } else if (status < 0) {
428 ERROR("write_tsdb plugin: tags metadata get failure");
430 pthread_mutex_unlock(&cb->send_lock);
437 status = ssnprintf (message,
439 "put %s %.0f %s fqdn=%s %s %s\r\n",
441 CDTIME_T_TO_DOUBLE(time),
449 message_len = (size_t) status;
451 if (message_len >= sizeof(message)) {
452 ERROR("write_tsdb plugin: message buffer too small: "
453 "Need %zu bytes.", message_len + 1);
457 pthread_mutex_lock(&cb->send_lock);
461 status = wt_callback_init(cb);
464 ERROR("write_tsdb plugin: wt_callback_init failed.");
465 pthread_mutex_unlock(&cb->send_lock);
470 if (message_len >= cb->send_buf_free)
472 status = wt_flush_nolock(0, cb);
475 pthread_mutex_unlock(&cb->send_lock);
480 /* Assert that we have enough space for this message. */
481 assert(message_len < cb->send_buf_free);
483 /* `message_len + 1' because `message_len' does not include the
484 * trailing null byte. Neither does `send_buffer_fill'. */
485 memcpy(cb->send_buf + cb->send_buf_fill,
486 message, message_len + 1);
487 cb->send_buf_fill += message_len;
488 cb->send_buf_free -= message_len;
490 DEBUG("write_tsdb plugin: [%s]:%s buf %zu/%zu (%.1f %%) \"%s\"",
493 cb->send_buf_fill, sizeof(cb->send_buf),
494 100.0 * ((double) cb->send_buf_fill) /
495 ((double) sizeof(cb->send_buf)),
498 pthread_mutex_unlock(&cb->send_lock);
503 static int wt_write_messages(const data_set_t *ds, const value_list_t *vl,
504 struct wt_callback *cb)
506 char key[10*DATA_MAX_NAME_LEN];
512 if (0 != strcmp(ds->type, vl->type))
514 ERROR("write_tsdb plugin: DS type does not match "
519 for (i = 0; i < ds->ds_num; i++)
521 const char *ds_name = NULL;
523 if (cb->always_append_ds || (ds->ds_num > 1))
524 ds_name = ds->ds[i].name;
526 /* Copy the identifier to 'key' and escape it. */
527 status = wt_format_name(key, sizeof(key), vl, cb, ds_name);
530 ERROR("write_tsdb plugin: error with format_name");
534 escape_string(key, sizeof(key));
535 /* Convert the values to an ASCII representation and put that into
537 status = wt_format_values(values, sizeof(values), i, ds, vl,
541 ERROR("write_tsdb plugin: error with "
546 /* Send the message to tsdb */
547 status = wt_send_message(key, values, vl->time, cb, vl->host, vl->meta);
550 ERROR("write_tsdb plugin: error with "
559 static int wt_write(const data_set_t *ds, const value_list_t *vl,
560 user_data_t *user_data)
562 struct wt_callback *cb;
565 if (user_data == NULL)
568 cb = user_data->data;
570 status = wt_write_messages(ds, vl, cb);
575 static int wt_config_tsd(oconfig_item_t *ci)
577 struct wt_callback *cb;
578 user_data_t user_data;
579 char callback_name[DATA_MAX_NAME_LEN];
582 cb = calloc(1, sizeof(*cb));
585 ERROR("write_tsdb plugin: calloc failed.");
591 cb->host_tags = NULL;
594 pthread_mutex_init (&cb->send_lock, NULL);
596 for (i = 0; i < ci->children_num; i++)
598 oconfig_item_t *child = ci->children + i;
600 if (strcasecmp("Host", child->key) == 0)
601 cf_util_get_string(child, &cb->node);
602 else if (strcasecmp("Port", child->key) == 0)
603 cf_util_get_service(child, &cb->service);
604 else if (strcasecmp("HostTags", child->key) == 0)
605 cf_util_get_string(child, &cb->host_tags);
606 else if (strcasecmp("StoreRates", child->key) == 0)
607 cf_util_get_boolean(child, &cb->store_rates);
608 else if (strcasecmp("AlwaysAppendDS", child->key) == 0)
609 cf_util_get_boolean(child, &cb->always_append_ds);
612 ERROR("write_tsdb plugin: Invalid configuration "
613 "option: %s.", child->key);
617 ssnprintf(callback_name, sizeof(callback_name), "write_tsdb/%s/%s",
618 cb->node != NULL ? cb->node : WT_DEFAULT_NODE,
619 cb->service != NULL ? cb->service : WT_DEFAULT_SERVICE);
621 memset(&user_data, 0, sizeof(user_data));
623 user_data.free_func = wt_callback_free;
624 plugin_register_write(callback_name, wt_write, &user_data);
626 user_data.free_func = NULL;
627 plugin_register_flush(callback_name, wt_flush, &user_data);
632 static int wt_config(oconfig_item_t *ci)
636 for (i = 0; i < ci->children_num; i++)
638 oconfig_item_t *child = ci->children + i;
640 if (strcasecmp("Node", child->key) == 0)
641 wt_config_tsd(child);
644 ERROR("write_tsdb plugin: Invalid configuration "
645 "option: %s.", child->key);
652 void module_register(void)
654 plugin_register_complex_config("write_tsdb", wt_config);
657 /* vim: set sw=4 ts=4 sts=4 tw=78 et : */