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"
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;
161 const char *node = cb->node ? cb->node : WT_DEFAULT_NODE;
162 const char *service = cb->service ? cb->service : WT_DEFAULT_SERVICE;
167 struct addrinfo ai_hints = {
168 .ai_family = AF_UNSPEC,
169 .ai_flags = AI_ADDRCONFIG,
170 .ai_socktype = SOCK_STREAM
173 status = getaddrinfo(node, service, &ai_hints, &ai_list);
176 ERROR("write_tsdb plugin: getaddrinfo (%s, %s) failed: %s",
177 node, service, gai_strerror (status));
181 assert (ai_list != NULL);
182 for (struct addrinfo *ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
184 cb->sock_fd = socket(ai_ptr->ai_family, ai_ptr->ai_socktype,
185 ai_ptr->ai_protocol);
189 set_sock_opts(cb->sock_fd);
191 status = connect(cb->sock_fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
202 freeaddrinfo(ai_list);
207 ERROR("write_tsdb plugin: Connecting to %s:%s failed. "
208 "The last error was: %s", node, service,
209 sstrerror (errno, errbuf, sizeof(errbuf)));
218 static void wt_callback_free(void *data)
220 struct wt_callback *cb;
227 pthread_mutex_lock(&cb->send_lock);
229 wt_flush_nolock(0, cb);
236 sfree(cb->host_tags);
238 pthread_mutex_destroy(&cb->send_lock);
243 static int wt_flush(cdtime_t timeout,
244 const char *identifier __attribute__((unused)),
245 user_data_t *user_data)
247 struct wt_callback *cb;
250 if (user_data == NULL)
253 cb = user_data->data;
255 pthread_mutex_lock(&cb->send_lock);
259 status = wt_callback_init(cb);
262 ERROR("write_tsdb plugin: wt_callback_init failed.");
263 pthread_mutex_unlock(&cb->send_lock);
268 status = wt_flush_nolock(timeout, cb);
269 pthread_mutex_unlock(&cb->send_lock);
274 static int wt_format_values(char *ret, size_t ret_len,
275 int ds_num, const data_set_t *ds,
276 const value_list_t *vl,
281 gauge_t *rates = NULL;
283 assert(0 == strcmp (ds->type, vl->type));
285 memset(ret, 0, ret_len);
287 #define BUFFER_ADD(...) do { \
288 status = ssnprintf (ret + offset, ret_len - offset, \
295 else if (((size_t) status) >= (ret_len - offset)) \
301 offset += ((size_t) status); \
304 if (ds->ds[ds_num].type == DS_TYPE_GAUGE)
305 BUFFER_ADD(GAUGE_FORMAT, vl->values[ds_num].gauge);
306 else if (store_rates)
309 rates = uc_get_rate (ds, vl);
312 WARNING("format_values: "
313 "uc_get_rate failed.");
316 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);
326 ERROR("format_values plugin: Unknown data source type: %i",
327 ds->ds[ds_num].type);
338 static int wt_format_name(char *ret, int ret_len,
339 const value_list_t *vl,
340 const struct wt_callback *cb,
345 const char *prefix = "";
346 const char *meta_prefix = "tsdb_prefix";
349 status = meta_data_get_string(vl->meta, meta_prefix, &temp);
350 if (status == -ENOENT) {
351 /* defaults to empty string */
352 } else if (status < 0) {
360 if (ds_name != NULL) {
361 if (vl->plugin_instance[0] == '\0') {
362 if (vl->type_instance[0] == '\0') {
363 ssnprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin,
366 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin,
367 vl->type, vl->type_instance, ds_name);
369 } else { /* vl->plugin_instance != "" */
370 if (vl->type_instance[0] == '\0') {
371 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin,
372 vl->plugin_instance, vl->type, ds_name);
374 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s.%s", prefix,
375 vl->plugin, vl->plugin_instance, vl->type,
376 vl->type_instance, ds_name);
379 } else { /* ds_name == NULL */
380 if (vl->plugin_instance[0] == '\0') {
381 if (vl->type_instance[0] == '\0') {
382 ssnprintf(ret, ret_len, "%s%s.%s", prefix, vl->plugin,
385 ssnprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin,
386 vl->type_instance, vl->type);
388 } else { /* vl->plugin_instance != "" */
389 if (vl->type_instance[0] == '\0') {
390 ssnprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin,
391 vl->plugin_instance, vl->type);
393 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin,
394 vl->plugin_instance, vl->type, vl->type_instance);
403 static int wt_send_message (const char* key, const char* value,
404 cdtime_t time, struct wt_callback *cb,
405 const char* host, meta_data_t *md)
410 const char *tags = "";
412 const char *host_tags = cb->host_tags ? cb->host_tags : "";
413 const char *meta_tsdb = "tsdb_tags";
415 /* skip if value is NaN */
420 status = meta_data_get_string(md, meta_tsdb, &temp);
421 if (status == -ENOENT) {
422 /* defaults to empty string */
423 } else if (status < 0) {
424 ERROR("write_tsdb plugin: tags metadata get failure");
426 pthread_mutex_unlock(&cb->send_lock);
433 status = ssnprintf (message,
435 "put %s %.0f %s fqdn=%s %s %s\r\n",
437 CDTIME_T_TO_DOUBLE(time),
445 message_len = (size_t) status;
447 if (message_len >= sizeof(message)) {
448 ERROR("write_tsdb plugin: message buffer too small: "
449 "Need %zu bytes.", message_len + 1);
453 pthread_mutex_lock(&cb->send_lock);
457 status = wt_callback_init(cb);
460 ERROR("write_tsdb plugin: wt_callback_init failed.");
461 pthread_mutex_unlock(&cb->send_lock);
466 if (message_len >= cb->send_buf_free)
468 status = wt_flush_nolock(0, cb);
471 pthread_mutex_unlock(&cb->send_lock);
476 /* Assert that we have enough space for this message. */
477 assert(message_len < cb->send_buf_free);
479 /* `message_len + 1' because `message_len' does not include the
480 * trailing null byte. Neither does `send_buffer_fill'. */
481 memcpy(cb->send_buf + cb->send_buf_fill,
482 message, message_len + 1);
483 cb->send_buf_fill += message_len;
484 cb->send_buf_free -= message_len;
486 DEBUG("write_tsdb plugin: [%s]:%s buf %zu/%zu (%.1f %%) \"%s\"",
489 cb->send_buf_fill, sizeof(cb->send_buf),
490 100.0 * ((double) cb->send_buf_fill) /
491 ((double) sizeof(cb->send_buf)),
494 pthread_mutex_unlock(&cb->send_lock);
499 static int wt_write_messages(const data_set_t *ds, const value_list_t *vl,
500 struct wt_callback *cb)
502 char key[10*DATA_MAX_NAME_LEN];
507 if (0 != strcmp(ds->type, vl->type))
509 ERROR("write_tsdb plugin: DS type does not match "
514 for (size_t i = 0; i < ds->ds_num; i++)
516 const char *ds_name = NULL;
518 if (cb->always_append_ds || (ds->ds_num > 1))
519 ds_name = ds->ds[i].name;
521 /* Copy the identifier to 'key' and escape it. */
522 status = wt_format_name(key, sizeof(key), vl, cb, ds_name);
525 ERROR("write_tsdb plugin: error with format_name");
529 escape_string(key, sizeof(key));
530 /* Convert the values to an ASCII representation and put that into
532 status = wt_format_values(values, sizeof(values), i, ds, vl,
536 ERROR("write_tsdb plugin: error with "
541 /* Send the message to tsdb */
542 status = wt_send_message(key, values, vl->time, cb, vl->host, vl->meta);
545 ERROR("write_tsdb plugin: error with "
554 static int wt_write(const data_set_t *ds, const value_list_t *vl,
555 user_data_t *user_data)
557 struct wt_callback *cb;
560 if (user_data == NULL)
563 cb = user_data->data;
565 status = wt_write_messages(ds, vl, cb);
570 static int wt_config_tsd(oconfig_item_t *ci)
572 struct wt_callback *cb;
573 char callback_name[DATA_MAX_NAME_LEN];
575 cb = calloc(1, sizeof(*cb));
578 ERROR("write_tsdb plugin: calloc failed.");
584 cb->host_tags = NULL;
587 pthread_mutex_init (&cb->send_lock, NULL);
589 for (int i = 0; i < ci->children_num; i++)
591 oconfig_item_t *child = ci->children + i;
593 if (strcasecmp("Host", child->key) == 0)
594 cf_util_get_string(child, &cb->node);
595 else if (strcasecmp("Port", child->key) == 0)
596 cf_util_get_service(child, &cb->service);
597 else if (strcasecmp("HostTags", child->key) == 0)
598 cf_util_get_string(child, &cb->host_tags);
599 else if (strcasecmp("StoreRates", child->key) == 0)
600 cf_util_get_boolean(child, &cb->store_rates);
601 else if (strcasecmp("AlwaysAppendDS", child->key) == 0)
602 cf_util_get_boolean(child, &cb->always_append_ds);
605 ERROR("write_tsdb plugin: Invalid configuration "
606 "option: %s.", child->key);
610 ssnprintf(callback_name, sizeof(callback_name), "write_tsdb/%s/%s",
611 cb->node != NULL ? cb->node : WT_DEFAULT_NODE,
612 cb->service != NULL ? cb->service : WT_DEFAULT_SERVICE);
614 user_data_t user_data = {
616 .free_func = wt_callback_free
619 plugin_register_write(callback_name, wt_write, &user_data);
621 user_data.free_func = NULL;
622 plugin_register_flush(callback_name, wt_flush, &user_data);
627 static int wt_config(oconfig_item_t *ci)
629 for (int i = 0; i < ci->children_num; i++)
631 oconfig_item_t *child = ci->children + i;
633 if (strcasecmp("Node", child->key) == 0)
634 wt_config_tsd(child);
637 ERROR("write_tsdb plugin: Invalid configuration "
638 "option: %s.", child->key);
645 void module_register(void)
647 plugin_register_complex_config("write_tsdb", wt_config);
650 /* vim: set sw=4 ts=4 sts=4 tw=78 et : */